Package org.elasticsearch.client.security

Class PutUserRequest

java.lang.Object

org.elasticsearch.client.security.PutUserRequest

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public final class PutUserRequest
extends java.lang.Object
implements Validatable, ToXContentObject

Request object to create or update a user in the native realm.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PutUserRequest(java.lang.String username, char[] password, java.util.List<java.lang.String> roles, java.lang.String fullName, java.lang.String email, boolean enabled, java.util.Map<java.lang.String,java.lang.Object> metadata, RefreshPolicy refreshPolicy)	Creates a new request that is used to create or update a user in the native realm.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getEmail()
java.lang.String	getFullName()
java.util.Map<java.lang.String,java.lang.Object>	getMetadata()
char[]	getPassword()
RefreshPolicy	getRefreshPolicy()
java.util.List<java.lang.String>	getRoles()
java.lang.String	getUsername()
int	hashCode()
boolean	isEnabled()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.util.Optional<ValidationException>	validate()	Perform validation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

PutUserRequest

public PutUserRequest(java.lang.String username,
                      char[] password,
                      java.util.List<java.lang.String> roles,
                      java.lang.String fullName,
                      java.lang.String email,
                      boolean enabled,
                      java.util.Map<java.lang.String,java.lang.Object> metadata,
                      RefreshPolicy refreshPolicy)

Creates a new request that is used to create or update a user in the native realm.

Parameters:

username - the username of the user to be created or updated

password - the password of the user. The password array is not modified by this class. It is the responsibility of the caller to clear the password after receiving a response.

roles - the roles that this user is assigned

fullName - the full name of the user that may be used for display purposes

email - the email address of the user

enabled - true if the user is enabled and allowed to access elasticsearch

metadata - a map of additional user attributes that may be used in templating roles

refreshPolicy - the refresh policy for the request.

Method Detail

getUsername

public java.lang.String getUsername()

getRoles

public java.util.List<java.lang.String> getRoles()

getFullName

public java.lang.String getFullName()

getEmail

public java.lang.String getEmail()

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

getPassword

public char[] getPassword()

isEnabled

public boolean isEnabled()

getRefreshPolicy

public RefreshPolicy getRefreshPolicy()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

validate

public java.util.Optional<ValidationException> validate()

Description copied from interface: Validatable

Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.

Specified by:

validate in interface Validatable

Returns:

An Optional ValidationException that contains a list of validation errors.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException