Package org.opensearch.client.opensearch.security

Class IndexPermission.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.security.IndexPermission.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexPermission

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

Builder for IndexPermission.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexPermission.Builder	allowedActions(String value, String... values)	API name: allowed_actions
final IndexPermission.Builder	allowedActions(List<String> list)	API name: allowed_actions
IndexPermission	build()	Builds a IndexPermission.
IndexPermission.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexPermission.Builder	dls(String value)	API name: dls
final IndexPermission.Builder	fls(String value, String... values)	API name: fls
final IndexPermission.Builder	fls(List<String> list)	API name: fls
final IndexPermission.Builder	indexPatterns(String value, String... values)	API name: index_patterns
final IndexPermission.Builder	indexPatterns(List<String> list)	API name: index_patterns
final IndexPermission.Builder	maskedFields(String value, String... values)	API name: masked_fields
final IndexPermission.Builder	maskedFields(List<String> list)	API name: masked_fields

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

Returns:

a new builder instance.

allowedActions

@Nonnull
public final IndexPermission.Builder allowedActions(List<String> list)

API name: allowed_actions

Adds all elements of list to allowedActions.

allowedActions

@Nonnull
public final IndexPermission.Builder allowedActions(String value,
 String... values)

API name: allowed_actions

Adds one or more values to allowedActions.

dls

@Nonnull
public final IndexPermission.Builder dls(@Nullable
 String value)

API name: dls

fls

@Nonnull
public final IndexPermission.Builder fls(List<String> list)

API name: fls

Adds all elements of list to fls.

fls

@Nonnull
public final IndexPermission.Builder fls(String value,
 String... values)

API name: fls

Adds one or more values to fls.

indexPatterns

@Nonnull
public final IndexPermission.Builder indexPatterns(List<String> list)

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

@Nonnull
public final IndexPermission.Builder indexPatterns(String value,
 String... values)

API name: index_patterns

Adds one or more values to indexPatterns.

maskedFields

@Nonnull
public final IndexPermission.Builder maskedFields(List<String> list)

API name: masked_fields

Adds all elements of list to maskedFields.

maskedFields

@Nonnull
public final IndexPermission.Builder maskedFields(String value,
 String... values)

API name: masked_fields

Adds one or more values to maskedFields.

build

@Nonnull
public IndexPermission build()

Builds a IndexPermission.

Specified by:

build in interface ObjectBuilder<IndexPermission>

Throws:

NullPointerException - if some of the required fields are null.