Package co.elastic.clients.elasticsearch.security

Class GetSecuritySettingsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GetSecuritySettingsRequest

public class GetSecuritySettingsRequest
extends RequestBase

Get security index settings.

Get the user-configurable settings for the security internal index (.security and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes:

• index.auto_expand_replicas
• index.number_of_replicas

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetSecuritySettingsRequest,GetSecuritySettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_settings".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	Period to wait for a connection to the master node.
static GetSecuritySettingsRequest	of(Function<GetSecuritySettingsRequest.Builder,ObjectBuilder<GetSecuritySettingsRequest>> fn)

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<GetSecuritySettingsRequest,GetSecuritySettingsResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_settings".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout