Package co.elastic.clients.elasticsearch.security

Class PutUserRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.PutUserRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutUserRequest
extends RequestBase
implements JsonpSerializable

Adds and updates users in the native realm. These users are commonly referred to as native users.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutUserRequest.Builder	Builder for PutUserRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PutUserRequest>	_DESERIALIZER	Json deserializer for PutUserRequest
static final Endpoint<PutUserRequest,PutUserResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.put_user".

Method Summary

Modifier and Type	Method	Description
final String	email()	API name: email
final Boolean	enabled()	API name: enabled
final String	fullName()	API name: full_name
final Map<String,JsonData>	metadata()	API name: metadata
static PutUserRequest	of(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)
final String	password()	API name: password
final String	passwordHash()	API name: password_hash
final Refresh	refresh()	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 List<String>	roles()	API name: roles
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPutUserRequestDeserializer(ObjectDeserializer<PutUserRequest.Builder> op)
final String	username()	Required - The username of the User

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutUserRequest> _DESERIALIZER

Json deserializer for PutUserRequest

_ENDPOINT

public static final Endpoint<PutUserRequest,PutUserResponse,ErrorResponse> _ENDPOINT

Endpoint "security.put_user".

Method Details

of

public static PutUserRequest of(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)

email

@Nullable
public final String email()

API name: email

enabled

@Nullable
public final Boolean enabled()

API name: enabled

fullName

@Nullable
public final String fullName()

API name: full_name

metadata

public final Map<String,JsonData> metadata()

API name: metadata

password

@Nullable
public final String password()

API name: password

passwordHash

@Nullable
public final String passwordHash()

API name: password_hash

refresh

@Nullable
public final Refresh refresh()

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 List<String> roles()

API name: roles

username

public final String username()

Required - The username of the User

API name: username

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupPutUserRequestDeserializer

protected static void setupPutUserRequestDeserializer(ObjectDeserializer<PutUserRequest.Builder> op)