Package org.projectnessie.versioned

Interface GetNamedRefsParams

@Immutable
public interface GetNamedRefsParams

Parameters that control the values that shall be returned via for each ReferenceInfo via functionality to retrieve the named references.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GetNamedRefsParams.RetrieveOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final GetNamedRefsParams	DEFAULT

Method Summary

Modifier and Type	Method	Description
static org.projectnessie.versioned.ImmutableGetNamedRefsParams.Builder	builder()
NamedRef	getBaseReference()	Named reference to use as the base for the computation of ReferenceInfo.getAheadBehind().
default GetNamedRefsParams.RetrieveOptions	getBranchRetrieveOptions()	Whether to retrieve branches, defaults to true.
default GetNamedRefsParams.RetrieveOptions	getTagRetrieveOptions()	Whether to retrieve tags, defaults to true.

Field Details

DEFAULT

static final GetNamedRefsParams DEFAULT

Method Details

builder

static org.projectnessie.versioned.ImmutableGetNamedRefsParams.Builder builder()

getBaseReference

@Nullable
NamedRef getBaseReference()

Named reference to use as the base for the computation of ReferenceInfo.getAheadBehind(). If this parameter is not null, 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 to true.

getTagRetrieveOptions

@Default
default GetNamedRefsParams.RetrieveOptions getTagRetrieveOptions()

Whether to retrieve tags, defaults to true.