software.amazon.awssdk.services.codecommit.model

Class Commit

java.lang.Object

software.amazon.awssdk.services.codecommit.model.Commit

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Commit.Builder,Commit>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Commit.Builder

Method Summary

Modifier and Type	Method and Description
String	additionalData() Any other data associated with the specified commit.
UserInfo	author() Information about the author of the specified commit.
static Commit.Builder	builder()
String	commitId() The full SHA ID of the specified commit.
UserInfo	committer() Information about the person who committed the specified commit, also known as the committer.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParents() For responses, this returns true if the service returned a value for the Parents property.
String	message() The commit message associated with the specified commit.
List<String>	parents() A list of parent commits for the specified commit.
List<SdkField<?>>	sdkFields()
static Class<? extends Commit.Builder>	serializableBuilderClass()
Commit.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	treeId() Tree information for the specified commit.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<Commit.Builder,Commit>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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