Package org.opensearch.client.opensearch.security

Class CreateRoleMappingRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.security.CreateRoleMappingRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CreateRoleMappingRequest

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

Builder for CreateRoleMappingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CreateRoleMappingRequest.Builder	andBackendRoles(String value, String... values)	API name: and_backend_roles
final CreateRoleMappingRequest.Builder	andBackendRoles(List<String> list)	API name: and_backend_roles
final CreateRoleMappingRequest.Builder	backendRoles(String value, String... values)	API name: backend_roles
final CreateRoleMappingRequest.Builder	backendRoles(List<String> list)	API name: backend_roles
CreateRoleMappingRequest	build()	Builds a CreateRoleMappingRequest.
CreateRoleMappingRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CreateRoleMappingRequest.Builder	description(String value)	API name: description
final CreateRoleMappingRequest.Builder	hidden(Boolean value)	API name: hidden
final CreateRoleMappingRequest.Builder	hosts(String value, String... values)	API name: hosts
final CreateRoleMappingRequest.Builder	hosts(List<String> list)	API name: hosts
final CreateRoleMappingRequest.Builder	reserved(Boolean value)	API name: reserved
final CreateRoleMappingRequest.Builder	role(String value)	Required - The name of the role for which to create a role mapping.
protected CreateRoleMappingRequest.Builder	self()
final CreateRoleMappingRequest.Builder	users(String value, String... values)	API name: users
final CreateRoleMappingRequest.Builder	users(List<String> list)	API name: users

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 CreateRoleMappingRequest.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<CreateRoleMappingRequest.Builder,CreateRoleMappingRequest>

Returns:

a new builder instance.

self

@Nonnull
protected CreateRoleMappingRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CreateRoleMappingRequest.Builder>

andBackendRoles

@Nonnull
public final CreateRoleMappingRequest.Builder andBackendRoles(List<String> list)

API name: and_backend_roles

Adds all elements of list to andBackendRoles.

andBackendRoles

@Nonnull
public final CreateRoleMappingRequest.Builder andBackendRoles(String value,
 String... values)

API name: and_backend_roles

Adds one or more values to andBackendRoles.

backendRoles

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

API name: backend_roles

Adds all elements of list to backendRoles.

backendRoles

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

API name: backend_roles

Adds one or more values to backendRoles.

description

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

API name: description

hidden

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

API name: hidden

hosts

@Nonnull
public final CreateRoleMappingRequest.Builder hosts(List<String> list)

API name: hosts

Adds all elements of list to hosts.

hosts

@Nonnull
public final CreateRoleMappingRequest.Builder hosts(String value,
 String... values)

API name: hosts

Adds one or more values to hosts.

reserved

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

API name: reserved

role

@Nonnull
public final CreateRoleMappingRequest.Builder role(String value)

Required - The name of the role for which to create a role mapping.

API name: role

users

@Nonnull
public final CreateRoleMappingRequest.Builder users(List<String> list)

API name: users

Adds all elements of list to users.

users

@Nonnull
public final CreateRoleMappingRequest.Builder users(String value,
 String... values)

API name: users

Adds one or more values to users.

build

@Nonnull
public CreateRoleMappingRequest build()

Builds a CreateRoleMappingRequest.

Specified by:

build in interface ObjectBuilder<CreateRoleMappingRequest>

Throws:

NullPointerException - if some of the required fields are null.