Package org.opensearch.client.opensearch.security

Class CreateRoleRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.security.CreateRoleRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CreateRoleRequest

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

Builder for CreateRoleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

Returns:

a new builder instance.

self

@Nonnull
protected CreateRoleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CreateRoleRequest.Builder>

clusterPermissions

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

API name: cluster_permissions

Adds all elements of list to clusterPermissions.

clusterPermissions

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

API name: cluster_permissions

Adds one or more values to clusterPermissions.

description

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

API name: description

hidden

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

API name: hidden

indexPermissions

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

API name: index_permissions

Adds all elements of list to indexPermissions.

indexPermissions

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

API name: index_permissions

Adds one or more values to indexPermissions.

indexPermissions

@Nonnull
public final CreateRoleRequest.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 CreateRoleRequest.Builder reserved(@Nullable
 Boolean value)

API name: reserved

role

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

Required - The name of the role to create.

API name: role

static_

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

API name: static

tenantPermissions

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

API name: tenant_permissions

Adds all elements of list to tenantPermissions.

tenantPermissions

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

API name: tenant_permissions

Adds one or more values to tenantPermissions.

tenantPermissions

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

API name: tenant_permissions

Adds a value to tenantPermissions using a builder lambda.

build

@Nonnull
public CreateRoleRequest build()

Builds a CreateRoleRequest.

Specified by:

build in interface ObjectBuilder<CreateRoleRequest>

Throws:

NullPointerException - if some of the required fields are null.