Package org.projectnessie.model

Interface Reference

All Superinterfaces:

Base

All Known Subinterfaces:

Branch, Detached, Tag

public interface Reference
extends Base

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Reference.ReferenceType	The reference type as an enum.

Method Summary

Modifier and Type	Method	Description
default void	checkHash()	Validation rule using Validation.validateHash(String).
@Pattern(regexp="^[0-9a-fA-F]{8,64}$",message="Hash must consist of the hex representation of 4-32 bytes") java.lang.String	getHash()	backend system id.
ReferenceMetadata	getMetadata()	Returns a ReferenceMetadata instance that contains additional metadata about this reference.
@NotBlank @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	getName()	Human-readable reference name.
Reference.ReferenceType	getType()

Method Detail

getName

@NotBlank
@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 \'..\'")
@NotBlank @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 getName()

Human-readable reference name.

getHash

@Pattern(regexp="^[0-9a-fA-F]{8,64}$",
         message="Hash must consist of the hex representation of 4-32 bytes")
@Pattern(regexp="^[0-9a-fA-F]{8,64}$",message="Hash must consist of the hex representation of 4-32 bytes") java.lang.String getHash()

backend system id. Usually the 32-byte hash of the commit this reference points to.

checkHash

@Check
default void checkHash()

Validation rule using Validation.validateHash(String).

getMetadata

@Nullable
ReferenceMetadata getMetadata()

Returns a ReferenceMetadata instance that contains additional metadata about this reference. Note that this is only added by the server when explicitly requested by the client.

Returns:

A ReferenceMetadata instance that contains additional metadata about this reference. Note that this is only added by the server when explicitly requested by the client.

getType

@Redacted
Reference.ReferenceType getType()