Package org.projectnessie.model

Class NessieConfiguration

java.lang.Object

org.projectnessie.model.NessieConfiguration

@Immutable
public abstract class NessieConfiguration
extends java.lang.Object

configuration object to tell a client how a server is configured.

Constructor Summary

Constructors

Constructor	Description
NessieConfiguration()

Method Summary

Modifier and Type	Method	Description
int	getActualApiVersion()	The actual API version that was used to handle the REST request to the configuration endpoint.
abstract java.util.Map<java.lang.String,java.lang.String>	getAdditionalProperties()	Additional properties, currently undefined and always empty (not present in JSON).
static NessieConfiguration	getBuiltInConfig()
abstract @Size @Size(min=1) java.lang.String	getDefaultBranch()	The name of the default branch that the server will use unless an explicit branch was specified as an API call parameter.
abstract int	getMaxSupportedApiVersion()	The maximum API version supported by the server.
int	getMinSupportedApiVersion()	The minimum API version supported by the server.
abstract java.lang.String	getNoAncestorHash()	The so called no-ancestor-hash defines the commit-ID of the "beginning of time" in the repository.
abstract java.time.Instant	getOldestPossibleCommitTimestamp()	Timestamp of the oldest possible commit in the repository.
abstract java.time.Instant	getRepositoryCreationTimestamp()	Timestamp when the repository has been created.
abstract java.lang.String	getSpecVersion()	Semver version representing the behavior of the Nessie server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NessieConfiguration

public NessieConfiguration()

Method Detail

getDefaultBranch

@Nullable
@Nullable
@Size
@Size(min=1)
public abstract @Size @Size(min=1) java.lang.String getDefaultBranch()

The name of the default branch that the server will use unless an explicit branch was specified as an API call parameter.

getMinSupportedApiVersion

@Default
public int getMinSupportedApiVersion()

The minimum API version supported by the server.

API versions are numbered sequentially, as they are developed.

getMaxSupportedApiVersion

public abstract int getMaxSupportedApiVersion()

The maximum API version supported by the server.

API versions are numbered sequentially, as they are developed.

getActualApiVersion

@Default
public int getActualApiVersion()

The actual API version that was used to handle the REST request to the configuration endpoint.

If this value is 0, then the server does not support returning the actual API version. Otherwise, this value is guaranteed to be between getMinSupportedApiVersion() and getMaxSupportedApiVersion() (inclusive).

getSpecVersion

@Nullable
@Nullable
public abstract java.lang.String getSpecVersion()

Semver version representing the behavior of the Nessie server.

Additional functionality might be added to Nessie servers within a "spec major version" in a non-breaking way. Clients are encouraged to check the spec version when using such added functionality.

getNoAncestorHash

@Nullable
@Nullable
public abstract java.lang.String getNoAncestorHash()

The so called no-ancestor-hash defines the commit-ID of the "beginning of time" in the repository. The very first commit will have the value returned by this function as its parent commit-ID. A commit with this value does never exist.

getRepositoryCreationTimestamp

@Nullable
@Nullable
public abstract java.time.Instant getRepositoryCreationTimestamp()

Timestamp when the repository has been created.

The value is only returned, if the server supports this attribute.

getOldestPossibleCommitTimestamp

@Nullable
@Nullable
public abstract java.time.Instant getOldestPossibleCommitTimestamp()

Timestamp of the oldest possible commit in the repository.

For new repositories, this is likely the same as getRepositoryCreationTimestamp(). For imported repositories, this shall be the timestamp of the oldest commit.

The value is only returned, if the server supports this attribute.

getAdditionalProperties

public abstract java.util.Map<java.lang.String,java.lang.String> getAdditionalProperties()

Additional properties, currently undefined and always empty (not present in JSON).

getBuiltInConfig

public static NessieConfiguration getBuiltInConfig()