Package co.elastic.clients.elasticsearch.security

Class DisableUserProfileRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.DisableUserProfileRequest

public class DisableUserProfileRequest
extends RequestBase

Disable a user profile.

Disable user profiles so that they are not visible in user profile searches.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DisableUserProfileRequest,DisableUserProfileResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.disable_user_profile".

Method Summary

Modifier and Type	Method	Description
static DisableUserProfileRequest	of(Function<DisableUserProfileRequest.Builder,ObjectBuilder<DisableUserProfileRequest>> fn)
final Refresh	refresh()	If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search, if 'wait_for' then wait for a refresh to make this operation visible to search, if 'false' do nothing with refreshes.
final String	uid()	Required - 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<DisableUserProfileRequest,DisableUserProfileResponse,ErrorResponse> _ENDPOINT

Endpoint "security.disable_user_profile".

Method Details

of

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

refresh

@Nullable
public final Refresh refresh()

If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search, if 'wait_for' then wait for a refresh to make this operation visible to search, if 'false' do nothing with refreshes.

API name: refresh

uid

public final String uid()

Required - Unique identifier for the user profile.

API name: uid