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

Class EditIssueOperationSpec

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

Specification for the EditIssue operation.

Edit issue

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • EditIssueOperationSpec

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

    • EditIssueOperationSpec

      @Internal public EditIssueOperationSpec(String issueIdOrKey, IssueUpdateDetails issueUpdateDetails, Boolean notifyUsers, Boolean overrideScreenSecurity, Boolean overrideEditableFlag, Boolean returnIssue, String expand)
      Constructs a validated instance of EditIssueOperationSpec.

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

      Parameters:
      issueIdOrKey - The ID or key of the issue.
      issueUpdateDetails -
      notifyUsers - Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.
      overrideScreenSecurity - Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with *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).
      overrideEditableFlag - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with *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).
      returnIssue - Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get).
      expand - The Get issue API expand parameter to use in the response if the returnIssue parameter is true.

    • EditIssueOperationSpec

      protected EditIssueOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static EditIssueOperationSpec.EditIssueOperationSpecBuilder builder()

    • issueIdOrKey

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

    • issueUpdateDetails

      @NotNull public @NotNull IssueUpdateDetails issueUpdateDetails()

    • notifyUsers

      @Nullable public @Nullable Boolean notifyUsers()
      Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.

    • overrideScreenSecurity

      @Nullable public @Nullable Boolean overrideScreenSecurity()
      Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with *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).

    • overrideEditableFlag

      @Nullable public @Nullable Boolean overrideEditableFlag()
      Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with *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).

    • returnIssue

      @Nullable public @Nullable Boolean returnIssue()
      Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get).

    • expand

      @Nullable public @Nullable String expand()
      The Get issue API expand parameter to use in the response if the returnIssue parameter is true.

    • issueIdOrKey

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

    • issueUpdateDetails

      public EditIssueOperationSpec issueUpdateDetails(@NotNull @NotNull IssueUpdateDetails issueUpdateDetails)
      Returns:
      this.

    • notifyUsers

      public EditIssueOperationSpec notifyUsers(@Nullable @Nullable Boolean notifyUsers)
      Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.
      Returns:
      this.

    • overrideScreenSecurity

      public EditIssueOperationSpec overrideScreenSecurity(@Nullable @Nullable Boolean overrideScreenSecurity)
      Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with *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.

    • overrideEditableFlag

      public EditIssueOperationSpec overrideEditableFlag(@Nullable @Nullable Boolean overrideEditableFlag)
      Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with *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.

    • returnIssue

      public EditIssueOperationSpec returnIssue(@Nullable @Nullable Boolean returnIssue)
      Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get).
      Returns:
      this.

    • expand

      public EditIssueOperationSpec expand(@Nullable @Nullable String expand)
      The Get issue API expand parameter to use in the response if the returnIssue parameter is true.
      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