Package co.elastic.clients.elasticsearch.security

Class DisableUserRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.DisableUserRequest

public class DisableUserRequest
extends RequestBase

Disable users.

Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DisableUserRequest,DisableUserResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.disable_user".

Method Summary

Modifier and Type	Method	Description
static DisableUserRequest	of(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)
final Refresh	refresh()	If true (the default) then refresh 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 then do nothing with refreshes.
final String	username()	Required - An identifier for the user.

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<DisableUserRequest,DisableUserResponse,ErrorResponse> _ENDPOINT

Endpoint "security.disable_user".

Method Details

of

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

refresh

@Nullable
public final Refresh refresh()

If true (the default) then refresh 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 then do nothing with refreshes.

API name: refresh

username

public final String username()

Required - An identifier for the user.

API name: username