Package org.opensearch.client.opensearch.security

Class Role.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.security.Role.Builder

All Implemented Interfaces:

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

Enclosing class:

Role

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

Builder for Role.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Role	build()	Builds a Role.
final Role.Builder	clusterPermissions(String value, String... values)	API name: cluster_permissions
final Role.Builder	clusterPermissions(List<String> list)	API name: cluster_permissions
Role.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Role.Builder	description(String value)	API name: description
final Role.Builder	hidden(Boolean value)	API name: hidden
final Role.Builder	indexPermissions(Function<IndexPermission.Builder,ObjectBuilder<IndexPermission>> fn)	API name: index_permissions
final Role.Builder	indexPermissions(List<IndexPermission> list)	API name: index_permissions
final Role.Builder	indexPermissions(IndexPermission value, IndexPermission... values)	API name: index_permissions
final Role.Builder	reserved(Boolean value)	API name: reserved
final Role.Builder	static_(Boolean value)	API name: static
final Role.Builder	tenantPermissions(Function<TenantPermission.Builder,ObjectBuilder<TenantPermission>> fn)	API name: tenant_permissions
final Role.Builder	tenantPermissions(List<TenantPermission> list)	API name: tenant_permissions
final Role.Builder	tenantPermissions(TenantPermission value, TenantPermission... values)	API name: tenant_permissions

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

Returns:

a new builder instance.

clusterPermissions

@Nonnull
public final Role.Builder clusterPermissions(List<String> list)

API name: cluster_permissions

Adds all elements of list to clusterPermissions.

clusterPermissions

@Nonnull
public final Role.Builder clusterPermissions(String value,
 String... values)

API name: cluster_permissions

Adds one or more values to clusterPermissions.

description

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

API name: description

hidden

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

API name: hidden

indexPermissions

@Nonnull
public final Role.Builder indexPermissions(List<IndexPermission> list)

API name: index_permissions

Adds all elements of list to indexPermissions.

indexPermissions

@Nonnull
public final Role.Builder indexPermissions(IndexPermission value,
 IndexPermission... values)

API name: index_permissions

Adds one or more values to indexPermissions.

indexPermissions

@Nonnull
public final Role.Builder indexPermissions(Function<IndexPermission.Builder,ObjectBuilder<IndexPermission>> fn)

API name: index_permissions

Adds a value to indexPermissions using a builder lambda.

reserved

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

API name: reserved

static_

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

API name: static

tenantPermissions

@Nonnull
public final Role.Builder tenantPermissions(List<TenantPermission> list)

API name: tenant_permissions

Adds all elements of list to tenantPermissions.

tenantPermissions

@Nonnull
public final Role.Builder tenantPermissions(TenantPermission value,
 TenantPermission... values)

API name: tenant_permissions

Adds one or more values to tenantPermissions.

tenantPermissions

@Nonnull
public final Role.Builder tenantPermissions(Function<TenantPermission.Builder,ObjectBuilder<TenantPermission>> fn)

API name: tenant_permissions

Adds a value to tenantPermissions using a builder lambda.

build

@Nonnull
public Role build()

Builds a Role.

Specified by:

build in interface ObjectBuilder<Role>

Throws:

NullPointerException - if some of the required fields are null.