Package co.elastic.clients.elasticsearch.security.has_privileges

Class IndexPrivilegesCheck.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<IndexPrivilegesCheck.Builder>

co.elastic.clients.elasticsearch.security.has_privileges.IndexPrivilegesCheck.Builder

All Implemented Interfaces:

WithJson<IndexPrivilegesCheck.Builder>, ObjectBuilder<IndexPrivilegesCheck>

Enclosing class:

IndexPrivilegesCheck

public static class IndexPrivilegesCheck.Builder
extends WithJsonObjectBuilderBase<IndexPrivilegesCheck.Builder>
implements ObjectBuilder<IndexPrivilegesCheck>

Builder for IndexPrivilegesCheck.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexPrivilegesCheck.Builder	allowRestrictedIndices(Boolean value)	This needs to be set to true (default is false) if using wildcards or regexps for patterns that cover restricted indices.
IndexPrivilegesCheck	build()	Builds a IndexPrivilegesCheck.
final IndexPrivilegesCheck.Builder	names(String value, String... values)	Required - A list of indices.
final IndexPrivilegesCheck.Builder	names(List<String> list)	Required - A list of indices.
final IndexPrivilegesCheck.Builder	privileges(IndexPrivilege value, IndexPrivilege... values)	Required - A list of the privileges that you want to check for the specified indices.
final IndexPrivilegesCheck.Builder	privileges(String value, String... values)	Required - A list of the privileges that you want to check for the specified indices.
final IndexPrivilegesCheck.Builder	privileges(List<String> list)	Required - A list of the privileges that you want to check for the specified indices.
protected IndexPrivilegesCheck.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

names

public final IndexPrivilegesCheck.Builder names(List<String> list)

Required - A list of indices.

API name: names

Adds all elements of list to names.

names

public final IndexPrivilegesCheck.Builder names(String value,
 String... values)

Required - A list of indices.

API name: names

Adds one or more values to names.

privileges

public final IndexPrivilegesCheck.Builder privileges(List<String> list)

Required - A list of the privileges that you want to check for the specified indices.

API name: privileges

Adds all elements of list to privileges.

privileges

public final IndexPrivilegesCheck.Builder privileges(String value,
 String... values)

Required - A list of the privileges that you want to check for the specified indices.

API name: privileges

Adds one or more values to privileges.

privileges

public final IndexPrivilegesCheck.Builder privileges(IndexPrivilege value,
 IndexPrivilege... values)

Required - A list of the privileges that you want to check for the specified indices.

API name: privileges

Adds one or more enum values to privileges.

allowRestrictedIndices

public final IndexPrivilegesCheck.Builder allowRestrictedIndices(@Nullable
 Boolean value)

This needs to be set to true (default is false) if using wildcards or regexps for patterns that cover restricted indices. Implicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false. If restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of allow_restricted_indices.

API name: allow_restricted_indices

self

protected IndexPrivilegesCheck.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<IndexPrivilegesCheck.Builder>

build

public IndexPrivilegesCheck build()

Builds a IndexPrivilegesCheck.

Specified by:

build in interface ObjectBuilder<IndexPrivilegesCheck>

Throws:

NullPointerException - if some of the required fields are null.