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

Class GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv2.spec.GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder

Enclosing class:

GetFieldsPaginatedOperationSpec

public static class GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
GetFieldsPaginatedOperationSpec	build()
GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder	expand(@Nullable String expand)	Use [expand](#expansion) to include additional information in the response.
GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder	id(@Nullable Set<String> id)	The IDs of the custom fields to return or, where query is specified, filter.
GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder	orderBy(@Nullable String orderBy)	[Order](#ordering) the results by a field: * contextsCount sorts by the number of contexts related to a field * lastUsed sorts by the date when the value of the field last changed * name sorts by the field name * screensCount sorts by the number of screens related to a field
GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder	query(@Nullable String query)	String used to perform a case-insensitive partial match with field names or descriptions.
GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder	startAt(@Nullable Long startAt)	The index of the first item to return in a page of results (page offset).
String	toString()
GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder	type(@Nullable List<String> type)	The type of fields to search.

Methods inherited from class java.lang.Object

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

Method Details

startAt

public GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder startAt(@Nullable
 @Nullable Long startAt)

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

Returns:

this.

maxResults

public GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Returns:

this.

type

public GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder type(@Nullable
 @Nullable List<String> type)

The type of fields to search.

Returns:

this.

id

public GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder id(@Nullable
 @Nullable Set<String> id)

The IDs of the custom fields to return or, where query is specified, filter.

Returns:

this.

query

public GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder query(@Nullable
 @Nullable String query)

String used to perform a case-insensitive partial match with field names or descriptions.

Returns:

this.

orderBy

public GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder orderBy(@Nullable
 @Nullable String orderBy)

[Order](#ordering) the results by a field: * contextsCount sorts by the number of contexts related to a field * lastUsed sorts by the date when the value of the field last changed * name sorts by the field name * screensCount sorts by the number of screens related to a field

Returns:

this.

expand

public GetFieldsPaginatedOperationSpec.GetFieldsPaginatedOperationSpecBuilder 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: * key returns the key for each field * lastUsed returns the date when the value of the field last changed * screensCount returns the number of screens related to a field * contextsCount returns the number of contexts related to a field * isLocked returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) * searcherKey returns the searcher key for each custom field

Returns:

this.

build

public GetFieldsPaginatedOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object