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

Class GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv2.spec.GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder

Enclosing class:

GetWorkflowsPaginatedOperationSpec

public static class GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
GetWorkflowsPaginatedOperationSpec	build()
GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder	expand(@Nullable String expand)	Use [expand](#expansion) to include additional information in the response.
GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder	isActive(@Nullable Boolean isActive)	Filters active and inactive workflows.
GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder	orderBy(@Nullable String orderBy)	[Order](#ordering) the results by a field: * name Sorts by workflow name.
GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder	queryString(@Nullable String queryString)	String used to perform a case-insensitive partial match with workflow name.
GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder	startAt(@Nullable Long startAt)	The index of the first item to return in a page of results (page offset).
String	toString()
GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder	workflowName(@Nullable Set<String> workflowName)	The name of a workflow to return.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

startAt

public GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder 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.GetWorkflowsPaginatedOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Returns:

this.

workflowName

public GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder 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&workflowName=name2.

Returns:

this.

expand

public GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder 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.GetWorkflowsPaginatedOperationSpecBuilder queryString(@Nullable
 @Nullable String queryString)

String used to perform a case-insensitive partial match with workflow name.

Returns:

this.

orderBy

public GetWorkflowsPaginatedOperationSpec.GetWorkflowsPaginatedOperationSpecBuilder 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.GetWorkflowsPaginatedOperationSpecBuilder isActive(@Nullable
 @Nullable Boolean isActive)

Filters active and inactive workflows.

Returns:

this.

build

public GetWorkflowsPaginatedOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object