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 Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description SuggestUserProfilesRequest
build()
Builds aSuggestUserProfilesRequest
.SuggestUserProfilesRequest.Builder
data(java.lang.String value, java.lang.String... values)
List of filters for thedata
field of the profile document.SuggestUserProfilesRequest.Builder
data(java.util.List<java.lang.String> list)
List of filters for thedata
field of the profile document.SuggestUserProfilesRequest.Builder
hint(Hint value)
Extra search criteria to improve relevance of the suggestion result.SuggestUserProfilesRequest.Builder
hint(java.util.function.Function<Hint.Builder,ObjectBuilder<Hint>> fn)
Extra search criteria to improve relevance of the suggestion result.SuggestUserProfilesRequest.Builder
name(java.lang.String value)
Query string used to match name-related fields in user profile documents.protected SuggestUserProfilesRequest.Builder
self()
SuggestUserProfilesRequest.Builder
size(java.lang.Long value)
Number of profiles to return.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
data
List of filters for thedata
field of the profile document. To return all content usedata=*
. To return a subset of content usedata=<key>
to retrieve content nested under the specified<key>
. By default returns nodata
content.API name:
data
Adds all elements of
list
todata
. -
data
public final SuggestUserProfilesRequest.Builder data(java.lang.String value, java.lang.String... values)List of filters for thedata
field of the profile document. To return all content usedata=*
. To return a subset of content usedata=<key>
to retrieve content nested under the specified<key>
. By default returns nodata
content.API name:
data
Adds one or more values to
data
. -
hint
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 don't exclude the profile from the response as long as the profile matches thename
field query.API name:
hint
-
hint
public final SuggestUserProfilesRequest.Builder hint(java.util.function.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 don't exclude the profile from the response as long as the profile matches thename
field query.API name:
hint
-
name
Query string used to match name-related fields in user profile documents. Name-related fields are the user'susername
,full_name
, andemail
.API name:
name
-
size
Number of profiles to return.API name:
size
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<SuggestUserProfilesRequest.Builder>
-
build
Builds aSuggestUserProfilesRequest
.- Specified by:
build
in interfaceObjectBuilder<SuggestUserProfilesRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-