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:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class PutUserRequest
extends RequestBase
implements JsonpSerializable

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 JsonpDeserializer<PutUserRequest>	_DESERIALIZER	Json deserializer for PutUserRequest
static Endpoint<PutUserRequest,PutUserResponse,ElasticsearchError>	ENDPOINT	Endpoint "security.put_user".

Constructor Summary

Constructors

Constructor	Description
PutUserRequest(PutUserRequest.Builder builder)
PutUserRequest(java.util.function.Function<PutUserRequest.Builder,PutUserRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	email()	API name: email
java.lang.Boolean	enabled()	API name: enabled
java.lang.String	fullName()	API name: full_name
java.util.Map<java.lang.String,JsonData>	metadata()	API name: metadata
java.lang.String	password()	API name: password
java.lang.String	passwordHash()	API name: password_hash
jakarta.json.JsonValue	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.
java.util.List<java.lang.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(DelegatingDeserializer<PutUserRequest.Builder> op)
java.lang.String	username()	Required - The username of the User

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutUserRequest> _DESERIALIZER

Json deserializer for PutUserRequest

ENDPOINT

public static final Endpoint<PutUserRequest,PutUserResponse,ElasticsearchError> ENDPOINT

Endpoint "security.put_user".

Constructor Details

PutUserRequest

public PutUserRequest(PutUserRequest.Builder builder)

PutUserRequest

public PutUserRequest(java.util.function.Function<PutUserRequest.Builder,PutUserRequest.Builder> fn)

Method Details

username

public java.lang.String username()

Required - The username of the User

API name: username

refresh

@Nullable
public jakarta.json.JsonValue 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

email

@Nullable
public java.lang.String email()

API name: email

fullName

@Nullable
public java.lang.String fullName()

API name: full_name

metadata

@Nullable
public java.util.Map<java.lang.String,JsonData> metadata()

API name: metadata

password

@Nullable
public java.lang.String password()

API name: password

passwordHash

@Nullable
public java.lang.String passwordHash()

API name: password_hash

roles

@Nullable
public java.util.List<java.lang.String> roles()

API name: roles

enabled

@Nullable
public java.lang.Boolean enabled()

API name: enabled

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(DelegatingDeserializer<PutUserRequest.Builder> op)