Class Commit

java.lang.Object
software.amazon.awssdk.services.codecommit.model.Commit
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Commit.Builder,Commit>
@Generated("software.amazon.awssdk:codegen") public final class Commit extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Commit.Builder,Commit>

Returns information about a specific commit.

See Also:

  • Method Details

    • commitId

      public final String commitId()

      The full SHA ID of the specified commit.

      Returns:
      The full SHA ID of the specified commit.

    • treeId

      public final String treeId()

      Tree information for the specified commit.

      Returns:
      Tree information for the specified commit.

    • hasParents

      public final boolean hasParents()
      For responses, this returns true if the service returned a value for the Parents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parents

      public final List<String> parents()

      A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParents() method.

      Returns:
      A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.

    • message

      public final String message()

      The commit message associated with the specified commit.

      Returns:
      The commit message associated with the specified commit.

    • author

      public final UserInfo author()

      Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.

      Returns:
      Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.

    • committer

      public final UserInfo committer()

      Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.

      For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

      Returns:
      Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.

      For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

    • additionalData

      public final String additionalData()

      Any other data associated with the specified commit.

      Returns:
      Any other data associated with the specified commit.

    • toBuilder

      public Commit.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Commit.Builder,Commit>
      Returns:
      a builder for type T

    • builder

      public static Commit.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Commit.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.