@Generated(value="software.amazon.awssdk:codegen") public class Comment extends Object implements StructuredPojo, ToCopyableBuilder<Comment.Builder,Comment>
Describes a comment.
Modifier and Type | Class and Description |
---|---|
static interface |
Comment.Builder |
Modifier and Type | Method and 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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.
|
static Class<? extends Comment.Builder> |
serializableBuilderClass() |
CommentStatusType |
status()
The status of the comment.
|
String |
statusString()
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
CommentVisibilityType |
visibility()
The visibility of the comment.
|
String |
visibilityString()
The visibility of the comment.
|
copy
public String commentId()
The ID of the comment.
public String parentId()
The ID of the parent comment.
public String threadId()
The ID of the root comment in the thread.
public String text()
The text of the comment.
public User contributor()
The details of the user who made the comment.
public Instant createdTimestamp()
The time that the comment was created.
public 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
statusString()
.
CommentStatusType
public String statusString()
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
statusString()
.
CommentStatusType
public 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 visibilityString()
.
CommentVisibilityType
public String visibilityString()
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 visibilityString()
.
CommentVisibilityType
public 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.
public Comment.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Comment.Builder,Comment>
public static Comment.Builder builder()
public static Class<? extends Comment.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.