Package org.opensearch.client.opensearch.ingestion

Class OpenSearchIngestionAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.ingestion.OpenSearchIngestionAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchIngestionAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchIngestionAsyncClient>

Client for the ingestion namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<GetStateResponse>	getState(Function<GetStateRequest.Builder,ObjectBuilder<GetStateRequest>> fn)	Use this API to retrieve the ingestion state for a given index.
CompletableFuture<GetStateResponse>	getState(GetStateRequest request)	Use this API to retrieve the ingestion state for a given index.
final CompletableFuture<PauseResponse>	pause(Function<PauseRequest.Builder,ObjectBuilder<PauseRequest>> fn)	Use this API to pause ingestion for a given index.
CompletableFuture<PauseResponse>	pause(PauseRequest request)	Use this API to pause ingestion for a given index.
final CompletableFuture<ResumeResponse>	resume(Function<ResumeRequest.Builder,ObjectBuilder<ResumeRequest>> fn)	Use this API to resume ingestion for the given index.
CompletableFuture<ResumeResponse>	resume(ResumeRequest request)	Use this API to resume ingestion for the given index.
OpenSearchIngestionAsyncClient	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 Details

OpenSearchIngestionAsyncClient

public OpenSearchIngestionAsyncClient(OpenSearchTransport transport)

OpenSearchIngestionAsyncClient

public OpenSearchIngestionAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchIngestionAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchIngestionAsyncClient>

getState

public CompletableFuture<GetStateResponse> getState(GetStateRequest request)
                                             throws IOException,
OpenSearchException

Use this API to retrieve the ingestion state for a given index.

Throws:

IOException

OpenSearchException

getState

public final CompletableFuture<GetStateResponse> getState(Function<GetStateRequest.Builder,ObjectBuilder<GetStateRequest>> fn)
                                                   throws IOException,
OpenSearchException

Use this API to retrieve the ingestion state for a given index.

Parameters:

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

Throws:

IOException

OpenSearchException

pause

public CompletableFuture<PauseResponse> pause(PauseRequest request)
                                       throws IOException,
OpenSearchException

Use this API to pause ingestion for a given index.

Throws:

IOException

OpenSearchException

pause

public final CompletableFuture<PauseResponse> pause(Function<PauseRequest.Builder,ObjectBuilder<PauseRequest>> fn)
                                             throws IOException,
OpenSearchException

Use this API to pause ingestion for a given index.

Parameters:

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

Throws:

IOException

OpenSearchException

resume

public CompletableFuture<ResumeResponse> resume(ResumeRequest request)
                                         throws IOException,
OpenSearchException

Use this API to resume ingestion for the given index.

Throws:

IOException

OpenSearchException

resume

public final CompletableFuture<ResumeResponse> resume(Function<ResumeRequest.Builder,ObjectBuilder<ResumeRequest>> fn)
                                               throws IOException,
OpenSearchException

Use this API to resume ingestion for the given index.

Parameters:

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

Throws:

IOException

OpenSearchException