Package io.github.primelib.jira4j.restv2.spec

Class ReplaceIssueFieldOptionOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv2.spec.ReplaceIssueFieldOptionOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class ReplaceIssueFieldOptionOperationSpec extends Object
ReplaceIssueFieldOptionSpec

Specification for the ReplaceIssueFieldOption operation.

Replace issue field option

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • ReplaceIssueFieldOptionOperationSpec

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

    • ReplaceIssueFieldOptionOperationSpec

      @Internal public ReplaceIssueFieldOptionOperationSpec(String fieldKey, Long optionId, Long replaceWith, String jql, Boolean overrideScreenSecurity, Boolean overrideEditableFlag)
      Constructs a validated instance of ReplaceIssueFieldOptionOperationSpec.

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

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-2-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
      optionId - The ID of the option to be deselected.
      replaceWith - The ID of the option that will replace the currently selected option.
      jql - A JQL query that specifies the issues to be updated. For example, *project=10000*.
      overrideScreenSecurity - Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.
      overrideEditableFlag - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

    • ReplaceIssueFieldOptionOperationSpec

      protected ReplaceIssueFieldOptionOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder builder()

    • fieldKey

      @NotNull public @NotNull String fieldKey()
      The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-2-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

    • optionId

      @NotNull public @NotNull Long optionId()
      The ID of the option to be deselected.

    • replaceWith

      @Nullable public @Nullable Long replaceWith()
      The ID of the option that will replace the currently selected option.

    • jql

      @Nullable public @Nullable String jql()
      A JQL query that specifies the issues to be updated. For example, *project=10000*.

    • overrideScreenSecurity

      @Nullable public @Nullable Boolean overrideScreenSecurity()
      Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.

    • overrideEditableFlag

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

    • fieldKey

      public ReplaceIssueFieldOptionOperationSpec fieldKey(@NotNull @NotNull String fieldKey)
      The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-2-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
      Returns:
      this.

    • optionId

      public ReplaceIssueFieldOptionOperationSpec optionId(@NotNull @NotNull Long optionId)
      The ID of the option to be deselected.
      Returns:
      this.

    • replaceWith

      public ReplaceIssueFieldOptionOperationSpec replaceWith(@Nullable @Nullable Long replaceWith)
      The ID of the option that will replace the currently selected option.
      Returns:
      this.

    • jql

      public ReplaceIssueFieldOptionOperationSpec jql(@Nullable @Nullable String jql)
      A JQL query that specifies the issues to be updated. For example, *project=10000*.
      Returns:
      this.

    • overrideScreenSecurity

      public ReplaceIssueFieldOptionOperationSpec overrideScreenSecurity(@Nullable @Nullable Boolean overrideScreenSecurity)
      Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.
      Returns:
      this.

    • overrideEditableFlag

      public ReplaceIssueFieldOptionOperationSpec overrideEditableFlag(@Nullable @Nullable Boolean overrideEditableFlag)
      Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
      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