Package co.elastic.clients.elasticsearch.security

Class SuggestUserProfilesRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • data

      public final SuggestUserProfilesRequest.Builder data(List<String> list)
      A comma-separated list of filters for the data field of the profile document. To return all content use data=*. To return a subset of content, use data=<key> to retrieve content nested under the specified <key>. By default, the API returns no data content. It is an error to specify data as both the query parameter and the request body field.

      API name: data

      Adds all elements of list to data.

    • data

      public final SuggestUserProfilesRequest.Builder data(String value, String... values)
      A comma-separated list of filters for the data field of the profile document. To return all content use data=*. To return a subset of content, use data=<key> to retrieve content nested under the specified <key>. By default, the API returns no data content. It is an error to specify data as both the query parameter and the request body field.

      API name: data

      Adds one or more values to data.

    • hint

      public final SuggestUserProfilesRequest.Builder hint(@Nullable Hint value)
      Extra search criteria to improve relevance of the suggestion result. Profiles matching the spcified hint are ranked higher in the response. Profiles not matching the hint aren't excluded from the response as long as the profile matches the name field query.

      API name: hint

    • hint

      public final SuggestUserProfilesRequest.Builder hint(Function<Hint.Builder,ObjectBuilder<Hint>> fn)
      Extra search criteria to improve relevance of the suggestion result. Profiles matching the spcified hint are ranked higher in the response. Profiles not matching the hint aren't excluded from the response as long as the profile matches the name field query.

      API name: hint

    • name

      public final SuggestUserProfilesRequest.Builder name(@Nullable String value)
      A query string used to match name-related fields in user profile documents. Name-related fields are the user's username, full_name, and email.

      API name: name

    • size

      public final SuggestUserProfilesRequest.Builder size(@Nullable Long value)
      The number of profiles to return.

      API name: size

    • self

      protected SuggestUserProfilesRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<SuggestUserProfilesRequest.Builder>

    • build

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