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

Class CreateCommentRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.workdocs.model.CreateCommentRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateCommentRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateCommentRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	authenticationToken()	Amazon WorkDocs authentication token.
static CreateCommentRequest.Builder	builder()
String	documentId()	The ID of the document.
boolean	equals(Object obj)
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.
String	visibility()	The visibility of the comment.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

authenticationToken

public String authenticationToken()

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

documentId

public String documentId()

The ID of the document.

Returns:

The ID of the document.

versionId

public String versionId()

The ID of the document version.

Returns:

The ID of the document version.

parentId

public String parentId()

The ID of the parent comment.

Returns:

The ID of the parent comment.

threadId

public String threadId()

The ID of the root comment in the thread.

Returns:

The ID of the root comment in the thread.

text

public String text()

The text of the comment.

Returns:

The text of the comment.

visibility

public String 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:

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

notifyCollaborators

public Boolean notifyCollaborators()

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

Returns:

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

toBuilder

public CreateCommentRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>

Returns:

a builder for type T

builder

public static CreateCommentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCommentRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object