Package co.elastic.clients.elasticsearch.nodes

Class ReloadSecureSettingsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.nodes.ReloadSecureSettingsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ReloadSecureSettingsRequest
extends RequestBase
implements JsonpSerializable

Reload the keystore on nodes in the cluster.

Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.

When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<ReloadSecureSettingsRequest>	_DESERIALIZER	Json deserializer for ReloadSecureSettingsRequest
static final Endpoint<ReloadSecureSettingsRequest,ReloadSecureSettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "nodes.reload_secure_settings".

Method Summary

Modifier and Type	Method	Description
final List<String>	nodeId()	The names of particular nodes in the cluster to target.
static ReloadSecureSettingsRequest	of(Function<ReloadSecureSettingsRequest.Builder,ObjectBuilder<ReloadSecureSettingsRequest>> fn)
final String	secureSettingsPassword()	The password for the Elasticsearch keystore.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupReloadSecureSettingsRequestDeserializer(ObjectDeserializer<ReloadSecureSettingsRequest.Builder> op)
final Time	timeout()	Period to wait for a response.

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

_DESERIALIZER

public static final JsonpDeserializer<ReloadSecureSettingsRequest> _DESERIALIZER

Json deserializer for ReloadSecureSettingsRequest

_ENDPOINT

public static final Endpoint<ReloadSecureSettingsRequest,ReloadSecureSettingsResponse,ErrorResponse> _ENDPOINT

Endpoint "nodes.reload_secure_settings".

Method Details

of

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

nodeId

public final List<String> nodeId()

The names of particular nodes in the cluster to target.

API name: node_id

secureSettingsPassword

@Nullable
public final String secureSettingsPassword()

The password for the Elasticsearch keystore.

API name: secure_settings_password

timeout

@Nullable
public final Time timeout()

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

API name: timeout

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupReloadSecureSettingsRequestDeserializer

protected static void setupReloadSecureSettingsRequestDeserializer(ObjectDeserializer<ReloadSecureSettingsRequest.Builder> op)