Package org.projectnessie.api

Interface ContentApi

All Known Subinterfaces:

HttpContentApi

public interface ContentApi

Method Summary

Modifier and Type	Method	Description
Content	getContent(@Valid ContentKey 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 Content for a ContentKey in a named-reference (a Branch or Tag).
GetMultipleContentsResponse	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 GetMultipleContentsRequest request)	Similar to 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

Content getContent(@Valid
                   @Valid ContentKey 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 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).

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

GetMultipleContentsResponse 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 GetMultipleContentsRequest request)
                                         throws NessieNotFoundException

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

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