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

Class SearchOperationSpec.SearchOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv3.spec.SearchOperationSpec.SearchOperationSpecBuilder

Enclosing class:

SearchOperationSpec

public static class SearchOperationSpec.SearchOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
SearchOperationSpec	build()
SearchOperationSpec.SearchOperationSpecBuilder	expand(@Nullable String expand)	Use [expand](#expansion) to include additional information in the response.
SearchOperationSpec.SearchOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
SearchOperationSpec.SearchOperationSpecBuilder	projectId(@Nullable String projectId)	The project the status is part of or null for global statuses.
SearchOperationSpec.SearchOperationSpecBuilder	searchString(@Nullable String searchString)	Term to match status names against or null to search for all statuses in the search scope.
SearchOperationSpec.SearchOperationSpecBuilder	startAt(@Nullable Long startAt)	The index of the first item to return in a page of results (page offset).
SearchOperationSpec.SearchOperationSpecBuilder	statusCategory(@Nullable String statusCategory)	Category of the status to filter by.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

expand

public SearchOperationSpec.SearchOperationSpecBuilder 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.SearchOperationSpecBuilder projectId(@Nullable
 @Nullable String projectId)

The project the status is part of or null for global statuses.

Returns:

this.

startAt

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

The maximum number of items to return per page.

Returns:

this.

searchString

public SearchOperationSpec.SearchOperationSpecBuilder 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.SearchOperationSpecBuilder statusCategory(@Nullable
 @Nullable String statusCategory)

Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.

Returns:

this.

build

public SearchOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object