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

Class GetFieldsPaginatedOperationSpec

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

Specification for the GetFieldsPaginated operation.

Get fields paginated

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetFieldsPaginatedOperationSpec

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

    • GetFieldsPaginatedOperationSpec

      @Internal public GetFieldsPaginatedOperationSpec(Long startAt, Integer maxResults, List<String> type, Set<String> id, String query, String orderBy, String expand)
      Constructs a validated instance of GetFieldsPaginatedOperationSpec.

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

      Parameters:
      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.
      type - The type of fields to search.
      id - The IDs of the custom fields to return or, where query is specified, filter.
      query - String used to perform a case-insensitive partial match with field names or descriptions.
      orderBy - [Order](#ordering) the results by a field: * contextsCount sorts by the number of contexts related to a field * lastUsed sorts by the date when the value of the field last changed * name sorts by the field name * screensCount sorts by the number of screens related to a field
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * key returns the key for each field * lastUsed returns the date when the value of the field last changed * screensCount returns the number of screens related to a field * contextsCount returns the number of contexts related to a field * isLocked returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) * searcherKey returns the searcher key for each custom field

    • GetFieldsPaginatedOperationSpec

      protected GetFieldsPaginatedOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder builder()

    • 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.

    • type

      @Nullable public @Nullable List<String> type()
      The type of fields to search.

    • id

      @Nullable public @Nullable Set<String> id()
      The IDs of the custom fields to return or, where query is specified, filter.

    • query

      @Nullable public @Nullable String query()
      String used to perform a case-insensitive partial match with field names or descriptions.

    • orderBy

      @Nullable public @Nullable String orderBy()
      [Order](#ordering) the results by a field: * contextsCount sorts by the number of contexts related to a field * lastUsed sorts by the date when the value of the field last changed * name sorts by the field name * screensCount sorts by the number of screens related to a field

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * key returns the key for each field * lastUsed returns the date when the value of the field last changed * screensCount returns the number of screens related to a field * contextsCount returns the number of contexts related to a field * isLocked returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) * searcherKey returns the searcher key for each custom field

    • startAt

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

    • maxResults

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

    • type

      public GetFieldsPaginatedOperationSpec type(@Nullable @Nullable List<String> type)
      The type of fields to search.
      Returns:
      this.

    • id

      public GetFieldsPaginatedOperationSpec id(@Nullable @Nullable Set<String> id)
      The IDs of the custom fields to return or, where query is specified, filter.
      Returns:
      this.

    • query

      public GetFieldsPaginatedOperationSpec query(@Nullable @Nullable String query)
      String used to perform a case-insensitive partial match with field names or descriptions.
      Returns:
      this.

    • orderBy

      public GetFieldsPaginatedOperationSpec orderBy(@Nullable @Nullable String orderBy)
      [Order](#ordering) the results by a field: * contextsCount sorts by the number of contexts related to a field * lastUsed sorts by the date when the value of the field last changed * name sorts by the field name * screensCount sorts by the number of screens related to a field
      Returns:
      this.

    • expand

      public GetFieldsPaginatedOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * key returns the key for each field * lastUsed returns the date when the value of the field last changed * screensCount returns the number of screens related to a field * contextsCount returns the number of contexts related to a field * isLocked returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) * searcherKey returns the searcher key for each custom field
      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