Class SuggestUserProfilesRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.SuggestUserProfilesRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class SuggestUserProfilesRequest extends RequestBase implements JsonpSerializable
Get suggestions for user profiles that match specified search criteria.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SuggestUserProfilesRequest.Builder
Builder forSuggestUserProfilesRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<SuggestUserProfilesRequest>
_DESERIALIZER
Json deserializer forSuggestUserProfilesRequest
static Endpoint<SuggestUserProfilesRequest,SuggestUserProfilesResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.suggest_user_profiles
". -
Method Summary
Modifier and Type Method Description java.util.List<java.lang.String>
data()
List of filters for thedata
field of the profile document.Hint
hint()
Extra search criteria to improve relevance of the suggestion result.java.lang.String
name()
Query string used to match name-related fields in user profile documents.static SuggestUserProfilesRequest
of(java.util.function.Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)
void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupSuggestUserProfilesRequestDeserializer(ObjectDeserializer<SuggestUserProfilesRequest.Builder> op)
java.lang.Long
size()
Number of profiles to return.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forSuggestUserProfilesRequest
-
_ENDPOINT
public static final Endpoint<SuggestUserProfilesRequest,SuggestUserProfilesResponse,ErrorResponse> _ENDPOINTEndpoint "security.suggest_user_profiles
".
-
-
Method Details
-
of
public static SuggestUserProfilesRequest of(java.util.function.Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn) -
data
public final java.util.List<java.lang.String> 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
-
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
-
name
@Nullable public final java.lang.String 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
@Nullable public final java.lang.Long size()Number of profiles to return.API name:
size
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSuggestUserProfilesRequestDeserializer
protected static void setupSuggestUserProfilesRequestDeserializer(ObjectDeserializer<SuggestUserProfilesRequest.Builder> op)
-