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

Class ShutdownClient

java.lang.Object

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

org.opensearch.client.opensearch.api.shutdown.ShutdownClient

public class ShutdownClient
extends ApiClient<ShutdownClient>

Client for the shutdown namespace.

Field Summary

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

requestOptions, transport

Constructor Summary

Constructors

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

Method Summary

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

ShutdownClient

public ShutdownClient(Transport transport)

ShutdownClient

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

Method Details

deleteNode

public DeleteNodeResponse deleteNode(DeleteNodeRequest request) throws java.io.IOException

Removes a node from the shutdown list

Throws:

java.io.IOException

deleteNode

public final 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 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 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 PutNodeResponse putNode(PutNodeRequest request) throws java.io.IOException

Adds a node to be shut down

Throws:

java.io.IOException

putNode

public final 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 ShutdownClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

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

Specified by:

withRequestOptions in class ApiClient<ShutdownClient>

withRequestOptions

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

Creates a new ShutdownClient(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.