Package org.opensearch.client.opensearch.security

Class CreateUserRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<CreateUserRequest.Builder>

org.opensearch.client.opensearch.security.CreateUserRequest.Builder

All Implemented Interfaces:

CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>, MutableBuilder<CreateUserRequest.Builder,CreateUserRequest>, ObjectBuilder<CreateUserRequest>

Enclosing class:

CreateUserRequest

public static class CreateUserRequest.Builder
extends RequestBase.AbstractBuilder<CreateUserRequest.Builder>
implements CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Builder for CreateUserRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CreateUserRequest.Builder	attributes(String key, String value)	API name: attributes
final CreateUserRequest.Builder	attributes(Map<String,String> map)	API name: attributes
final CreateUserRequest.Builder	backendRoles(String value, String... values)	API name: backend_roles
final CreateUserRequest.Builder	backendRoles(List<String> list)	API name: backend_roles
CreateUserRequest	build()	Builds a CreateUserRequest.
CreateUserRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CreateUserRequest.Builder	description(String value)	API name: description
final CreateUserRequest.Builder	hash(String value)	API name: hash
final CreateUserRequest.Builder	hidden(Boolean value)	API name: hidden
final CreateUserRequest.Builder	opendistroSecurityRoles(String value, String... values)	API name: opendistro_security_roles
final CreateUserRequest.Builder	opendistroSecurityRoles(List<String> list)	API name: opendistro_security_roles
final CreateUserRequest.Builder	password(String value)	API name: password
final CreateUserRequest.Builder	reserved(Boolean value)	API name: reserved
protected CreateUserRequest.Builder	self()
final CreateUserRequest.Builder	static_(Boolean value)	API name: static
final CreateUserRequest.Builder	username(String value)	Required - The name of the user to create.

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public CreateUserRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Returns:

a new builder instance.

self

@Nonnull
protected CreateUserRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CreateUserRequest.Builder>

attributes

@Nonnull
public final CreateUserRequest.Builder attributes(Map<String,String> map)

API name: attributes

Adds all elements of map to attributes.

attributes

@Nonnull
public final CreateUserRequest.Builder attributes(String key,
 String value)

API name: attributes

Adds an entry to attributes.

backendRoles

@Nonnull
public final CreateUserRequest.Builder backendRoles(List<String> list)

API name: backend_roles

Adds all elements of list to backendRoles.

backendRoles

@Nonnull
public final CreateUserRequest.Builder backendRoles(String value,
 String... values)

API name: backend_roles

Adds one or more values to backendRoles.

description

@Nonnull
public final CreateUserRequest.Builder description(@Nullable
 String value)

API name: description

hash

@Nonnull
public final CreateUserRequest.Builder hash(@Nullable
 String value)

API name: hash

hidden

@Nonnull
public final CreateUserRequest.Builder hidden(@Nullable
 Boolean value)

API name: hidden

opendistroSecurityRoles

@Nonnull
public final CreateUserRequest.Builder opendistroSecurityRoles(List<String> list)

API name: opendistro_security_roles

Adds all elements of list to opendistroSecurityRoles.

opendistroSecurityRoles

@Nonnull
public final CreateUserRequest.Builder opendistroSecurityRoles(String value,
 String... values)

API name: opendistro_security_roles

Adds one or more values to opendistroSecurityRoles.

password

@Nonnull
public final CreateUserRequest.Builder password(@Nullable
 String value)

API name: password

reserved

@Nonnull
public final CreateUserRequest.Builder reserved(@Nullable
 Boolean value)

API name: reserved

static_

@Nonnull
public final CreateUserRequest.Builder static_(@Nullable
 Boolean value)

API name: static

username

@Nonnull
public final CreateUserRequest.Builder username(String value)

Required - The name of the user to create.

API name: username

build

@Nonnull
public CreateUserRequest build()

Builds a CreateUserRequest.

Specified by:

build in interface ObjectBuilder<CreateUserRequest>

Throws:

NullPointerException - if some of the required fields are null.