Package org.projectnessie.api.v1.http

Interface HttpContentApi

All Superinterfaces:

ContentApi

@Consumes("application/json")
@Path("contents")
public interface HttpContentApi
extends ContentApi

Method Summary

Modifier and Type	Method	Description
Content	getContent(ContentKey key, java.lang.String ref, java.lang.String hashOnRef)	This operation returns the Content for a ContentKey in a named-reference (a Branch or Tag).
GetMultipleContentsResponse	getMultipleContents(java.lang.String ref, java.lang.String hashOnRef, GetMultipleContentsRequest request)	Similar to ContentApi.getContent(ContentKey, String, String), but takes multiple ContentKeys and returns the Content for the one or more ContentKeys in a named-reference (a Branch or Tag).

Method Detail

getContent

@GET
@Produces("application/json")
@Path("{key}")
Content getContent(@PathParam("key")
                   ContentKey key,
                   @QueryParam("ref")
                   java.lang.String ref,
                   @QueryParam("hashOnRef")
                   java.lang.String hashOnRef)
            throws NessieNotFoundException

Description copied from interface: ContentApi

This operation returns the Content for a ContentKey in a named-reference (a Branch or Tag).

If the table-metadata is tracked globally (Iceberg), Nessie returns a Content object, that contains the most up-to-date part for the globally tracked part (Iceberg: table-metadata) plus the per-Nessie-reference/hash specific part (Iceberg: snapshot-ID, schema-ID, partition-spec-ID, default-sort-order-ID).

Specified by:

getContent in interface ContentApi

Parameters:

key - the ContentKeys to retrieve

ref - named-reference to retrieve the content for

hashOnRef - hash on ref to retrieve the content for, translates to HEAD, if missing/null

Returns:

list of GetMultipleContentsResponse.ContentWithKeys

Throws:

NessieNotFoundException - if ref or hashOnRef does not exist

getMultipleContents

@POST
@Produces("application/json")
@Consumes("application/json")
GetMultipleContentsResponse getMultipleContents(@QueryParam("ref")
                                                java.lang.String ref,
                                                @QueryParam("hashOnRef")
                                                java.lang.String hashOnRef,
                                                GetMultipleContentsRequest request)
                                         throws NessieNotFoundException

Description copied from interface: ContentApi

Similar to ContentApi.getContent(ContentKey, String, String), but takes multiple ContentKeys and returns the Content for the one or more ContentKeys in a named-reference (a Branch or Tag).

If the table-metadata is tracked globally (Iceberg), Nessie returns a Content object, that contains the most up-to-date part for the globally tracked part (Iceberg: table-metadata) plus the per-Nessie-reference/hash specific part (Iceberg: snapshot-id, schema-id, partition-spec-id, default-sort-order-id).

Specified by:

getMultipleContents in interface ContentApi

Parameters:

ref - named-reference to retrieve the content for

hashOnRef - hash on ref to retrieve the content for, translates to HEAD, if missing/null

request - the ContentKeys to retrieve

Returns:

list of GetMultipleContentsResponse.ContentWithKeys

Throws:

NessieNotFoundException - if ref or hashOnRef does not exist