AbstractIndicesPrivileges (rest-high-level 6.7.2 API)

java.lang.Object
- org.elasticsearch.client.security.user.privileges.AbstractIndicesPrivileges

Direct Known Subclasses:: IndicesPrivileges, UserIndicesPrivileges

public abstract class AbstractIndicesPrivileges
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AbstractIndicesPrivileges.FieldSecurity

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`allowRestrictedIndices`
`protected java.util.Set<java.lang.String>`	`indices`
`protected java.util.Set<java.lang.String>`	`privileges`

Method Summary

Modifier and Type	Method	Description
`boolean`	`allowRestrictedIndices()`	True if the privileges cover restricted internal indices too.
`java.util.Set<java.lang.String>`	`getIndices()`	The indices names covered by the privileges.
`java.util.Set<java.lang.String>`	`getPrivileges()`	The privileges acting over indices.
`abstract boolean`	`isUsingDocumentLevelSecurity()`	If `true` some documents might not be visible.
`abstract boolean`	`isUsingFieldLevelSecurity()`	If `true` some document fields might not be visible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - indices
```
protected final java.util.Set<java.lang.String> indices
```
  - privileges
```
protected final java.util.Set<java.lang.String> privileges
```
  - allowRestrictedIndices
```
protected final boolean allowRestrictedIndices
```
- Method Detail
  - getIndices
```
public java.util.Set<java.lang.String> getIndices()
```
    The indices names covered by the privileges.
  - getPrivileges
```
public java.util.Set<java.lang.String> getPrivileges()
```
    The privileges acting over indices. There is a canonical predefined set of such privileges, but the String datatype allows for flexibility in defining finer grained privileges.
  - allowRestrictedIndices
```
public boolean allowRestrictedIndices()
```
    True if the privileges cover restricted internal indices too. Certain indices are reserved for internal services and should be transparent to ordinary users. For that matter, when granting privileges, you also have to toggle this flag to confirm that all indices, including restricted ones, are in the scope of this permission. By default this is false.
  - isUsingDocumentLevelSecurity
```
public abstract boolean isUsingDocumentLevelSecurity()
```
    If true some documents might not be visible. Only the documents matching query will be readable.
  - isUsingFieldLevelSecurity
```
public abstract boolean isUsingFieldLevelSecurity()
```
    If true some document fields might not be visible.