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

Class GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv3.spec.GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder

Enclosing class:

GetProjectComponentsPaginatedOperationSpec

public static class GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
GetProjectComponentsPaginatedOperationSpec	build()
GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder	componentSource(@Nullable String componentSource)	The source of the components to return.
GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder	orderBy(@Nullable String orderBy)	[Order](#ordering) the results by a field: * description Sorts by the component description.
GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder	projectIdOrKey(@NotNull String projectIdOrKey)	The project ID or project key (case sensitive).
GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder	query(@Nullable String query)	Filter the results using a literal string.
GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder	startAt(@Nullable Long startAt)	The index of the first item to return in a page of results (page offset).
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

projectIdOrKey

public GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder projectIdOrKey(@NotNull
 @NotNull String projectIdOrKey)

The project ID or project key (case sensitive).

Returns:

this.

startAt

public GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder startAt(@Nullable
 @Nullable Long startAt)

The index of the first item to return in a page of results (page offset).

Returns:

this.

maxResults

public GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Returns:

this.

orderBy

public GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder orderBy(@Nullable
 @Nullable String orderBy)

[Order](#ordering) the results by a field: * description Sorts by the component description. * issueCount Sorts by the count of issues associated with the component. * lead Sorts by the user key of the component's project lead. * name Sorts by component name.

Returns:

this.

componentSource

public GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder componentSource(@Nullable
 @Nullable String componentSource)

The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.

Returns:

this.

query

public GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder query(@Nullable
 @Nullable String query)

Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).

Returns:

this.

build

public GetProjectComponentsPaginatedOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object