Package org.opensearch.client.opensearch.cluster

Class PutDecommissionAwarenessRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<PutDecommissionAwarenessRequest.Builder>

org.opensearch.client.opensearch.cluster.PutDecommissionAwarenessRequest.Builder

All Implemented Interfaces:

CopyableBuilder<PutDecommissionAwarenessRequest.Builder,PutDecommissionAwarenessRequest>, MutableBuilder<PutDecommissionAwarenessRequest.Builder,PutDecommissionAwarenessRequest>, ObjectBuilder<PutDecommissionAwarenessRequest>

Enclosing class:

PutDecommissionAwarenessRequest

public static class PutDecommissionAwarenessRequest.Builder
extends RequestBase.AbstractBuilder<PutDecommissionAwarenessRequest.Builder>
implements CopyableBuilder<PutDecommissionAwarenessRequest.Builder,PutDecommissionAwarenessRequest>

Builder for PutDecommissionAwarenessRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutDecommissionAwarenessRequest.Builder	awarenessAttributeName(String value)	Required - The name of the awareness attribute.
final PutDecommissionAwarenessRequest.Builder	awarenessAttributeValue(String value)	Required - The value of the awareness attribute.
PutDecommissionAwarenessRequest	build()	Builds a PutDecommissionAwarenessRequest.
PutDecommissionAwarenessRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected PutDecommissionAwarenessRequest.Builder	self()

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public PutDecommissionAwarenessRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<PutDecommissionAwarenessRequest.Builder,PutDecommissionAwarenessRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutDecommissionAwarenessRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutDecommissionAwarenessRequest.Builder>

awarenessAttributeName

@Nonnull
public final PutDecommissionAwarenessRequest.Builder awarenessAttributeName(String value)

Required - The name of the awareness attribute.

API name: awareness_attribute_name

awarenessAttributeValue

@Nonnull
public final PutDecommissionAwarenessRequest.Builder awarenessAttributeValue(String value)

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

build

@Nonnull
public PutDecommissionAwarenessRequest build()

Builds a PutDecommissionAwarenessRequest.

Specified by:

build in interface ObjectBuilder<PutDecommissionAwarenessRequest>

Throws:

NullPointerException - if some of the required fields are null.