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 forPutUserRequest
.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 forPutUserRequest
static Endpoint<PutUserRequest,PutUserResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.put_user
". -
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
static PutUserRequest
of(java.util.function.Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)
java.lang.String
password()
API name:password
java.lang.String
passwordHash()
API name:password_hash
Refresh
refresh()
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
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(ObjectDeserializer<PutUserRequest.Builder> op)
java.lang.String
username()
Required - The username of the UserMethods 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
Json deserializer forPutUserRequest
-
_ENDPOINT
Endpoint "security.put_user
".
-
-
Method Details
-
of
public static PutUserRequest of(java.util.function.Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn) -
email
@Nullable public final java.lang.String email()API name:email
-
enabled
@Nullable public final java.lang.Boolean enabled()API name:enabled
-
fullName
@Nullable public final java.lang.String fullName()API name:full_name
-
metadata
API name:metadata
-
password
@Nullable public final java.lang.String password()API name:password
-
passwordHash
@Nullable public final java.lang.String passwordHash()API name:password_hash
-
refresh
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.API name:
refresh
-
roles
public final java.util.List<java.lang.String> roles()API name:roles
-
username
public final java.lang.String username()Required - The username of the UserAPI name:
username
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutUserRequestDeserializer
protected static void setupPutUserRequestDeserializer(ObjectDeserializer<PutUserRequest.Builder> op)
-