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

Class GetWorkflowsPaginatedOperationSpec

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

Specification for the GetWorkflowsPaginated operation.

Get workflows paginated

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetWorkflowsPaginatedOperationSpec

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

    • GetWorkflowsPaginatedOperationSpec

      @Internal public GetWorkflowsPaginatedOperationSpec(Long startAt, Integer maxResults, Set<String> workflowName, String expand, String queryString, String orderBy, Boolean isActive)
      Constructs a validated instance of GetWorkflowsPaginatedOperationSpec.

      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.
      workflowName - The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, workflowName=name1&amp;workflowName=name2.
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * transitions For each workflow, returns information about the transitions inside the workflow. * transitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. * transitions.properties For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested. * statuses For each workflow, returns information about the statuses inside the workflow. * statuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. * default For each workflow, returns information about whether this is the default workflow. * schemes For each workflow, returns information about the workflow schemes the workflow is assigned to. * projects For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes. * hasDraftWorkflow For each workflow, returns information about whether the workflow has a draft version. * operations For each workflow, returns information about the actions that can be undertaken on the workflow.
      queryString - String used to perform a case-insensitive partial match with workflow name.
      orderBy - [Order](#ordering) the results by a field: * name Sorts by workflow name. * created Sorts by create time. * updated Sorts by update time.
      isActive - Filters active and inactive workflows.

    • GetWorkflowsPaginatedOperationSpec

      protected GetWorkflowsPaginatedOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder 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.

    • workflowName

      @Nullable public @Nullable Set<String> workflowName()
      The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, workflowName=name1&amp;workflowName=name2.

    • 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: * transitions For each workflow, returns information about the transitions inside the workflow. * transitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. * transitions.properties For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested. * statuses For each workflow, returns information about the statuses inside the workflow. * statuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. * default For each workflow, returns information about whether this is the default workflow. * schemes For each workflow, returns information about the workflow schemes the workflow is assigned to. * projects For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes. * hasDraftWorkflow For each workflow, returns information about whether the workflow has a draft version. * operations For each workflow, returns information about the actions that can be undertaken on the workflow.

    • queryString

      @Nullable public @Nullable String queryString()
      String used to perform a case-insensitive partial match with workflow name.

    • orderBy

      @Nullable public @Nullable String orderBy()
      [Order](#ordering) the results by a field: * name Sorts by workflow name. * created Sorts by create time. * updated Sorts by update time.

    • isActive

      @Nullable public @Nullable Boolean isActive()
      Filters active and inactive workflows.

    • startAt

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

    • maxResults

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

    • workflowName

      public GetWorkflowsPaginatedOperationSpec workflowName(@Nullable @Nullable Set<String> workflowName)
      The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, workflowName=name1&amp;workflowName=name2.
      Returns:
      this.

    • expand

      public GetWorkflowsPaginatedOperationSpec 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: * transitions For each workflow, returns information about the transitions inside the workflow. * transitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. * transitions.properties For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested. * statuses For each workflow, returns information about the statuses inside the workflow. * statuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. * default For each workflow, returns information about whether this is the default workflow. * schemes For each workflow, returns information about the workflow schemes the workflow is assigned to. * projects For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes. * hasDraftWorkflow For each workflow, returns information about whether the workflow has a draft version. * operations For each workflow, returns information about the actions that can be undertaken on the workflow.
      Returns:
      this.

    • queryString

      public GetWorkflowsPaginatedOperationSpec queryString(@Nullable @Nullable String queryString)
      String used to perform a case-insensitive partial match with workflow name.
      Returns:
      this.

    • orderBy

      public GetWorkflowsPaginatedOperationSpec orderBy(@Nullable @Nullable String orderBy)
      [Order](#ordering) the results by a field: * name Sorts by workflow name. * created Sorts by create time. * updated Sorts by update time.
      Returns:
      this.

    • isActive

      public GetWorkflowsPaginatedOperationSpec isActive(@Nullable @Nullable Boolean isActive)
      Filters active and inactive workflows.
      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