com.amazonaws.services.workdocs.model

Class CreateCommentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workdocs.model.CreateCommentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCommentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateCommentRequest()

Method Summary

Modifier and Type	Method and Description
CreateCommentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAuthenticationToken() Amazon WorkDocs authentication token.
String	getDocumentId() The ID of the document.
Boolean	getNotifyCollaborators() Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
String	getParentId() The ID of the parent comment.
String	getText() The text of the comment.
String	getThreadId() The ID of the root comment in the thread.
String	getVersionId() The ID of the document version.
String	getVisibility() The visibility of the comment.
int	hashCode()
Boolean	isNotifyCollaborators() Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
void	setAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
void	setDocumentId(String documentId) The ID of the document.
void	setNotifyCollaborators(Boolean notifyCollaborators) Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
void	setParentId(String parentId) The ID of the parent comment.
void	setText(String text) The text of the comment.
void	setThreadId(String threadId) The ID of the root comment in the thread.
void	setVersionId(String versionId) The ID of the document version.
void	setVisibility(CommentVisibilityType visibility) The visibility of the comment.
void	setVisibility(String visibility) The visibility of the comment.
String	toString() Returns a string representation of this object.
CreateCommentRequest	withAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
CreateCommentRequest	withDocumentId(String documentId) The ID of the document.
CreateCommentRequest	withNotifyCollaborators(Boolean notifyCollaborators) Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
CreateCommentRequest	withParentId(String parentId) The ID of the parent comment.
CreateCommentRequest	withText(String text) The text of the comment.
CreateCommentRequest	withThreadId(String threadId) The ID of the root comment in the thread.
CreateCommentRequest	withVersionId(String versionId) The ID of the document version.
CreateCommentRequest	withVisibility(CommentVisibilityType visibility) The visibility of the comment.
CreateCommentRequest	withVisibility(String visibility) The visibility of the comment.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCommentRequest

public CreateCommentRequest()

Method Detail

setAuthenticationToken

public void setAuthenticationToken(String 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.

getAuthenticationToken

public String getAuthenticationToken()

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

withAuthenticationToken

public CreateCommentRequest withAuthenticationToken(String 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.

setDocumentId

public void setDocumentId(String documentId)

The ID of the document.

Parameters:

documentId - The ID of the document.

getDocumentId

public String getDocumentId()

The ID of the document.

Returns:

The ID of the document.

withDocumentId

public CreateCommentRequest withDocumentId(String 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.

setVersionId

public void setVersionId(String versionId)

The ID of the document version.

Parameters:

versionId - The ID of the document version.

getVersionId

public String getVersionId()

The ID of the document version.

Returns:

The ID of the document version.

withVersionId

public CreateCommentRequest withVersionId(String 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.

setParentId

public void setParentId(String parentId)

The ID of the parent comment.

Parameters:

parentId - The ID of the parent comment.

getParentId

public String getParentId()

The ID of the parent comment.

Returns:

The ID of the parent comment.

withParentId

public CreateCommentRequest withParentId(String 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.

setThreadId

public void setThreadId(String threadId)

The ID of the root comment in the thread.

Parameters:

threadId - The ID of the root comment in the thread.

getThreadId

public String getThreadId()

The ID of the root comment in the thread.

Returns:

The ID of the root comment in the thread.

withThreadId

public CreateCommentRequest withThreadId(String 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.

setText

public void setText(String text)

The text of the comment.

Parameters:

text - The text of the comment.

getText

public String getText()

The text of the comment.

Returns:

The text of the comment.

withText

public CreateCommentRequest withText(String 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.

setVisibility

public void setVisibility(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.

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.

See Also:

CommentVisibilityType

getVisibility

public String getVisibility()

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

withVisibility

public CreateCommentRequest withVisibility(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.

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:

CommentVisibilityType

setVisibility

public void setVisibility(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.

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.

See Also:

CommentVisibilityType

withVisibility

public CreateCommentRequest withVisibility(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.

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:

CommentVisibilityType

setNotifyCollaborators

public void setNotifyCollaborators(Boolean 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.

getNotifyCollaborators

public Boolean getNotifyCollaborators()

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.

withNotifyCollaborators

public CreateCommentRequest withNotifyCollaborators(Boolean 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.

isNotifyCollaborators

public Boolean isNotifyCollaborators()

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateCommentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()