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

Class GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv3.spec.GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder

Enclosing class:

GetSelectableIssueFieldOptionsOperationSpec

public static class GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
GetSelectableIssueFieldOptionsOperationSpec	build()
GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder	fieldKey(@NotNull String fieldKey)	The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**.
GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder	projectId(@Nullable Long projectId)	Filters the results to options that are only available in the specified project.
GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder	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

fieldKey

public GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder fieldKey(@NotNull
 @NotNull String fieldKey)

The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Returns:

this.

startAt

public GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder startAt(@Nullable
 @Nullable Long startAt)

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

Returns:

this.

maxResults

public GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Returns:

this.

projectId

public GetSelectableIssueFieldOptionsOperationSpec.GetSelectableIssueFieldOptionsOperationSpecBuilder projectId(@Nullable
 @Nullable Long projectId)

Filters the results to options that are only available in the specified project.

Returns:

this.

build

public GetSelectableIssueFieldOptionsOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object