Package co.elastic.clients.elasticsearch.security

Class IndicesPrivileges.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • fieldSecurity

      public final 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 final IndicesPrivileges.Builder fieldSecurity(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 final IndicesPrivileges.Builder names(List<String> list)
      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 to names.

    • names

      public final IndicesPrivileges.Builder names(String value, String... values)
      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

      public final IndicesPrivileges.Builder privileges(List<String> list)
      Required - The index level privileges that owners of the role have on the specified indices.

      API name: privileges

      Adds all elements of list to privileges.

    • privileges

      public final IndicesPrivileges.Builder privileges(String value, String... values)
      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.

    • privileges

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

      API name: privileges

      Adds one or more enum values to privileges.

    • query

      public final IndicesPrivileges.Builder query(@Nullable Query value)
      A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. Use a custom query of type ("template", RoleTemplateScript) for templated queries

      API name: query

    • query

      public final IndicesPrivileges.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)
      A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. Use a custom query of type ("template", RoleTemplateScript) for templated queries

      API name: query

    • query

      public final IndicesPrivileges.Builder query(QueryVariant value)
      A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. Use a custom query of type ("template", RoleTemplateScript) for templated queries

      API name: query

    • allowRestrictedIndices

      public final IndicesPrivileges.Builder allowRestrictedIndices(@Nullable 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

    • self

      protected IndicesPrivileges.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<IndicesPrivileges.Builder>

    • build

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