Package co.elastic.clients.elasticsearch.watcher

Class UpdateSettingsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.watcher.UpdateSettingsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateSettingsRequest
extends RequestBase
implements JsonpSerializable

Update Watcher index settings. Update settings for the Watcher internal index (.watches). Only a subset of settings can be modified. This includes index.auto_expand_replicas, index.number_of_replicas, index.routing.allocation.exclude.*, index.routing.allocation.include.* and index.routing.allocation.require.*. Modification of index.routing.allocation.include._tier_preference is an exception and is not allowed as the Watcher shards must always be in the data_content tier.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<UpdateSettingsRequest>	_DESERIALIZER	Json deserializer for UpdateSettingsRequest
static final Endpoint<UpdateSettingsRequest,UpdateSettingsResponse,ErrorResponse>	_ENDPOINT	Endpoint "watcher.update_settings".

Method Summary

Modifier and Type	Method	Description
final String	indexAutoExpandReplicas()	API name: index.auto_expand_replicas
final Integer	indexNumberOfReplicas()	API name: index.number_of_replicas
final Time	masterTimeout()	The period to wait for a connection to the master node.
static UpdateSettingsRequest	of(Function<UpdateSettingsRequest.Builder,ObjectBuilder<UpdateSettingsRequest>> fn)
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	setupUpdateSettingsRequestDeserializer(ObjectDeserializer<UpdateSettingsRequest.Builder> op)
final Time	timeout()	The 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<UpdateSettingsRequest> _DESERIALIZER

Json deserializer for UpdateSettingsRequest

_ENDPOINT

public static final Endpoint<UpdateSettingsRequest,UpdateSettingsResponse,ErrorResponse> _ENDPOINT

Endpoint "watcher.update_settings".

Method Details

of

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

indexAutoExpandReplicas

@Nullable
public final String indexAutoExpandReplicas()

API name: index.auto_expand_replicas

indexNumberOfReplicas

@Nullable
public final Integer indexNumberOfReplicas()

API name: index.number_of_replicas

masterTimeout

@Nullable
public final Time masterTimeout()

The 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

timeout

@Nullable
public final Time timeout()

The 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)

setupUpdateSettingsRequestDeserializer

protected static void setupUpdateSettingsRequestDeserializer(ObjectDeserializer<UpdateSettingsRequest.Builder> op)