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

Class FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv2.spec.FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder

Enclosing class:

FindUsersForPickerOperationSpec

public static class FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder	avatarSize(@Nullable String avatarSize)
FindUsersForPickerOperationSpec	build()
FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder	exclude(@Nullable List<String> exclude)	This parameter is no longer available.
FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder	excludeAccountIds(@Nullable List<String> excludeAccountIds)	A list of account IDs to exclude from the search results.
FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder	excludeConnectUsers(@Nullable Boolean excludeConnectUsers)
FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return.
FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder	query(@NotNull String query)	A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users.
FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder	showAvatar(@Nullable Boolean showAvatar)	Include the URI to the user's avatar.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

query

public FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder query(@NotNull
 @NotNull String query)

A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*.

Returns:

this.

maxResults

public FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return. The total number of matched users is returned in total.

Returns:

this.

showAvatar

public FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder showAvatar(@Nullable
 @Nullable Boolean showAvatar)

Include the URI to the user's avatar.

Returns:

this.

exclude

public FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder exclude(@Nullable
 @Nullable List<String> exclude)

This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.

Returns:

this.

excludeAccountIds

public FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder excludeAccountIds(@Nullable
 @Nullable List<String> excludeAccountIds)

A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude.

Returns:

this.

avatarSize

public FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder avatarSize(@Nullable
 @Nullable String avatarSize)

Returns:

this.

excludeConnectUsers

public FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder excludeConnectUsers(@Nullable
 @Nullable Boolean excludeConnectUsers)

Returns:

this.

build

public FindUsersForPickerOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object