Interface CreateCommentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>, SdkBuilder<CreateCommentRequest.Builder,CreateCommentRequest>, SdkPojo, SdkRequest.Builder, WorkDocsRequest.Builder
Enclosing class:
CreateCommentRequest
@Mutable @NotThreadSafe public static interface CreateCommentRequest.Builder extends WorkDocsRequest.Builder, SdkPojo, CopyableBuilder<CreateCommentRequest.Builder,CreateCommentRequest>

  • Method Details

    • authenticationToken

      CreateCommentRequest.Builder authenticationToken(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.

    • documentId

      CreateCommentRequest.Builder documentId(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.

    • versionId

      CreateCommentRequest.Builder versionId(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.

    • parentId

      CreateCommentRequest.Builder parentId(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.

    • threadId

      CreateCommentRequest.Builder threadId(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.

    • text

      CreateCommentRequest.Builder text(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.

    • visibility

      CreateCommentRequest.Builder visibility(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:

    • visibility

      CreateCommentRequest.Builder visibility(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:

    • notifyCollaborators

      CreateCommentRequest.Builder notifyCollaborators(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.

    • overrideConfiguration

      CreateCommentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.