Package org.opensearch.client.opensearch.dangling_indices

Class OpenSearchDanglingIndicesClient

java.lang.Object

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

org.opensearch.client.opensearch.dangling_indices.OpenSearchDanglingIndicesClient

public class OpenSearchDanglingIndicesClient
extends ApiClient<OpenSearchTransport,OpenSearchDanglingIndicesClient>

Client for the dangling_indices namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DeleteDanglingIndexResponse	deleteDanglingIndex(java.util.function.Function<DeleteDanglingIndexRequest.Builder,ObjectBuilder<DeleteDanglingIndexRequest>> fn)	Deletes the specified dangling index
DeleteDanglingIndexResponse	deleteDanglingIndex(DeleteDanglingIndexRequest request)	Deletes the specified dangling index
ImportDanglingIndexResponse	importDanglingIndex(java.util.function.Function<ImportDanglingIndexRequest.Builder,ObjectBuilder<ImportDanglingIndexRequest>> fn)	Imports the specified dangling index
ImportDanglingIndexResponse	importDanglingIndex(ImportDanglingIndexRequest request)	Imports the specified dangling index
ListDanglingIndicesResponse	listDanglingIndices()	Returns all dangling indices.
OpenSearchDanglingIndicesClient	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

OpenSearchDanglingIndicesClient

public OpenSearchDanglingIndicesClient(OpenSearchTransport transport)

OpenSearchDanglingIndicesClient

public OpenSearchDanglingIndicesClient(OpenSearchTransport transport,
                                       @Nullable
                                       TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchDanglingIndicesClient withTransportOptions(@Nullable
                                                            TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchDanglingIndicesClient>

deleteDanglingIndex

public DeleteDanglingIndexResponse deleteDanglingIndex(DeleteDanglingIndexRequest request)
                                                throws java.io.IOException,
                                                       OpenSearchException

Deletes the specified dangling index

Throws:

java.io.IOException

OpenSearchException

deleteDanglingIndex

public final DeleteDanglingIndexResponse deleteDanglingIndex(java.util.function.Function<DeleteDanglingIndexRequest.Builder,ObjectBuilder<DeleteDanglingIndexRequest>> fn)
                                                      throws java.io.IOException,
                                                             OpenSearchException

Deletes the specified dangling index

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

importDanglingIndex

public ImportDanglingIndexResponse importDanglingIndex(ImportDanglingIndexRequest request)
                                                throws java.io.IOException,
                                                       OpenSearchException

Imports the specified dangling index

Throws:

java.io.IOException

OpenSearchException

importDanglingIndex

public final ImportDanglingIndexResponse importDanglingIndex(java.util.function.Function<ImportDanglingIndexRequest.Builder,ObjectBuilder<ImportDanglingIndexRequest>> fn)
                                                      throws java.io.IOException,
                                                             OpenSearchException

Imports the specified dangling index

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

listDanglingIndices

public ListDanglingIndicesResponse listDanglingIndices()
                                                throws java.io.IOException,
                                                       OpenSearchException

Returns all dangling indices.

Throws:

java.io.IOException

OpenSearchException