@Generated(value="software.amazon.awssdk:codegen") public final class CreateCommentRequest extends WorkDocsRequest implements ToCopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateCommentRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
authenticationToken()
Amazon WorkDocs authentication token.
|
static CreateCommentRequest.Builder |
builder() |
String |
documentId()
The ID of the document.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Boolean |
notifyCollaborators()
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
|
String |
parentId()
The ID of the parent comment.
|
static Class<? extends CreateCommentRequest.Builder> |
serializableBuilderClass() |
String |
text()
The text of the comment.
|
String |
threadId()
The ID of the root comment in the thread.
|
CreateCommentRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
versionId()
The ID of the document version.
|
CommentVisibilityType |
visibility()
The visibility of the comment.
|
String |
visibilityAsString()
The visibility of the comment.
|
overrideConfiguration
copy
public String authenticationToken()
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
public String documentId()
The ID of the document.
public String versionId()
The ID of the document version.
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 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()
.
CommentVisibilityType
public 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()
.
CommentVisibilityType
public Boolean notifyCollaborators()
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
public CreateCommentRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>
toBuilder
in class WorkDocsRequest
public static CreateCommentRequest.Builder builder()
public static Class<? extends CreateCommentRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.