Package io.github.primelib.jira4j.restv3.spec

Class UpdateCommentOperationSpec

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

Specification for the UpdateComment operation.

Update comment

  • Field Details

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Constructor Details

    • UpdateCommentOperationSpec

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

    • UpdateCommentOperationSpec

      @Internal public UpdateCommentOperationSpec(String issueIdOrKey, String id, Comment comment, Boolean notifyUsers, Boolean overrideEditableFlag, String expand)
      Constructs a validated instance of UpdateCommentOperationSpec.

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameters:
      issueIdOrKey - The ID or key of the issue.
      id - The ID of the comment.
      comment -
      notifyUsers - Whether users are notified when a comment is updated.
      overrideEditableFlag - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
      expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

    • UpdateCommentOperationSpec

      protected UpdateCommentOperationSpec()

  • Method Details

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Throws:
      NullPointerException

    • builder

      public static UpdateCommentOperationSpec.UpdateCommentOperationSpecBuilder builder()

    • issueIdOrKey

      @NotNull public @NotNull String issueIdOrKey()
      The ID or key of the issue.

    • id

      @NotNull public @NotNull String id()
      The ID of the comment.

    • comment

      @NotNull public @NotNull Comment comment()

    • notifyUsers

      @Nullable public @Nullable Boolean notifyUsers()
      Whether users are notified when a comment is updated.

    • overrideEditableFlag

      @Nullable public @Nullable Boolean overrideEditableFlag()
      Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

    • issueIdOrKey

      public UpdateCommentOperationSpec issueIdOrKey(@NotNull @NotNull String issueIdOrKey)
      The ID or key of the issue.
      Returns:
      this.

    • id

      public UpdateCommentOperationSpec id(@NotNull @NotNull String id)
      The ID of the comment.
      Returns:
      this.

    • comment

      public UpdateCommentOperationSpec comment(@NotNull @NotNull Comment comment)
      Returns:
      this.

    • notifyUsers

      public UpdateCommentOperationSpec notifyUsers(@Nullable @Nullable Boolean notifyUsers)
      Whether users are notified when a comment is updated.
      Returns:
      this.

    • overrideEditableFlag

      public UpdateCommentOperationSpec overrideEditableFlag(@Nullable @Nullable Boolean overrideEditableFlag)
      Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
      Returns:
      this.

    • expand

      public UpdateCommentOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
      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