Package co.elastic.clients.elasticsearch.security

Class UserIndicesPrivileges.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • fieldSecurity

      public final UserIndicesPrivileges.Builder fieldSecurity​(java.util.List<FieldSecurity> list)
      The document fields that the owners of the role have read access to.

      API name: field_security

      Adds all elements of list to fieldSecurity.

    • fieldSecurity

      public final UserIndicesPrivileges.Builder fieldSecurity​(FieldSecurity value, FieldSecurity... values)
      The document fields that the owners of the role have read access to.

      API name: field_security

      Adds one or more values to fieldSecurity.

    • fieldSecurity

      public final UserIndicesPrivileges.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

      Adds a value to fieldSecurity using a builder lambda.

    • names

      public final UserIndicesPrivileges.Builder names​(java.util.List<java.lang.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 UserIndicesPrivileges.Builder names​(java.lang.String value, java.lang.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 UserIndicesPrivileges.Builder privileges​(java.util.List<IndexPrivilege> 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 UserIndicesPrivileges.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 values to privileges.

    • query

      public final UserIndicesPrivileges.Builder query​(java.util.List<Query> list)
      Search queries that define the documents the user has access to. A document within the specified indices must match these queries 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

      Adds all elements of list to query.

    • query

      public final UserIndicesPrivileges.Builder query​(Query value, Query... values)
      Search queries that define the documents the user has access to. A document within the specified indices must match these queries 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

      Adds one or more values to query.

    • query

      public final UserIndicesPrivileges.Builder query​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      Search queries that define the documents the user has access to. A document within the specified indices must match these queries 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

      Adds a value to query using a builder lambda.

    • allowRestrictedIndices

      public final UserIndicesPrivileges.Builder allowRestrictedIndices​(boolean value)
      Required - 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 UserIndicesPrivileges.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<UserIndicesPrivileges.Builder>

    • build

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