Package org.opensearch.client.opensearch.security

Class CreateUserRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.CreateUserRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CreateUserRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Creates or replaces the specified user.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CreateUserRequest>	_DESERIALIZER	Json deserializer for CreateUserRequest
static final Endpoint<CreateUserRequest,CreateUserResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.create_user".

Method Summary

Modifier and Type	Method	Description
final Map<String,String>	attributes()	API name: attributes
final List<String>	backendRoles()	API name: backend_roles
static CreateUserRequest.Builder	builder()
final String	description()	API name: description
boolean	equals(Object o)
final String	hash()	API name: hash
int	hashCode()
final Boolean	hidden()	API name: hidden
static CreateUserRequest	of(Function<CreateUserRequest.Builder,ObjectBuilder<CreateUserRequest>> fn)
final List<String>	opendistroSecurityRoles()	API name: opendistro_security_roles
final String	password()	API name: password
final Boolean	reserved()	API name: reserved
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	setupCreateUserRequestDeserializer(ObjectDeserializer<CreateUserRequest.Builder> op)
final Boolean	static_()	API name: static
CreateUserRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	username()	Required - The name of the user to create.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CreateUserRequest> _DESERIALIZER

Json deserializer for CreateUserRequest

_ENDPOINT

public static final Endpoint<CreateUserRequest,CreateUserResponse,ErrorResponse> _ENDPOINT

Endpoint "security.create_user".

Method Details

of

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

attributes

@Nonnull
public final Map<String,String> attributes()

API name: attributes

backendRoles

@Nonnull
public final List<String> backendRoles()

API name: backend_roles

description

@Nullable
public final String description()

API name: description

hash

@Nullable
public final String hash()

API name: hash

hidden

@Nullable
public final Boolean hidden()

API name: hidden

opendistroSecurityRoles

@Nonnull
public final List<String> opendistroSecurityRoles()

API name: opendistro_security_roles

password

@Nullable
public final String password()

API name: password

reserved

@Nullable
public final Boolean reserved()

API name: reserved

static_

@Nullable
public final Boolean static_()

API name: static

username

@Nonnull
public final String username()

Required - The name of the user to create.

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)

toBuilder

@Nonnull
public CreateUserRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CreateUserRequest.Builder builder()

setupCreateUserRequestDeserializer

protected static void setupCreateUserRequestDeserializer(ObjectDeserializer<CreateUserRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object