Package org.opensearch.client.opensearch.cluster

Class PostVotingConfigExclusionsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.PostVotingConfigExclusionsRequest

All Implemented Interfaces:

ToCopyableBuilder<PostVotingConfigExclusionsRequest.Builder,PostVotingConfigExclusionsRequest>

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

Updates the cluster voting configuration by excluding certain node IDs or names.

Nested Class Summary

Nested Classes

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

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<PostVotingConfigExclusionsRequest,BooleanResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.post_voting_config_exclusions".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PostVotingConfigExclusionsRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	nodeIds()	A comma-separated list of node IDs to exclude from the voting configuration.
final List<String>	nodeNames()	A comma-separated list of node names to exclude from the voting configuration.
static PostVotingConfigExclusionsRequest	of(Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn)
final Time	timeout()	When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response.
PostVotingConfigExclusionsRequest.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

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<PostVotingConfigExclusionsRequest,BooleanResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.post_voting_config_exclusions".

Method Details

of

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

nodeIds

@Nonnull
public final List<String> nodeIds()

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

nodeNames

@Nonnull
public final List<String> nodeNames()

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

timeout

@Nullable
public final Time timeout()

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

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static PostVotingConfigExclusionsRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object