Package co.elastic.clients.elasticsearch.security

Class GetUserProfileRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GetUserProfileRequest

public class GetUserProfileRequest
extends RequestBase

Retrieves a user's profile using the unique profile ID.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 Endpoint<GetUserProfileRequest,GetUserProfileResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_user_profile".

Method Summary

Modifier and Type	Method	Description
final List<String>	data()	List of filters for the data field of the profile document.
static GetUserProfileRequest	of(Function<GetUserProfileRequest.Builder,ObjectBuilder<GetUserProfileRequest>> fn)
final List<String>	uid()	Required - A unique identifier for the user profile.

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

_ENDPOINT

public static final Endpoint<GetUserProfileRequest,GetUserProfileResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_user_profile".

Method Details

of

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

data

public final List<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

uid

public final List<String> uid()

Required - A unique identifier for the user profile.

API name: uid