Package org.opensearch.client.opensearch.security

Class RoleMapping.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.security.RoleMapping.Builder

All Implemented Interfaces:

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

Enclosing class:

RoleMapping

public static class RoleMapping.Builder
extends ObjectBuilderBase
implements CopyableBuilder<RoleMapping.Builder,RoleMapping>

Builder for RoleMapping.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RoleMapping.Builder	andBackendRoles(String value, String... values)	API name: and_backend_roles
final RoleMapping.Builder	andBackendRoles(List<String> list)	API name: and_backend_roles
final RoleMapping.Builder	backendRoles(String value, String... values)	API name: backend_roles
final RoleMapping.Builder	backendRoles(List<String> list)	API name: backend_roles
RoleMapping	build()	Builds a RoleMapping.
RoleMapping.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RoleMapping.Builder	description(String value)	API name: description
final RoleMapping.Builder	hidden(Boolean value)	API name: hidden
final RoleMapping.Builder	hosts(String value, String... values)	API name: hosts
final RoleMapping.Builder	hosts(List<String> list)	API name: hosts
final RoleMapping.Builder	reserved(Boolean value)	API name: reserved
final RoleMapping.Builder	users(String value, String... values)	API name: users
final RoleMapping.Builder	users(List<String> list)	API name: users

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

Returns:

a new builder instance.

andBackendRoles

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

API name: and_backend_roles

Adds all elements of list to andBackendRoles.

andBackendRoles

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

API name: and_backend_roles

Adds one or more values to andBackendRoles.

backendRoles

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

API name: backend_roles

Adds all elements of list to backendRoles.

backendRoles

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

API name: backend_roles

Adds one or more values to backendRoles.

description

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

API name: description

hidden

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

API name: hidden

hosts

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

API name: hosts

Adds all elements of list to hosts.

hosts

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

API name: hosts

Adds one or more values to hosts.

reserved

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

API name: reserved

users

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

API name: users

Adds all elements of list to users.

users

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

API name: users

Adds one or more values to users.

build

@Nonnull
public RoleMapping build()

Builds a RoleMapping.

Specified by:

build in interface ObjectBuilder<RoleMapping>

Throws:

NullPointerException - if some of the required fields are null.