Package co.elastic.clients.elasticsearch.security

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

Suggest a user profile.

Get suggestions for user profiles that match specified search criteria.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SuggestUserProfilesRequest.Builder	Builder for SuggestUserProfilesRequest.

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 final JsonpDeserializer<SuggestUserProfilesRequest>	_DESERIALIZER	Json deserializer for SuggestUserProfilesRequest
static final Endpoint<SuggestUserProfilesRequest,SuggestUserProfilesResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.suggest_user_profiles".

Method Summary

Modifier and Type	Method	Description
final List<String>	data()	A comma-separated list of filters for the data field of the profile document.
final Hint	hint()	Extra search criteria to improve relevance of the suggestion result.
final String	name()	A query string used to match name-related fields in user profile documents.
static SuggestUserProfilesRequest	of(Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)
SuggestUserProfilesRequest.Builder	rebuild()
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)
final Long	size()	The 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

public static final JsonpDeserializer<SuggestUserProfilesRequest> _DESERIALIZER

Json deserializer for SuggestUserProfilesRequest

_ENDPOINT

public static final Endpoint<SuggestUserProfilesRequest,SuggestUserProfilesResponse,ErrorResponse> _ENDPOINT

Endpoint "security.suggest_user_profiles".

Method Details

of

public static SuggestUserProfilesRequest of(Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)

data

public final List<String> data()

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

hint

@Nullable
public final Hint 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 aren't excluded from the response as long as the profile matches the name field query.

API name: hint

name

@Nullable
public final String name()

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

@Nullable
public final Long size()

The number of profiles to return.

API name: size

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

rebuild

public SuggestUserProfilesRequest.Builder rebuild()

Returns:

New SuggestUserProfilesRequest.Builder initialized with field values of this instance

setupSuggestUserProfilesRequestDeserializer

protected static void setupSuggestUserProfilesRequestDeserializer(ObjectDeserializer<SuggestUserProfilesRequest.Builder> op)