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

Class SearchOperationSpec

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

Specification for the Search operation.

Search statuses paginated

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • SearchOperationSpec

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

    • SearchOperationSpec

      @Internal public SearchOperationSpec(String expand, String projectId, Long startAt, Integer maxResults, String searchString, String statusCategory)
      Constructs a validated instance of SearchOperationSpec.

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

      Parameters:
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * usages Returns the project and issue types that use the status in their workflow. * workflowUsages Returns the workflows that use the status.
      projectId - The project the status is part of or null for global statuses.
      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.
      searchString - Term to match status names against or null to search for all statuses in the search scope.
      statusCategory - Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.

    • SearchOperationSpec

      protected SearchOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static SearchOperationSpec.SearchOperationSpecBuilder builder()

    • 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: * usages Returns the project and issue types that use the status in their workflow. * workflowUsages Returns the workflows that use the status.

    • projectId

      @Nullable public @Nullable String projectId()
      The project the status is part of or null for global statuses.

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

    • searchString

      @Nullable public @Nullable String searchString()
      Term to match status names against or null to search for all statuses in the search scope.

    • statusCategory

      @Nullable public @Nullable String statusCategory()
      Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.

    • expand

      public SearchOperationSpec 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: * usages Returns the project and issue types that use the status in their workflow. * workflowUsages Returns the workflows that use the status.
      Returns:
      this.

    • projectId

      public SearchOperationSpec projectId(@Nullable @Nullable String projectId)
      The project the status is part of or null for global statuses.
      Returns:
      this.

    • startAt

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

    • maxResults

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

    • searchString

      public SearchOperationSpec searchString(@Nullable @Nullable String searchString)
      Term to match status names against or null to search for all statuses in the search scope.
      Returns:
      this.

    • statusCategory

      public SearchOperationSpec statusCategory(@Nullable @Nullable String statusCategory)
      Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.
      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