Package co.elastic.clients.elasticsearch.security

Class QueryRoleResponse.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • total

      public final QueryRoleResponse.Builder total(int value)
      Required - The total number of roles found.

      API name: total

    • count

      public final QueryRoleResponse.Builder count(int value)
      Required - The number of roles returned in the response.

      API name: count

    • roles

      public final QueryRoleResponse.Builder roles(List<QueryRole> list)
      Required - A list of roles that match the query. The returned role format is an extension of the role definition format. It adds the transient_metadata.enabled and the _sort fields. transient_metadata.enabled is set to false in case the role is automatically disabled, for example when the role grants privileges that are not allowed by the installed license. _sort is present when the search query sorts on some field. It contains the array of values that have been used for sorting.

      API name: roles

      Adds all elements of list to roles.

    • roles

      public final QueryRoleResponse.Builder roles(QueryRole value, QueryRole... values)
      Required - A list of roles that match the query. The returned role format is an extension of the role definition format. It adds the transient_metadata.enabled and the _sort fields. transient_metadata.enabled is set to false in case the role is automatically disabled, for example when the role grants privileges that are not allowed by the installed license. _sort is present when the search query sorts on some field. It contains the array of values that have been used for sorting.

      API name: roles

      Adds one or more values to roles.

    • roles

      public final QueryRoleResponse.Builder roles(Function<QueryRole.Builder,ObjectBuilder<QueryRole>> fn)
      Required - A list of roles that match the query. The returned role format is an extension of the role definition format. It adds the transient_metadata.enabled and the _sort fields. transient_metadata.enabled is set to false in case the role is automatically disabled, for example when the role grants privileges that are not allowed by the installed license. _sort is present when the search query sorts on some field. It contains the array of values that have been used for sorting.

      API name: roles

      Adds a value to roles using a builder lambda.

    • self

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

    • build

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