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

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 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 JsonpDeserializer<SuggestUserProfilesRequest>	_DESERIALIZER	Json deserializer for SuggestUserProfilesRequest
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 the data field of the profile document.
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

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(java.util.function.Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)

data

public final java.util.List<java.lang.String> data()

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 returns no data content.

API name: data

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's username, full_name, and email.

API name: name

size

@Nullable
public final java.lang.Long size()

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)

setupSuggestUserProfilesRequestDeserializer

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