Package org.projectnessie.model

Class CommitMeta

java.lang.Object

org.projectnessie.model.CommitMeta

Direct Known Subclasses:

ImmutableCommitMeta

@Immutable(prehash=true)
public abstract class CommitMeta
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommitMeta.InstantDeserializer	Used to deserialize an instant to ISO-8601 format.
static class	CommitMeta.InstantSerializer	Used to serialize an instant to ISO-8601 format.

Constructor Summary

Constructors

Constructor	Description
CommitMeta()

Method Summary

Modifier and Type	Method	Description
static ImmutableCommitMeta.Builder	builder()
static CommitMeta	fromMessage(String message)
abstract String	getAuthor()	The author of a commit.
abstract Instant	getAuthorTime()	Original commit time in UTC.
abstract String	getCommitter()	The entity performing this commit/transaction.
abstract Instant	getCommitTime()	Commit time in UTC.
abstract String	getHash()	Hash of this commit.
abstract String	getMessage()	Message describing this commit.
abstract Map<String,String>	getProperties()	Set of properties to help further identify this commit.
abstract String	getSignedOffBy()	Authorizer of this action.
ImmutableCommitMeta.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitMeta

public CommitMeta()

Method Detail

getHash

@Nullable
public abstract String getHash()

Hash of this commit.

This is not known at creation time and is only valid when reading the log.

getCommitter

@Nullable
public abstract String getCommitter()

The entity performing this commit/transaction.

This is the logged in user/account who performs this action. Populated on the server. Nessie will return an error if this is populated by the client side.

The committer should follow the git spec for names eg Committer Name <committer.name@example.com> but this is not enforced. See https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---authorltauthorgt

getAuthor

@Nullable
public abstract String getAuthor()

The author of a commit. This is the original committer.

getSignedOffBy

@Nullable
public abstract String getSignedOffBy()

Authorizer of this action.

For example if the user who did the transaction is a service account this could be populated by the person who started the job.

getMessage

public abstract String getMessage()

Message describing this commit. Should conform to Git style.

Like github if this message is in markdown it may be displayed cleanly in the UI.

getCommitTime

@Nullable
public abstract Instant getCommitTime()

Commit time in UTC. Set by the server.

getAuthorTime

@Nullable
public abstract Instant getAuthorTime()

Original commit time in UTC. Set by the server.

getProperties

public abstract Map<String,String> getProperties()

Set of properties to help further identify this commit.

examples are spark id, the client type (eg iceberg, delta etc), application or job names, hostnames etc

toBuilder

public ImmutableCommitMeta.Builder toBuilder()

builder

public static ImmutableCommitMeta.Builder builder()

fromMessage

public static CommitMeta fromMessage(String message)