Package co.elastic.clients.elasticsearch.security

Class PutUserRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.security.PutUserRequest.Builder

All Implemented Interfaces:

WithJson<PutUserRequest.Builder>, ObjectBuilder<PutUserRequest>

Enclosing class:

PutUserRequest

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

Builder for PutUserRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutUserRequest	build()	Builds a PutUserRequest.
final PutUserRequest.Builder	email(String value)	API name: email
final PutUserRequest.Builder	enabled(Boolean value)	API name: enabled
final PutUserRequest.Builder	fullName(String value)	API name: full_name
final PutUserRequest.Builder	metadata(String key, JsonData value)	API name: metadata
final PutUserRequest.Builder	metadata(Map<String,JsonData> map)	API name: metadata
final PutUserRequest.Builder	password(String value)	API name: password
final PutUserRequest.Builder	passwordHash(String value)	API name: password_hash
final PutUserRequest.Builder	refresh(Refresh value)	If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.
final PutUserRequest.Builder	roles(String value, String... values)	API name: roles
final PutUserRequest.Builder	roles(List<String> list)	API name: roles
protected PutUserRequest.Builder	self()
final PutUserRequest.Builder	username(String value)	Required - The username of the User

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

email

public final PutUserRequest.Builder email(@Nullable
 String value)

API name: email

enabled

public final PutUserRequest.Builder enabled(@Nullable
 Boolean value)

API name: enabled

fullName

public final PutUserRequest.Builder fullName(@Nullable
 String value)

API name: full_name

metadata

public final PutUserRequest.Builder metadata(Map<String,JsonData> map)

API name: metadata

Adds all entries of map to metadata.

metadata

public final PutUserRequest.Builder metadata(String key,
 JsonData value)

API name: metadata

Adds an entry to metadata.

password

public final PutUserRequest.Builder password(@Nullable
 String value)

API name: password

passwordHash

public final PutUserRequest.Builder passwordHash(@Nullable
 String value)

API name: password_hash

refresh

public final PutUserRequest.Builder refresh(@Nullable
 Refresh value)

If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

API name: refresh

roles

public final PutUserRequest.Builder roles(List<String> list)

API name: roles

Adds all elements of list to roles.

roles

public final PutUserRequest.Builder roles(String value,
 String... values)

API name: roles

Adds one or more values to roles.

username

public final PutUserRequest.Builder username(String value)

Required - The username of the User

API name: username

self

protected PutUserRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutUserRequest.Builder>

build

public PutUserRequest build()

Builds a PutUserRequest.

Specified by:

build in interface ObjectBuilder<PutUserRequest>

Throws:

NullPointerException - if some of the required fields are null.