Package co.elastic.clients.elasticsearch.security

Class GetUserRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetUserRequest.Builder>

co.elastic.clients.elasticsearch.security.GetUserRequest.Builder

All Implemented Interfaces:

WithJson<GetUserRequest.Builder>, ObjectBuilder<GetUserRequest>

Enclosing class:

GetUserRequest

public static class GetUserRequest.Builder
extends RequestBase.AbstractBuilder<GetUserRequest.Builder>
implements ObjectBuilder<GetUserRequest>

Builder for GetUserRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetUserRequest	build()	Builds a GetUserRequest.
protected GetUserRequest.Builder	self()
final GetUserRequest.Builder	username(String value, String... values)	An identifier for the user.
final GetUserRequest.Builder	username(List<String> list)	An identifier for the user.
final GetUserRequest.Builder	withProfileUid(Boolean value)	Determines whether to retrieve the user profile UID, if it exists, for the users.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

username

public final GetUserRequest.Builder username(List<String> list)

An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.

API name: username

Adds all elements of list to username.

username

public final GetUserRequest.Builder username(String value,
 String... values)

An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.

API name: username

Adds one or more values to username.

withProfileUid

public final GetUserRequest.Builder withProfileUid(@Nullable
 Boolean value)

Determines whether to retrieve the user profile UID, if it exists, for the users.

API name: with_profile_uid

self

protected GetUserRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetUserRequest.Builder>

build

public GetUserRequest build()

Builds a GetUserRequest.

Specified by:

build in interface ObjectBuilder<GetUserRequest>

Throws:

NullPointerException - if some of the required fields are null.