Package org.projectnessie.api

Interface ContentsApi

All Known Subinterfaces:

HttpContentsApi

public interface ContentsApi

Method Summary

Modifier and Type	Method	Description
Contents	getContents(@Valid ContentsKey key, @Valid @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String ref, @Valid @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") String hashOnRef)	This operation returns the Contents for a ContentsKey in a named-reference (a Branch or Tag).
MultiGetContentsResponse	getMultipleContents(@Valid @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String ref, @Valid @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") String hashOnRef, @Valid @NotNull MultiGetContentsRequest request)	Similar to 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

Contents getContents(@Valid
                     @Valid ContentsKey key,
                     @Valid @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..")
                     @Valid @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String ref,
                     @Valid @Nullable @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes")
                     @Valid @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") String hashOnRef)
              throws NessieNotFoundException

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).

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

MultiGetContentsResponse getMultipleContents(@Valid @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..")
                                             @Valid @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String ref,
                                             @Valid @Nullable @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes")
                                             @Valid @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") String hashOnRef,
                                             @Valid @NotNull
                                             @Valid @NotNull MultiGetContentsRequest request)
                                      throws NessieNotFoundException

Similar to 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).

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