Package org.opensearch.client.opensearch.shutdown

Class OpenSearchShutdownClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchShutdownClient>

org.opensearch.client.opensearch.shutdown.OpenSearchShutdownClient

public class OpenSearchShutdownClient
extends ApiClient<OpenSearchTransport,OpenSearchShutdownClient>

Client for the shutdown namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchShutdownClient(OpenSearchTransport transport)
OpenSearchShutdownClient(OpenSearchTransport transport, TransportOptions transportOptions)

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()	Retrieve status of a node or nodes that are currently marked as shutting down.
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.
OpenSearchShutdownClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchShutdownClient

public OpenSearchShutdownClient(OpenSearchTransport transport)

OpenSearchShutdownClient

public OpenSearchShutdownClient(OpenSearchTransport transport,
                                @Nullable
                                TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchShutdownClient withTransportOptions(@Nullable
                                                     TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchShutdownClient>

deleteNode

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

Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Throws:

java.io.IOException

OpenSearchException

deleteNode

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

Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Parameters:

fn - a function that initializes a builder to create the DeleteNodeRequest

Throws:

java.io.IOException

OpenSearchException

getNode

public GetNodeResponse getNode(GetNodeRequest request)
                        throws java.io.IOException,
                               OpenSearchException

Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Throws:

java.io.IOException

OpenSearchException

getNode

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

Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Parameters:

fn - a function that initializes a builder to create the GetNodeRequest

Throws:

java.io.IOException

OpenSearchException

getNode

public GetNodeResponse getNode()
                        throws java.io.IOException,
                               OpenSearchException

Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Throws:

java.io.IOException

OpenSearchException

putNode

public PutNodeResponse putNode(PutNodeRequest request)
                        throws java.io.IOException,
                               OpenSearchException

Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Throws:

java.io.IOException

OpenSearchException

putNode

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

Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Parameters:

fn - a function that initializes a builder to create the PutNodeRequest

Throws:

java.io.IOException

OpenSearchException