Interface Comment.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Comment.Builder,Comment>, SdkBuilder<Comment.Builder,Comment>, SdkPojo
Enclosing class:
Comment
public static interface Comment.Builder extends SdkPojo, CopyableBuilder<Comment.Builder,Comment>

  • Method Details

    • commentId

      Comment.Builder commentId(String commentId)

      The ID of the comment.

      Parameters:
      commentId - The ID of the comment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentId

      Comment.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

      Comment.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

      Comment.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.

    • contributor

      Comment.Builder contributor(User contributor)

      The details of the user who made the comment.

      Parameters:
      contributor - The details of the user who made the comment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contributor

      default Comment.Builder contributor(Consumer<User.Builder> contributor)

      The details of the user who made the comment.

      This is a convenience method that creates an instance of the User.Builder avoiding the need to create one manually via User.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contributor(User).

      Parameters:
      contributor - a consumer that will call methods on User.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdTimestamp

      Comment.Builder createdTimestamp(Instant createdTimestamp)

      The time that the comment was created.

      Parameters:
      createdTimestamp - The time that the comment was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Comment.Builder status(String status)

      The status of the comment.

      Parameters:
      status - The status of the comment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Comment.Builder status(CommentStatusType status)

      The status of the comment.

      Parameters:
      status - The status of the comment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visibility

      Comment.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

      Comment.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:

    • recipientId

      Comment.Builder recipientId(String recipientId)

      If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

      Parameters:
      recipientId - If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.