Package co.elastic.clients.elasticsearch.security

Class IndicesPrivileges.Builder

java.lang.Object
co.elastic.clients.elasticsearch.security.IndicesPrivileges.Builder
All Implemented Interfaces:
ObjectBuilder<IndicesPrivileges>
Enclosing class:
IndicesPrivileges
public static class IndicesPrivileges.Builder
extends java.lang.Object
implements ObjectBuilder<IndicesPrivileges>
Builder for IndicesPrivileges.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • fieldSecurity

      public IndicesPrivileges.Builder fieldSecurity​(@Nullable FieldSecurity value)
      The document fields that the owners of the role have read access to.

      API name: field_security

    • fieldSecurity

      public 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

      public IndicesPrivileges.Builder names​(java.util.List<java.lang.String> value)
      Required - A list of indices (or index name patterns) to which the permissions in this entry apply.

      API name: names

    • names

      public IndicesPrivileges.Builder names​(java.lang.String... value)
      Required - A list of indices (or index name patterns) to which the permissions in this entry apply.

      API name: names

    • addNames

      public IndicesPrivileges.Builder addNames​(java.lang.String value)
      Add a value to names(List), creating the list if needed.

    • privileges

      public IndicesPrivileges.Builder privileges​(java.util.List<IndexPrivilege> value)
      Required - The index level privileges that owners of the role have on the specified indices.

      API name: privileges

    • privileges

      public IndicesPrivileges.Builder privileges​(IndexPrivilege... value)
      Required - The index level privileges that owners of the role have on the specified indices.

      API name: privileges

    • addPrivileges

      public IndicesPrivileges.Builder addPrivileges​(IndexPrivilege value)
      Add a value to privileges(List), creating the list if needed.

    • query

      public IndicesPrivileges.Builder query​(@Nullable Query value)
      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

    • query

      public IndicesPrivileges.Builder query​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      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

    • allowRestrictedIndices

      public IndicesPrivileges.Builder allowRestrictedIndices​(@Nullable java.lang.Boolean value)
      Set to true 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 the names list, Elasticsearch checks privileges against these indices regardless of the value set for allow_restricted_indices.

      API name: allow_restricted_indices

    • build

      public IndicesPrivileges build()
      Builds a IndicesPrivileges.
      Specified by:
      build in interface ObjectBuilder<IndicesPrivileges>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.