Package org.projectnessie.api.http
Interface HttpContentsApi
-
- All Superinterfaces:
ContentsApi
@Consumes("application/json") @Path("contents") public interface HttpContentsApi extends ContentsApi
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ContentsgetContents(ContentsKey key, String ref, String hashOnRef)MultiGetContentsResponsegetMultipleContents(String ref, String hashOnRef, MultiGetContentsRequest request)Similar toContentsApi.getContents(ContentsKey, String, String), but takes multipleContentsKeys and returns theContentsfor the one or moreContentsKeys in a named-reference (aBranchorTag).
-
-
-
Method Detail
-
getContents
@GET @Produces("application/json") @Path("{key}") Contents getContents(@PathParam("key") ContentsKey key, @QueryParam("ref") String ref, @QueryParam("hashOnRef") String hashOnRef) throws NessieNotFoundExceptionDescription copied from interface:ContentsApiThis operation returns theContentsfor aContentsKeyin a named-reference (aBranchorTag).If the table-metadata is tracked globally (Iceberg), Nessie returns a
Contentsobject, 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:
getContentsin interfaceContentsApi- Parameters:
key- theContentsKeys to retrieveref- named-reference to retrieve the contents forhashOnRef- hash onrefto retrieve the contents for, translates toHEAD, if missing/null- Returns:
- list of
MultiGetContentsResponse.ContentsWithKeys - Throws:
NessieNotFoundException- ifreforhashOnRefdoes not exist
-
getMultipleContents
@POST @Consumes("application/json") MultiGetContentsResponse getMultipleContents(@QueryParam("ref") String ref, @QueryParam("hashOnRef") String hashOnRef, MultiGetContentsRequest request) throws NessieNotFoundExceptionDescription copied from interface:ContentsApiSimilar toContentsApi.getContents(ContentsKey, String, String), but takes multipleContentsKeys and returns theContentsfor the one or moreContentsKeys in a named-reference (aBranchorTag).If the table-metadata is tracked globally (Iceberg), Nessie returns a
Contentsobject, 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:
getMultipleContentsin interfaceContentsApi- Parameters:
ref- named-reference to retrieve the contents forhashOnRef- hash onrefto retrieve the contents for, translates toHEAD, if missing/nullrequest- theContentsKeys to retrieve- Returns:
- list of
MultiGetContentsResponse.ContentsWithKeys - Throws:
NessieNotFoundException- ifreforhashOnRefdoes not exist
-
-