Package co.elastic.clients.elasticsearch.security

Class ClearCachedRealmsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.ClearCachedRealmsRequest

public class ClearCachedRealmsRequest
extends RequestBase

Clear the user cache.

Evict users from the user cache. You can completely clear the cache or evict specific users.

User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. There are realm settings that you can use to configure the user cache. For more information, refer to the documentation about controlling the user cache.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<ClearCachedRealmsRequest,ClearCachedRealmsResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.clear_cached_realms".

Method Summary

Modifier and Type	Method	Description
static ClearCachedRealmsRequest	of(Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)
final List<String>	realms()	Required - A comma-separated list of realms.
final List<String>	usernames()	A comma-separated list of the users to clear from the cache.

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<ClearCachedRealmsRequest,ClearCachedRealmsResponse,ErrorResponse> _ENDPOINT

Endpoint "security.clear_cached_realms".

Method Details

of

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

realms

public final List<String> realms()

Required - A comma-separated list of realms. To clear all realms, use an asterisk (*). It does not support other wildcard patterns.

API name: realms

usernames

public final List<String> usernames()

A comma-separated list of the users to clear from the cache. If you do not specify this parameter, the API evicts all users from the user cache.

API name: usernames