Package org.opensearch.client.opensearch.ingestion

Class OpenSearchIngestionClient

java.lang.Object

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

org.opensearch.client.opensearch.ingestion.OpenSearchIngestionClient

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

Client for the ingestion namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

OpenSearchIngestionClient

public OpenSearchIngestionClient(OpenSearchTransport transport)

OpenSearchIngestionClient

public OpenSearchIngestionClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchIngestionClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchIngestionClient>

getState

public 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 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 PauseResponse pause(PauseRequest request)
                    throws IOException,
OpenSearchException

Use this API to pause ingestion for a given index.

Throws:

IOException

OpenSearchException

pause

public final 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 ResumeResponse resume(ResumeRequest request)
                      throws IOException,
OpenSearchException

Use this API to resume ingestion for the given index.

Throws:

IOException

OpenSearchException

resume

public final 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