Package org.opensearch.client.opensearch.cluster

Class PutDecommissionAwarenessRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.PutDecommissionAwarenessRequest

All Implemented Interfaces:

ToCopyableBuilder<PutDecommissionAwarenessRequest.Builder,PutDecommissionAwarenessRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class PutDecommissionAwarenessRequest
extends RequestBase
implements ToCopyableBuilder<PutDecommissionAwarenessRequest.Builder,PutDecommissionAwarenessRequest>

Decommissions a cluster zone based on awareness. This can greatly benefit multi-zone deployments, where awareness attributes can aid in applying new upgrades to a cluster in a controlled fashion.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<PutDecommissionAwarenessRequest,PutDecommissionAwarenessResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.put_decommission_awareness".

Method Summary

Modifier and Type	Method	Description
final String	awarenessAttributeName()	Required - The name of the awareness attribute.
final String	awarenessAttributeValue()	Required - The value of the awareness attribute.
static PutDecommissionAwarenessRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static PutDecommissionAwarenessRequest	of(Function<PutDecommissionAwarenessRequest.Builder,ObjectBuilder<PutDecommissionAwarenessRequest>> fn)
PutDecommissionAwarenessRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<PutDecommissionAwarenessRequest,PutDecommissionAwarenessResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.put_decommission_awareness".

Method Details

of

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

awarenessAttributeName

@Nonnull
public final String awarenessAttributeName()

Required - The name of the awareness attribute.

API name: awareness_attribute_name

awarenessAttributeValue

@Nonnull
public final String awarenessAttributeValue()

Required - The value of the awareness attribute. For example, if you have shards allocated in two different zones, you can give each zone a value of zone-a or zoneb. The cluster decommission operation decommissions the zone listed in the method.

API name: awareness_attribute_value

toBuilder

@Nonnull
public PutDecommissionAwarenessRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutDecommissionAwarenessRequest.Builder,PutDecommissionAwarenessRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PutDecommissionAwarenessRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object