Package org.projectnessie.api.http

Interface HttpContentsApi

All Superinterfaces:

ContentsApi

@Consumes("application/json")
@Path("contents")
public interface HttpContentsApi
extends ContentsApi

Method Summary

Modifier and Type	Method	Description
Contents	getContents(ContentsKey key, String ref, String hashOnRef)	This operation returns the Contents for a ContentsKey in a named-reference (a Branch or Tag).
MultiGetContentsResponse	getMultipleContents(String ref, String hashOnRef, MultiGetContentsRequest request)	Similar to ContentsApi.getContents(ContentsKey, String, String), but takes multiple ContentsKeys and returns the Contents for the one or more ContentsKeys in a named-reference (a Branch or Tag).

Method Detail

getContents

@GET
@Produces("application/json")
@Path("{key}")
Contents getContents(@PathParam("key")
                     ContentsKey key,
                     @QueryParam("ref")
                     String ref,
                     @QueryParam("hashOnRef")
                     String hashOnRef)
              throws NessieNotFoundException

Description copied from interface: ContentsApi

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

If the table-metadata is tracked globally (Iceberg), Nessie returns a Contents 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).

Specified by:

getContents in interface ContentsApi

Parameters:

key - the ContentsKeys to retrieve

ref - named-reference to retrieve the contents for

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

Returns:

list of MultiGetContentsResponse.ContentsWithKeys

Throws:

NessieNotFoundException - if ref or hashOnRef does not exist

getMultipleContents

@POST
@Consumes("application/json")
MultiGetContentsResponse getMultipleContents(@QueryParam("ref")
                                             String ref,
                                             @QueryParam("hashOnRef")
                                             String hashOnRef,
                                             MultiGetContentsRequest request)
                                      throws NessieNotFoundException

Description copied from interface: ContentsApi

Similar to ContentsApi.getContents(ContentsKey, String, String), but takes multiple ContentsKeys and returns the Contents for the one or more ContentsKeys in a named-reference (a Branch or Tag).

If the table-metadata is tracked globally (Iceberg), Nessie returns a Contents 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).

Specified by:

getMultipleContents in interface ContentsApi

Parameters:

ref - named-reference to retrieve the contents for

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

request - the ContentsKeys to retrieve

Returns:

list of MultiGetContentsResponse.ContentsWithKeys

Throws:

NessieNotFoundException - if ref or hashOnRef does not exist