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

Class FindUsersOperationSpec.FindUsersOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv3.spec.FindUsersOperationSpec.FindUsersOperationSpecBuilder

Enclosing class:

FindUsersOperationSpec

public static class FindUsersOperationSpec.FindUsersOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
FindUsersOperationSpec.FindUsersOperationSpecBuilder	accountId(@Nullable String accountId)	A query string that is matched exactly against a user accountId.
FindUsersOperationSpec	build()
FindUsersOperationSpec.FindUsersOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
FindUsersOperationSpec.FindUsersOperationSpecBuilder	property(@Nullable String property)	A query string used to search properties.
FindUsersOperationSpec.FindUsersOperationSpecBuilder	query(@Nullable String query)	A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users.
FindUsersOperationSpec.FindUsersOperationSpecBuilder	startAt(@Nullable Integer startAt)	The index of the first item to return in a page of filtered results (page offset).
String	toString()
FindUsersOperationSpec.FindUsersOperationSpecBuilder	username(@Nullable String username)

Methods inherited from class java.lang.Object

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

Method Details

query

public FindUsersOperationSpec.FindUsersOperationSpecBuilder query(@Nullable
 @Nullable String query)

A query string that is matched against user attributes ( 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]*. Required, unless accountId or property is specified.

Returns:

this.

username

public FindUsersOperationSpec.FindUsersOperationSpecBuilder username(@Nullable
 @Nullable String username)

Returns:

this.

accountId

public FindUsersOperationSpec.FindUsersOperationSpecBuilder accountId(@Nullable
 @Nullable String accountId)

A query string that is matched exactly against a user accountId. Required, unless query or property is specified.

Returns:

this.

startAt

public FindUsersOperationSpec.FindUsersOperationSpecBuilder startAt(@Nullable
 @Nullable Integer startAt)

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

Returns:

this.

maxResults

public FindUsersOperationSpec.FindUsersOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Returns:

this.

property

public FindUsersOperationSpec.FindUsersOperationSpecBuilder property(@Nullable
 @Nullable String property)

A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.

Returns:

this.

build

public FindUsersOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object