Class IndicesPrivileges.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.security.IndicesPrivileges.Builder
- All Implemented Interfaces:
ObjectBuilder<IndicesPrivileges>
- Enclosing class:
- IndicesPrivileges
public static class IndicesPrivileges.Builder extends ObjectBuilderBase implements ObjectBuilder<IndicesPrivileges>
Builder for
IndicesPrivileges
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description IndicesPrivileges.Builder
allowRestrictedIndices(java.lang.Boolean value)
Set totrue
if using wildcard or regular expressions for patterns that cover restricted indices.IndicesPrivileges
build()
Builds aIndicesPrivileges
.IndicesPrivileges.Builder
fieldSecurity(FieldSecurity value)
The document fields that the owners of the role have read access to.IndicesPrivileges.Builder
fieldSecurity(java.util.function.Function<FieldSecurity.Builder,ObjectBuilder<FieldSecurity>> fn)
The document fields that the owners of the role have read access to.IndicesPrivileges.Builder
names(java.lang.String value, java.lang.String... values)
Required - A list of indices (or index name patterns) to which the permissions in this entry apply.IndicesPrivileges.Builder
names(java.util.List<java.lang.String> list)
Required - A list of indices (or index name patterns) to which the permissions in this entry apply.IndicesPrivileges.Builder
privileges(IndexPrivilege value, IndexPrivilege... values)
Required - The index level privileges that owners of the role have on the specified indices.IndicesPrivileges.Builder
privileges(java.util.List<IndexPrivilege> list)
Required - The index level privileges that owners of the role have on the specified indices.IndicesPrivileges.Builder
query(java.lang.String value, java.lang.String... values)
A search query that defines the documents the owners of the role have read access to.IndicesPrivileges.Builder
query(java.util.List<java.lang.String> list)
A search query that defines the documents the owners of the role have read access to.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
fieldSecurity
The document fields that the owners of the role have read access to.API name:
field_security
-
fieldSecurity
public final IndicesPrivileges.Builder fieldSecurity(java.util.function.Function<FieldSecurity.Builder,ObjectBuilder<FieldSecurity>> fn)The document fields that the owners of the role have read access to.API name:
field_security
-
names
Required - A list of indices (or index name patterns) to which the permissions in this entry apply.API name:
names
Adds all elements of
list
tonames
. -
names
Required - A list of indices (or index name patterns) to which the permissions in this entry apply.API name:
names
Adds one or more values to
names
. -
privileges
Required - The index level privileges that owners of the role have on the specified indices.API name:
privileges
Adds all elements of
list
toprivileges
. -
privileges
Required - The index level privileges that owners of the role have on the specified indices.API name:
privileges
Adds one or more values to
privileges
. -
query
A search query that defines the documents the owners of the role have read access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.API name:
query
Adds all elements of
list
toquery
. -
query
A search query that defines the documents the owners of the role have read access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.API name:
query
Adds one or more values to
query
. -
allowRestrictedIndices
Set totrue
if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in thenames
list, Elasticsearch checks privileges against these indices regardless of the value set forallow_restricted_indices
.API name:
allow_restricted_indices
-
build
Builds aIndicesPrivileges
.- Specified by:
build
in interfaceObjectBuilder<IndicesPrivileges>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-