Interface CreateCommentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateCommentRequest.Builder,
,CreateCommentRequest> SdkBuilder<CreateCommentRequest.Builder,
,CreateCommentRequest> SdkPojo
,SdkRequest.Builder
,WorkDocsRequest.Builder
- Enclosing class:
CreateCommentRequest
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationToken
(String authenticationToken) Amazon WorkDocs authentication token.documentId
(String documentId) The ID of the document.notifyCollaborators
(Boolean notifyCollaborators) Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The ID of the parent comment.The text of the comment.The ID of the root comment in the thread.The ID of the document version.visibility
(String visibility) The visibility of the comment.visibility
(CommentVisibilityType visibility) The visibility of the comment.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.workdocs.model.WorkDocsRequest.Builder
build
-
Method Details
-
authenticationToken
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
- Parameters:
authenticationToken
- Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentId
The ID of the document.
- Parameters:
documentId
- The ID of the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionId
The ID of the document version.
- Parameters:
versionId
- The ID of the document version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parentId
The ID of the parent comment.
- Parameters:
parentId
- The ID of the parent comment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
threadId
The ID of the root comment in the thread.
- Parameters:
threadId
- The ID of the root comment in the thread.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
text
The text of the comment.
- Parameters:
text
- The text of the comment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
notifyCollaborators
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
- Parameters:
notifyCollaborators
- Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateCommentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateCommentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-