Package org.opensearch.client.opensearch.api.shutdown

Class ShutdownAsyncClient

java.lang.Object

org.opensearch.client.base.ApiClient<ShutdownAsyncClient>

org.opensearch.client.opensearch.api.shutdown.ShutdownAsyncClient

public class ShutdownAsyncClient
extends ApiClient<ShutdownAsyncClient>

Client for the shutdown namespace.

Field Summary

Fields inherited from class org.opensearch.client.base.ApiClient

requestOptions, transport

Constructor Summary

Constructors

Constructor	Description
ShutdownAsyncClient(Transport transport)
ShutdownAsyncClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<DeleteNodeResponse>	deleteNode(java.util.function.Function<DeleteNodeRequest.Builder,ObjectBuilder<DeleteNodeRequest>> fn)	Removes a node from the shutdown list
java.util.concurrent.CompletableFuture<DeleteNodeResponse>	deleteNode(DeleteNodeRequest request)	Removes a node from the shutdown list
java.util.concurrent.CompletableFuture<GetNodeResponse>	getNode(java.util.function.Function<GetNodeRequest.Builder,ObjectBuilder<GetNodeRequest>> fn)	Retrieve status of a node or nodes that are currently marked as shutting down
java.util.concurrent.CompletableFuture<GetNodeResponse>	getNode(GetNodeRequest request)	Retrieve status of a node or nodes that are currently marked as shutting down
java.util.concurrent.CompletableFuture<PutNodeResponse>	putNode(java.util.function.Function<PutNodeRequest.Builder,ObjectBuilder<PutNodeRequest>> fn)	Adds a node to be shut down
java.util.concurrent.CompletableFuture<PutNodeResponse>	putNode(PutNodeRequest request)	Adds a node to be shut down
ShutdownAsyncClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new ShutdownAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
ShutdownAsyncClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new ShutdownAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Methods inherited from class org.opensearch.client.base.ApiClient

getDeserializer, requestOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ShutdownAsyncClient

public ShutdownAsyncClient(Transport transport)

ShutdownAsyncClient

public ShutdownAsyncClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Details

deleteNode

public java.util.concurrent.CompletableFuture<DeleteNodeResponse> deleteNode(DeleteNodeRequest request) throws java.io.IOException

Removes a node from the shutdown list

Throws:

java.io.IOException

deleteNode

public final java.util.concurrent.CompletableFuture<DeleteNodeResponse> deleteNode(java.util.function.Function<DeleteNodeRequest.Builder,ObjectBuilder<DeleteNodeRequest>> fn) throws java.io.IOException

Removes a node from the shutdown list

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getNode

public java.util.concurrent.CompletableFuture<GetNodeResponse> getNode(GetNodeRequest request) throws java.io.IOException

Retrieve status of a node or nodes that are currently marked as shutting down

Throws:

java.io.IOException

getNode

public final java.util.concurrent.CompletableFuture<GetNodeResponse> getNode(java.util.function.Function<GetNodeRequest.Builder,ObjectBuilder<GetNodeRequest>> fn) throws java.io.IOException

Retrieve status of a node or nodes that are currently marked as shutting down

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

putNode

public java.util.concurrent.CompletableFuture<PutNodeResponse> putNode(PutNodeRequest request) throws java.io.IOException

Adds a node to be shut down

Throws:

java.io.IOException

putNode

public final java.util.concurrent.CompletableFuture<PutNodeResponse> putNode(java.util.function.Function<PutNodeRequest.Builder,ObjectBuilder<PutNodeRequest>> fn) throws java.io.IOException

Adds a node to be shut down

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

withRequestOptions

public ShutdownAsyncClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

Creates a new ShutdownAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Specified by:

withRequestOptions in class ApiClient<ShutdownAsyncClient>

withRequestOptions

public ShutdownAsyncClient withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)

Creates a new ShutdownAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.

Parameters:

fn - a function taking an options builder initialized with the current request options, or initialized with default values.