Package software.amazon.awssdk.services.codecommit.model

Class CommentsForComparedCommit

java.lang.Object

software.amazon.awssdk.services.codecommit.model.CommentsForComparedCommit

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class CommentsForComparedCommit
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CommentsForComparedCommit.Builder,CommentsForComparedCommit>

Returns information about comments on the comparison between two commits.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommentsForComparedCommit.Builder

Method Summary

Modifier and Type	Method	Description
String	afterBlobId()	The full blob ID of the commit used to establish the after of the comparison.
String	afterCommitId()	The full commit ID of the commit used to establish the after of the comparison.
String	beforeBlobId()	The full blob ID of the commit used to establish the before of the comparison.
String	beforeCommitId()	The full commit ID of the commit used to establish the before of the comparison.
static CommentsForComparedCommit.Builder	builder()
List<Comment>	comments()	An array of comment objects.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasComments()	For responses, this returns true if the service returned a value for the Comments property.
int	hashCode()
Location	location()	Location information about the comment on the comparison, including the file name, line number, and whether the version of the file where the comment was made is BEFORE or AFTER.
String	repositoryName()	The name of the repository that contains the compared commits.
List<SdkField<?>>	sdkFields()
static Class<? extends CommentsForComparedCommit.Builder>	serializableBuilderClass()
CommentsForComparedCommit.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

repositoryName

public final String repositoryName()

The name of the repository that contains the compared commits.

Returns:

The name of the repository that contains the compared commits.

beforeCommitId

public final String beforeCommitId()

The full commit ID of the commit used to establish the before of the comparison.

Returns:

The full commit ID of the commit used to establish the before of the comparison.

afterCommitId

public final String afterCommitId()

The full commit ID of the commit used to establish the after of the comparison.

Returns:

The full commit ID of the commit used to establish the after of the comparison.

beforeBlobId

public final String beforeBlobId()

The full blob ID of the commit used to establish the before of the comparison.

Returns:

The full blob ID of the commit used to establish the before of the comparison.

afterBlobId

public final String afterBlobId()

The full blob ID of the commit used to establish the after of the comparison.

Returns:

The full blob ID of the commit used to establish the after of the comparison.

location

public final Location location()

Location information about the comment on the comparison, including the file name, line number, and whether the version of the file where the comment was made is BEFORE or AFTER.

Returns:

Location information about the comment on the comparison, including the file name, line number, and whether the version of the file where the comment was made is BEFORE or AFTER.

hasComments

public final boolean hasComments()

For responses, this returns true if the service returned a value for the Comments 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.

comments

public final List<Comment> comments()

An array of comment objects. Each comment object contains information about a comment on the comparison between commits.

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 hasComments() method.

Returns:

An array of comment objects. Each comment object contains information about a comment on the comparison between commits.

toBuilder

public CommentsForComparedCommit.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CommentsForComparedCommit.Builder,CommentsForComparedCommit>

builder

public static CommentsForComparedCommit.Builder builder()

serializableBuilderClass

public static Class<? extends CommentsForComparedCommit.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