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

Class CreateCommentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workdocs.model.WorkDocsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateCommentRequest.Builder

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
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()
String	toString()	Returns a string representation of this object.
String	versionId()	The ID of the document version.
CommentVisibilityType	visibility()	The visibility of the comment.
String	visibilityAsString()	The visibility of the comment.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

authenticationToken

public final String authenticationToken()

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.

documentId

public final String documentId()

The ID of the document.

Returns:

The ID of the document.

versionId

public final String versionId()

The ID of the document version.

Returns:

The ID of the document version.

parentId

public final String parentId()

The ID of the parent comment.

Returns:

The ID of the parent comment.

threadId

public final String threadId()

The ID of the root comment in the thread.

Returns:

The ID of the root comment in the thread.

text

public final String text()

The text of the comment.

Returns:

The text of the comment.

visibility

public final 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().

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

visibilityAsString

public final 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().

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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>

Specified by:

toBuilder in class WorkDocsRequest

builder

public static CreateCommentRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo