Package org.projectnessie.client.api
Interface GetReferenceBuilder
-
- All Known Implementing Classes:
BaseGetReferenceBuilder
public interface GetReferenceBuilderRequest builder for "get reference".- Since:
NessieApiV1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetReferenceBuilderfetch(org.projectnessie.api.params.FetchOption fetchOption)Will fetch additional metadata aboutBranchinstances, such as number of commits ahead/behind or the common ancestor in relation to the default branch, and the commit metadata for the HEAD commit.org.projectnessie.model.Referenceget()GetReferenceBuilderrefName(@NotNull @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, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") java.lang.String refName)
-
-
-
Method Detail
-
refName
GetReferenceBuilder refName(@NotNull @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, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") @NotNull @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, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") java.lang.String refName)
-
fetch
GetReferenceBuilder fetch(org.projectnessie.api.params.FetchOption fetchOption)
Will fetch additional metadata aboutBranchinstances, such as number of commits ahead/behind or the common ancestor in relation to the default branch, and the commit metadata for the HEAD commit.- Parameters:
fetchOption- The option indicating how much info to fetch- Returns:
GetReferenceBuilder
-
get
org.projectnessie.model.Reference get() throws org.projectnessie.error.NessieNotFoundException- Throws:
org.projectnessie.error.NessieNotFoundException
-
-