Package org.elasticsearch.client.security.user.privileges

Class UserIndicesPrivileges

java.lang.Object

org.elasticsearch.client.security.user.privileges.AbstractIndicesPrivileges

org.elasticsearch.client.security.user.privileges.UserIndicesPrivileges

public class UserIndicesPrivileges
extends AbstractIndicesPrivileges

Represents an "index" privilege in the GetUserPrivilegesResponse. This differs from the IndicesPrivileges" object in a Role as it supports an array value for field_security and query. See the API docs

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.client.security.user.privileges.AbstractIndicesPrivileges

AbstractIndicesPrivileges.FieldSecurity

Field Summary

Fields inherited from class org.elasticsearch.client.security.user.privileges.AbstractIndicesPrivileges

allowRestrictedIndices, indices, privileges

Constructor Summary

Constructors

Constructor	Description
UserIndicesPrivileges(java.util.Collection<java.lang.String> indices, java.util.Collection<java.lang.String> privileges, boolean allowRestrictedIndices, java.util.Collection<AbstractIndicesPrivileges.FieldSecurity> fieldSecurity, java.util.Collection<java.lang.String> query)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static UserIndicesPrivileges	fromXContent(XContentParser parser)
java.util.Set<AbstractIndicesPrivileges.FieldSecurity>	getFieldSecurity()
java.util.Set<java.lang.String>	getQueries()
int	hashCode()
boolean	isUsingDocumentLevelSecurity()	If true some documents might not be visible.
boolean	isUsingFieldLevelSecurity()	If true some document fields might not be visible.
java.lang.String	toString()

Methods inherited from class org.elasticsearch.client.security.user.privileges.AbstractIndicesPrivileges

allowRestrictedIndices, getIndices, getPrivileges

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserIndicesPrivileges

public UserIndicesPrivileges(java.util.Collection<java.lang.String> indices,
                             java.util.Collection<java.lang.String> privileges,
                             boolean allowRestrictedIndices,
                             java.util.Collection<AbstractIndicesPrivileges.FieldSecurity> fieldSecurity,
                             java.util.Collection<java.lang.String> query)

Method Detail

fromXContent

public static UserIndicesPrivileges fromXContent(XContentParser parser)
                                          throws java.io.IOException

Throws:

java.io.IOException

getFieldSecurity

public java.util.Set<AbstractIndicesPrivileges.FieldSecurity> getFieldSecurity()

getQueries

public java.util.Set<java.lang.String> getQueries()

isUsingDocumentLevelSecurity

public boolean isUsingDocumentLevelSecurity()

Description copied from class: AbstractIndicesPrivileges

If true some documents might not be visible. Only the documents matching query will be readable.

Specified by:

isUsingDocumentLevelSecurity in class AbstractIndicesPrivileges

isUsingFieldLevelSecurity

public boolean isUsingFieldLevelSecurity()

Description copied from class: AbstractIndicesPrivileges

If true some document fields might not be visible.

Specified by:

isUsingFieldLevelSecurity in class AbstractIndicesPrivileges

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object