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

Class GetVisibleIssueFieldOptionsOperationSpec

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

Specification for the GetVisibleIssueFieldOptions operation.

Get visible issue field options

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetVisibleIssueFieldOptionsOperationSpec

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

    • GetVisibleIssueFieldOptionsOperationSpec

      @Internal public GetVisibleIssueFieldOptionsOperationSpec(String fieldKey, Long startAt, Integer maxResults, Long projectId)
      Constructs a validated instance of GetVisibleIssueFieldOptionsOperationSpec.

      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-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
      startAt - The index of the first item to return in a page of results (page offset).
      maxResults - The maximum number of items to return per page.
      projectId - Filters the results to options that are only available in the specified project.

    • GetVisibleIssueFieldOptionsOperationSpec

      protected GetVisibleIssueFieldOptionsOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetVisibleIssueFieldOptionsOperationSpec.GetVisibleIssueFieldOptionsOperationSpecBuilder 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-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

    • startAt

      @Nullable public @Nullable Long startAt()
      The index of the first item to return in a page of results (page offset).

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of items to return per page.

    • projectId

      @Nullable public @Nullable Long projectId()
      Filters the results to options that are only available in the specified project.

    • fieldKey

      public GetVisibleIssueFieldOptionsOperationSpec 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-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"
      Returns:
      this.

    • startAt

      public GetVisibleIssueFieldOptionsOperationSpec startAt(@Nullable @Nullable Long startAt)
      The index of the first item to return in a page of results (page offset).
      Returns:
      this.

    • maxResults

      public GetVisibleIssueFieldOptionsOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      Returns:
      this.

    • projectId

      public GetVisibleIssueFieldOptionsOperationSpec projectId(@Nullable @Nullable Long projectId)
      Filters the results to options that are only available in the specified project.
      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