Package software.amazon.awssdk.services.workdocs.model

Class Comment

java.lang.Object

software.amazon.awssdk.services.workdocs.model.Comment

All Implemented Interfaces:

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

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

Describes a comment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Comment.Builder

Method Summary

Modifier and Type	Method	Description
static Comment.Builder	builder()
String	commentId()	The ID of the comment.
User	contributor()	The details of the user who made the comment.
Instant	createdTimestamp()	The time that the comment was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	parentId()	The ID of the parent comment.
String	recipientId()	If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.
List<SdkField<?>>	sdkFields()
static Class<? extends Comment.Builder>	serializableBuilderClass()
CommentStatusType	status()	The status of the comment.
String	statusAsString()	The status of the comment.
String	text()	The text of the comment.
String	threadId()	The ID of the root comment in the thread.
Comment.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CommentVisibilityType	visibility()	The visibility of the comment.
String	visibilityAsString()	The visibility of the comment.

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 ID of the comment.

Returns:

The ID of the comment.

parentId

public final String parentId()

The ID of the parent comment.

Returns:

The ID of the parent comment.

threadId

public final String threadId()

The ID of the root comment in the thread.

Returns:

The ID of the root comment in the thread.

text

public final String text()

The text of the comment.

Returns:

The text of the comment.

contributor

public final User contributor()

The details of the user who made the comment.

Returns:

The details of the user who made the comment.

createdTimestamp

public final Instant createdTimestamp()

The time that the comment was created.

Returns:

The time that the comment was created.

status

public final CommentStatusType status()

The status of the comment.

If the service returns an enum value that is not available in the current SDK version, status will return CommentStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the comment.

See Also:

CommentStatusType

statusAsString

public final String statusAsString()

The status of the comment.

If the service returns an enum value that is not available in the current SDK version, status will return CommentStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the comment.

See Also:

CommentStatusType

visibility

public final CommentVisibilityType visibility()

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

If the service returns an enum value that is not available in the current SDK version, visibility will return CommentVisibilityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

Returns:

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

See Also:

CommentVisibilityType

visibilityAsString

public final String visibilityAsString()

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

If the service returns an enum value that is not available in the current SDK version, visibility will return CommentVisibilityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

Returns:

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

See Also:

CommentVisibilityType

recipientId

public final String recipientId()

If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

Returns:

If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

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