Comment (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workdocs.model.Comment

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes a comment.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Comment()

Constructors
Constructor and Description
`Comment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Comment`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCommentId()` The ID of the comment.
`User`	`getContributor()` The details of the user who made the comment.
`Date`	`getCreatedTimestamp()` The time that the comment was created.
`String`	`getParentId()` The ID of the parent comment.
`String`	`getRecipientId()` If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.
`String`	`getStatus()` The status of the comment.
`String`	`getText()` The text of the comment.
`String`	`getThreadId()` The ID of the root comment in the thread.
`String`	`getVisibility()` The visibility of the comment.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCommentId(String commentId)` The ID of the comment.
`void`	`setContributor(User contributor)` The details of the user who made the comment.
`void`	`setCreatedTimestamp(Date createdTimestamp)` The time that the comment was created.
`void`	`setParentId(String parentId)` The ID of the parent comment.
`void`	`setRecipientId(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.
`void`	`setStatus(CommentStatusType status)` The status of the comment.
`void`	`setStatus(String status)` The status of the comment.
`void`	`setText(String text)` The text of the comment.
`void`	`setThreadId(String threadId)` The ID of the root comment in the thread.
`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; useful for testing and debugging.
`Comment`	`withCommentId(String commentId)` The ID of the comment.
`Comment`	`withContributor(User contributor)` The details of the user who made the comment.
`Comment`	`withCreatedTimestamp(Date createdTimestamp)` The time that the comment was created.
`Comment`	`withParentId(String parentId)` The ID of the parent comment.
`Comment`	`withRecipientId(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.
`Comment`	`withStatus(CommentStatusType status)` The status of the comment.
`Comment`	`withStatus(String status)` The status of the comment.
`Comment`	`withText(String text)` The text of the comment.
`Comment`	`withThreadId(String threadId)` The ID of the root comment in the thread.
`Comment`	`withVisibility(CommentVisibilityType visibility)` The visibility of the comment.
`Comment`	`withVisibility(String visibility)` The visibility of the comment.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Comment
```
public Comment()
```
- Method Detail
  - setCommentId
```
public void setCommentId(String commentId)
```
    The ID of the comment.
    
    Parameters:
    
    commentId - The ID of the comment.
  - getCommentId
```
public String getCommentId()
```
    The ID of the comment.
    
    Returns:
    
    The ID of the comment.
  - withCommentId
```
public Comment withCommentId(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.
  - 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 Comment 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 Comment 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 Comment 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.
  - setContributor
```
public void setContributor(User contributor)
```
    The details of the user who made the comment.
    
    Parameters:
    
    contributor - The details of the user who made the comment.
  - getContributor
```
public User getContributor()
```
    The details of the user who made the comment.
    
    Returns:
    
    The details of the user who made the comment.
  - withContributor
```
public Comment withContributor(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.
  - setCreatedTimestamp
```
public void setCreatedTimestamp(Date createdTimestamp)
```
    The time that the comment was created.
    
    Parameters:
    
    createdTimestamp - The time that the comment was created.
  - getCreatedTimestamp
```
public Date getCreatedTimestamp()
```
    The time that the comment was created.
    
    Returns:
    
    The time that the comment was created.
  - withCreatedTimestamp
```
public Comment withCreatedTimestamp(Date 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.
  - setStatus
```
public void setStatus(String status)
```
    The status of the comment.
    
    Parameters:
    
    status - The status of the comment.
    
    See Also:
    
    CommentStatusType
  - getStatus
```
public String getStatus()
```
    The status of the comment.
    
    Returns:
    
    The status of the comment.
    
    See Also:
    
    CommentStatusType
  - withStatus
```
public Comment withStatus(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:
    
    CommentStatusType
  - setStatus
```
public void setStatus(CommentStatusType status)
```
    The status of the comment.
    
    Parameters:
    
    status - The status of the comment.
    
    See Also:
    
    CommentStatusType
  - withStatus
```
public Comment withStatus(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:
    
    CommentStatusType
  - 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 Comment 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 Comment 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
  - setRecipientId
```
public void setRecipientId(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.
  - getRecipientId
```
public String getRecipientId()
```
    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.
  - withRecipientId
```
public Comment withRecipientId(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 Comment clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Comment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Comment

Method Detail

setCommentId

getCommentId

withCommentId

setParentId

getParentId

withParentId

setThreadId

getThreadId

withThreadId

setText

getText

withText

setContributor

getContributor

withContributor

setCreatedTimestamp

getCreatedTimestamp

withCreatedTimestamp

setStatus

getStatus

withStatus

setStatus

withStatus

setVisibility

getVisibility

withVisibility

setVisibility

withVisibility

setRecipientId

getRecipientId

withRecipientId

toString

equals

hashCode

clone

marshall