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

Class AbstractIndicesPrivileges.FieldSecurity

java.lang.Object
org.elasticsearch.client.security.user.privileges.AbstractIndicesPrivileges.FieldSecurity
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
Enclosing class:
AbstractIndicesPrivileges
public static class AbstractIndicesPrivileges.FieldSecurity
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    java.util.Set<java.lang.String> getDeniedFields()
    The document fields that cannot be accessed or queried.
    java.util.Set<java.lang.String> getGrantedFields()
    The document fields that can be read or queried.
    int hashCode()  
    boolean isUsingFieldLevelSecurity()  
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

  • Method Details

    • getGrantedFields

      public java.util.Set<java.lang.String> getGrantedFields()
      The document fields that can be read or queried. Can be null, in this case all the document's fields are granted access to. Can also be empty, in which case no fields are granted access to.

    • getDeniedFields

      public java.util.Set<java.lang.String> getDeniedFields()
      The document fields that cannot be accessed or queried. Can be null or empty, in which case no fields are denied.

    • isUsingFieldLevelSecurity

      public boolean isUsingFieldLevelSecurity()

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • 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