Package org.projectnessie.versioned
Interface GetNamedRefsParams
-
@Immutable public interface GetNamedRefsParamsParameters that control the values that shall be returned via for eachReferenceInfovia functionality to retrieve the named references.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceGetNamedRefsParams.RetrieveOptions
-
Field Summary
Fields Modifier and Type Field Description static GetNamedRefsParamsDEFAULT
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static org.projectnessie.versioned.ImmutableGetNamedRefsParams.Builderbuilder()NamedRefgetBaseReference()Named reference to use as the base for the computation ofReferenceInfo.getAheadBehind().default GetNamedRefsParams.RetrieveOptionsgetBranchRetrieveOptions()Whether to retrieve branches, defaults totrue.default GetNamedRefsParams.RetrieveOptionsgetTagRetrieveOptions()Whether to retrieve tags, defaults totrue.
-
-
-
Field Detail
-
DEFAULT
static final GetNamedRefsParams DEFAULT
-
-
Method Detail
-
builder
static org.projectnessie.versioned.ImmutableGetNamedRefsParams.Builder builder()
-
getBaseReference
@Nullable @Nullable NamedRef getBaseReference()
Named reference to use as the base for the computation ofReferenceInfo.getAheadBehind(). If this parameter is notnull, the given reference must exist.- Returns:
- name of the base reference. Can be
null, if not needed.
-
getBranchRetrieveOptions
@Default default GetNamedRefsParams.RetrieveOptions getBranchRetrieveOptions()
Whether to retrieve branches, defaults totrue.
-
getTagRetrieveOptions
@Default default GetNamedRefsParams.RetrieveOptions getTagRetrieveOptions()
Whether to retrieve tags, defaults totrue.
-
-