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 classPutUserRequest.BuilderBuilder 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>_DESERIALIZERJson deserializer forPutUserRequeststatic Endpoint<PutUserRequest,PutUserResponse,ErrorResponse>_ENDPOINTEndpoint "security.put_user". -
Method Summary
Modifier and Type Method Description java.lang.Stringemail()API name:emailjava.lang.Booleanenabled()API name:enabledjava.lang.StringfullName()API name:full_namejava.util.Map<java.lang.String,JsonData>metadata()API name:metadatastatic PutUserRequestof(java.util.function.Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)java.lang.Stringpassword()API name:passwordjava.lang.StringpasswordHash()API name:password_hashRefreshrefresh()Iftrue(the default) then refresh the affected shards to make this operation visible to search, ifwait_forthen wait for a refresh to make this operation visible to search, iffalsethen do nothing with refreshes.java.util.List<java.lang.String>roles()API name:rolesvoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupPutUserRequestDeserializer(ObjectDeserializer<PutUserRequest.Builder> op)java.lang.Stringusername()Required - The username of the UserMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toStringMethods 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_forthen wait for a refresh to make this operation visible to search, iffalsethen 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:
serializein interfaceJsonpSerializable
-
serializeInternal
-
setupPutUserRequestDeserializer
protected static void setupPutUserRequestDeserializer(ObjectDeserializer<PutUserRequest.Builder> op)
-