Package co.elastic.clients.elasticsearch.security

Class DisableUserRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.DisableUserRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class DisableUserRequest
extends RequestBase

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

Constructor Summary

Constructors

Constructor	Description
DisableUserRequest(DisableUserRequest.Builder builder)
DisableUserRequest(java.util.function.Function<DisableUserRequest.Builder,DisableUserRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
jakarta.json.JsonValue	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.
java.lang.String	username()	The username of the user to disable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENDPOINT

public static final Endpoint<DisableUserRequest,DisableUserResponse,ElasticsearchError> ENDPOINT

Endpoint "security.disable_user".

Constructor Details

DisableUserRequest

public DisableUserRequest(DisableUserRequest.Builder builder)

DisableUserRequest

public DisableUserRequest(java.util.function.Function<DisableUserRequest.Builder,DisableUserRequest.Builder> fn)

Method Details

username

public java.lang.String username()

The username of the user to disable

API name: username

refresh

@Nullable
public jakarta.json.JsonValue 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