Class Comment

java.lang.Object
software.amazon.awssdk.services.workdocs.model.Comment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Comment.Builder,Comment>
@Generated("software.amazon.awssdk:codegen") public final class Comment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Comment.Builder,Comment>

Describes a comment.

See Also:

  • Method Details

    • commentId

      public final String commentId()

      The ID of the comment.

      Returns:
      The ID of the comment.

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

    • contributor

      public final User contributor()

      The details of the user who made the comment.

      Returns:
      The details of the user who made the comment.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time that the comment was created.

      Returns:
      The time that the comment was created.

    • status

      public final CommentStatusType status()

      The status of the comment.

      If the service returns an enum value that is not available in the current SDK version, status will return CommentStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the comment.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the comment.

      If the service returns an enum value that is not available in the current SDK version, status will return CommentStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the comment.
      See Also:

    • 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:

    • 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:

    • recipientId

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

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

    • toBuilder

      public Comment.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<Comment.Builder,Comment>
      Returns:
      a builder for type T

    • builder

      public static Comment.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.