software.amazon.awssdk.services.codecommit.model

Class Comment

java.lang.Object

software.amazon.awssdk.services.codecommit.model.Comment

All Implemented Interfaces:

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

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

Returns information about a specific comment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Comment.Builder

Method Summary

Modifier and Type	Method and Description
String	authorArn() The Amazon Resource Name (ARN) of the person who posted the comment.
static Comment.Builder	builder()
List<String>	callerReactions() The emoji reactions to a comment, if any, submitted by the user whose credentials are associated with the call to the API.
String	clientRequestToken() A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.
String	commentId() The system-generated comment ID.
String	content() The content of the comment.
Instant	creationDate() The date and time the comment was created, in timestamp format.
Boolean	deleted() A Boolean value indicating whether the comment has been deleted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCallerReactions() For responses, this returns true if the service returned a value for the CallerReactions property.
int	hashCode()
boolean	hasReactionCounts() For responses, this returns true if the service returned a value for the ReactionCounts property.
String	inReplyTo() The ID of the comment for which this comment is a reply, if any.
Instant	lastModifiedDate() The date and time the comment was most recently modified, in timestamp format.
Map<String,Integer>	reactionCounts() A string to integer map that represents the number of individual users who have responded to a comment with the specified reactions.
List<SdkField<?>>	sdkFields()
static Class<? extends Comment.Builder>	serializableBuilderClass()
Comment.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

commentId

public final String commentId()

The system-generated comment ID.

Returns:

The system-generated comment ID.

content

public final String content()

The content of the comment.

Returns:

The content of the comment.

inReplyTo

public final String inReplyTo()

The ID of the comment for which this comment is a reply, if any.

Returns:

The ID of the comment for which this comment is a reply, if any.

creationDate

public final Instant creationDate()

The date and time the comment was created, in timestamp format.

Returns:

The date and time the comment was created, in timestamp format.

lastModifiedDate

public final Instant lastModifiedDate()

The date and time the comment was most recently modified, in timestamp format.

Returns:

The date and time the comment was most recently modified, in timestamp format.

authorArn

public final String authorArn()

The Amazon Resource Name (ARN) of the person who posted the comment.

Returns:

The Amazon Resource Name (ARN) of the person who posted the comment.

deleted

public final Boolean deleted()

A Boolean value indicating whether the comment has been deleted.

Returns:

A Boolean value indicating whether the comment has been deleted.

clientRequestToken

public final String clientRequestToken()

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.

Returns:

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.

hasCallerReactions

public final boolean hasCallerReactions()

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

callerReactions

public final List<String> callerReactions()

The emoji reactions to a comment, if any, submitted by the user whose credentials are associated with the call to the API.

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

Returns:

The emoji reactions to a comment, if any, submitted by the user whose credentials are associated with the call to the API.

hasReactionCounts

public final boolean hasReactionCounts()

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

reactionCounts

public final Map<String,Integer> reactionCounts()

A string to integer map that represents the number of individual users who have responded to a comment with the specified reactions.

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

Returns:

A string to integer map that represents the number of individual users who have responded to a comment with the specified reactions.

toBuilder

public Comment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Comment.Builder,Comment>

builder

public static Comment.Builder builder()

serializableBuilderClass

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