Package org.projectnessie.model

Class CommitMeta

  • @Immutable
public abstract class CommitMeta
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String MERGE_PARENT_PROPERTY
      Key of the property that indicates the merged commit ID, if the commit represents a merge commit.

    • Constructor Summary

      Constructors 
      Constructor Description
      CommitMeta()  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      static org.projectnessie.model.ImmutableCommitMeta.Builder builder()  
      static CommitMeta fromMessage​(java.lang.String message)  
      abstract java.lang.String getAuthor()
      The author of a commit.
      abstract java.time.Instant getAuthorTime()
      Original commit time in UTC.
      abstract java.lang.String getCommitter()
      The entity performing this commit/transaction.
      abstract java.time.Instant getCommitTime()
      Commit time in UTC.
      abstract java.lang.String getHash()
      Hash of this commit.
      abstract @NotBlank java.lang.String getMessage()
      Message describing this commit.
      abstract @NotNull java.util.Map<java.lang.String,​java.lang.String> getProperties()
      Set of properties to help further identify this commit.
      abstract java.lang.String getSignedOffBy()
      Authorizer of this action.
      org.projectnessie.model.ImmutableCommitMeta.Builder toBuilder()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • MERGE_PARENT_PROPERTY

        public static final java.lang.String MERGE_PARENT_PROPERTY
        Key of the property that indicates the merged commit ID, if the commit represents a merge commit.

        If the commit is the result of a merge operation, the properties map may contain the key "_merge_parent", if the merge was performed with a Nessie server version, after 0.30.0, that persists the merged reference.

        See Also:
        Constant Field Values

    • Constructor Detail

      • CommitMeta

        public CommitMeta()

    • Method Detail

      • getHash

        @Nullable
public abstract java.lang.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 java.lang.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 java.lang.String getAuthor()
        The author of a commit. This is the original committer.

      • getSignedOffBy

        @Nullable
public abstract java.lang.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

        @NotBlank
public abstract @NotBlank java.lang.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 java.time.Instant getCommitTime()
        Commit time in UTC. Set by the server.

      • getAuthorTime

        @Nullable
public abstract java.time.Instant getAuthorTime()
        Original commit time in UTC. Set by the server.

      • getProperties

        @NotNull
public abstract @NotNull java.util.Map<java.lang.String,​java.lang.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 org.projectnessie.model.ImmutableCommitMeta.Builder toBuilder()

      • builder

        public static org.projectnessie.model.ImmutableCommitMeta.Builder builder()

      • fromMessage

        public static CommitMeta fromMessage​(java.lang.String message)