Package io.github.primelib.jira4j.restv3.model

Class Comment

java.lang.Object
io.github.primelib.jira4j.restv3.model.Comment
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class Comment extends Object
Comment

  • Field Details

    • author

      protected CommentAuthor author

    • body

      protected Object body
      The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).

    • created

      protected OffsetDateTime created
      The date and time at which the comment was created.

    • id

      protected String id
      The ID of the comment.

    • jsdAuthorCanSeeRequest

      protected Boolean jsdAuthorCanSeeRequest
      Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature.

    • jsdPublic

      protected Boolean jsdPublic
      Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.

    • properties

      protected List<EntityProperty> properties
      A list of comment properties. Optional on create and update.

    • renderedBody

      protected String renderedBody
      The rendered version of the comment.

    • self

      protected String self
      The URL of the comment.

    • updateAuthor

      protected CommentUpdateAuthor updateAuthor

    • updated

      protected OffsetDateTime updated
      The date and time at which the comment was updated last.

    • visibility

      protected Visibility visibility

  • Constructor Details

    • Comment

      public Comment(Consumer<Comment> spec)
      Constructs a validated instance of Comment.
      Parameters:
      spec - the specification to process

    • Comment

      @Internal public Comment(CommentAuthor author, Object body, OffsetDateTime created, String id, Boolean jsdAuthorCanSeeRequest, Boolean jsdPublic, List<EntityProperty> properties, String renderedBody, String self, CommentUpdateAuthor updateAuthor, OffsetDateTime updated, Visibility visibility)
      Constructs a validated instance of Comment.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using Comment(Consumer) instead.

      Parameters:
      author - author
      body - The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).
      created - The date and time at which the comment was created.
      id - The ID of the comment.
      jsdAuthorCanSeeRequest - Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature.
      jsdPublic - Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.
      properties - A list of comment properties. Optional on create and update.
      renderedBody - The rendered version of the comment.
      self - The URL of the comment.
      updateAuthor - updateAuthor
      updated - The date and time at which the comment was updated last.
      visibility - visibility

    • Comment

      protected Comment()

  • Method Details

    • builder

      public static Comment.CommentBuilder builder()

    • author

      public CommentAuthor author()

    • body

      public Object body()
      The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).

    • created

      public OffsetDateTime created()
      The date and time at which the comment was created.

    • id

      public String id()
      The ID of the comment.

    • jsdAuthorCanSeeRequest

      public Boolean jsdAuthorCanSeeRequest()
      Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature.

    • jsdPublic

      public Boolean jsdPublic()
      Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.

    • properties

      public List<EntityProperty> properties()
      A list of comment properties. Optional on create and update.

    • renderedBody

      public String renderedBody()
      The rendered version of the comment.

    • self

      public String self()
      The URL of the comment.

    • updateAuthor

      public CommentUpdateAuthor updateAuthor()

    • updated

      public OffsetDateTime updated()
      The date and time at which the comment was updated last.

    • visibility

      public Visibility visibility()

    • author

      public Comment author(CommentAuthor author)
      Returns:
      this.

    • body

      public Comment body(Object body)
      The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).
      Returns:
      this.

    • created

      public Comment created(OffsetDateTime created)
      The date and time at which the comment was created.
      Returns:
      this.

    • id

      public Comment id(String id)
      The ID of the comment.
      Returns:
      this.

    • jsdAuthorCanSeeRequest

      public Comment jsdAuthorCanSeeRequest(Boolean jsdAuthorCanSeeRequest)
      Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature.
      Returns:
      this.

    • jsdPublic

      public Comment jsdPublic(Boolean jsdPublic)
      Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.
      Returns:
      this.

    • properties

      public Comment properties(List<EntityProperty> properties)
      A list of comment properties. Optional on create and update.
      Returns:
      this.

    • renderedBody

      public Comment renderedBody(String renderedBody)
      The rendered version of the comment.
      Returns:
      this.

    • self

      public Comment self(String self)
      The URL of the comment.
      Returns:
      this.

    • updateAuthor

      public Comment updateAuthor(CommentUpdateAuthor updateAuthor)
      Returns:
      this.

    • updated

      public Comment updated(OffsetDateTime updated)
      The date and time at which the comment was updated last.
      Returns:
      this.

    • visibility

      public Comment visibility(Visibility visibility)
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object