Package org.opensearch.client.opensearch.cluster

Class PostVotingConfigExclusionsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cluster.PostVotingConfigExclusionsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PostVotingConfigExclusionsRequest

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

Builder for PostVotingConfigExclusionsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PostVotingConfigExclusionsRequest	build()	Builds a PostVotingConfigExclusionsRequest.
PostVotingConfigExclusionsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PostVotingConfigExclusionsRequest.Builder	nodeIds(String value, String... values)	A comma-separated list of node IDs to exclude from the voting configuration.
final PostVotingConfigExclusionsRequest.Builder	nodeIds(List<String> list)	A comma-separated list of node IDs to exclude from the voting configuration.
final PostVotingConfigExclusionsRequest.Builder	nodeNames(String value, String... values)	A comma-separated list of node names to exclude from the voting configuration.
final PostVotingConfigExclusionsRequest.Builder	nodeNames(List<String> list)	A comma-separated list of node names to exclude from the voting configuration.
protected PostVotingConfigExclusionsRequest.Builder	self()
final PostVotingConfigExclusionsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response.
final PostVotingConfigExclusionsRequest.Builder	timeout(Time value)	When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response.

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 PostVotingConfigExclusionsRequest.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<PostVotingConfigExclusionsRequest.Builder,PostVotingConfigExclusionsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PostVotingConfigExclusionsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PostVotingConfigExclusionsRequest.Builder>

nodeIds

@Nonnull
public final PostVotingConfigExclusionsRequest.Builder nodeIds(List<String> list)

A comma-separated list of node IDs to exclude from the voting configuration. When using this setting, you cannot also specify node_names. Either node_ids or node_names are required to receive a valid response.

API name: node_ids

Adds all elements of list to nodeIds.

nodeIds

@Nonnull
public final PostVotingConfigExclusionsRequest.Builder nodeIds(String value,
 String... values)

A comma-separated list of node IDs to exclude from the voting configuration. When using this setting, you cannot also specify node_names. Either node_ids or node_names are required to receive a valid response.

API name: node_ids

Adds one or more values to nodeIds.

nodeNames

@Nonnull
public final PostVotingConfigExclusionsRequest.Builder nodeNames(List<String> list)

A comma-separated list of node names to exclude from the voting configuration. When using this setting, you cannot also specify node_ids. Either node_ids or node_names are required to receive a valid response.

API name: node_names

Adds all elements of list to nodeNames.

nodeNames

@Nonnull
public final PostVotingConfigExclusionsRequest.Builder nodeNames(String value,
 String... values)

A comma-separated list of node names to exclude from the voting configuration. When using this setting, you cannot also specify node_ids. Either node_ids or node_names are required to receive a valid response.

API name: node_names

Adds one or more values to nodeNames.

timeout

@Nonnull
public final PostVotingConfigExclusionsRequest.Builder timeout(@Nullable
 Time value)

When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error.

API name: timeout

timeout

@Nonnull
public final PostVotingConfigExclusionsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error.

API name: timeout

build

@Nonnull
public PostVotingConfigExclusionsRequest build()

Builds a PostVotingConfigExclusionsRequest.

Specified by:

build in interface ObjectBuilder<PostVotingConfigExclusionsRequest>

Throws:

NullPointerException - if some of the required fields are null.