Package co.elastic.clients.elasticsearch.security

Class EnableUserProfileRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.EnableUserProfileRequest

public class EnableUserProfileRequest
extends RequestBase

Enable a user profile.

Enable user profiles to make them visible in user profile searches.

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.

When you activate a user profile, it's automatically enabled and visible in user profile searches. If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<EnableUserProfileRequest,EnableUserProfileResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.enable_user_profile".

Method Summary

Modifier and Type	Method	Description
static EnableUserProfileRequest	of(Function<EnableUserProfileRequest.Builder,ObjectBuilder<EnableUserProfileRequest>> fn)
final Refresh	refresh()	If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
final 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<EnableUserProfileRequest,EnableUserProfileResponse,ErrorResponse> _ENDPOINT

Endpoint "security.enable_user_profile".

Method Details

of

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

refresh

@Nullable
public final Refresh refresh()

If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes.

API name: refresh

uid

public final String uid()

Required - A unique identifier for the user profile.

API name: uid