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

Class ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv2.spec.ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder

Enclosing class:

ReplaceIssueFieldOptionOperationSpec

public static class ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
ReplaceIssueFieldOptionOperationSpec	build()
ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder	fieldKey(@NotNull String fieldKey)	The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**.
ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder	jql(@Nullable String jql)	A JQL query that specifies the issues to be updated.
ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder	optionId(@NotNull Long optionId)	The ID of the option to be deselected.
ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder	overrideEditableFlag(@Nullable Boolean overrideEditableFlag)	Whether screen security is overridden to enable uneditable fields to be edited.
ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder	overrideScreenSecurity(@Nullable Boolean overrideScreenSecurity)	Whether screen security is overridden to enable hidden fields to be edited.
ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder	replaceWith(@Nullable Long replaceWith)	The ID of the option that will replace the currently selected option.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

fieldKey

public ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder 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-2-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Returns:

this.

optionId

public ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder optionId(@NotNull
 @NotNull Long optionId)

The ID of the option to be deselected.

Returns:

this.

replaceWith

public ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder replaceWith(@Nullable
 @Nullable Long replaceWith)

The ID of the option that will replace the currently selected option.

Returns:

this.

jql

public ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder jql(@Nullable
 @Nullable String jql)

A JQL query that specifies the issues to be updated. For example, *project=10000*.

Returns:

this.

overrideScreenSecurity

public ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder overrideScreenSecurity(@Nullable
 @Nullable Boolean overrideScreenSecurity)

Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.

Returns:

this.

overrideEditableFlag

public ReplaceIssueFieldOptionOperationSpec.ReplaceIssueFieldOptionOperationSpecBuilder overrideEditableFlag(@Nullable
 @Nullable Boolean overrideEditableFlag)

Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Returns:

this.

build

public ReplaceIssueFieldOptionOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object