Package org.opensearch.client.opensearch.ingest

Class OpenSearchIngestAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.ingest.OpenSearchIngestAsyncClient

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

Client for the ingest namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<DeletePipelineResponse>	deletePipeline(Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)	Deletes an ingest pipeline.
CompletableFuture<DeletePipelineResponse>	deletePipeline(DeletePipelineRequest request)	Deletes an ingest pipeline.
final CompletableFuture<GetPipelineResponse>	getPipeline()	Returns an ingest pipeline.
final CompletableFuture<GetPipelineResponse>	getPipeline(Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)	Returns an ingest pipeline.
CompletableFuture<GetPipelineResponse>	getPipeline(GetPipelineRequest request)	Returns an ingest pipeline.
final CompletableFuture<ProcessorGrokResponse>	processorGrok()	Returns a list of built-in grok patterns.
final CompletableFuture<ProcessorGrokResponse>	processorGrok(Function<ProcessorGrokRequest.Builder,ObjectBuilder<ProcessorGrokRequest>> fn)	Returns a list of built-in grok patterns.
CompletableFuture<ProcessorGrokResponse>	processorGrok(ProcessorGrokRequest request)	Returns a list of built-in grok patterns.
final CompletableFuture<PutPipelineResponse>	putPipeline(Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)	Creates or updates an ingest pipeline.
CompletableFuture<PutPipelineResponse>	putPipeline(PutPipelineRequest request)	Creates or updates an ingest pipeline.
final CompletableFuture<SimulateResponse>	simulate()	Simulates an ingest pipeline with example documents.
final CompletableFuture<SimulateResponse>	simulate(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)	Simulates an ingest pipeline with example documents.
CompletableFuture<SimulateResponse>	simulate(SimulateRequest request)	Simulates an ingest pipeline with example documents.
OpenSearchIngestAsyncClient	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

OpenSearchIngestAsyncClient

public OpenSearchIngestAsyncClient(OpenSearchTransport transport)

OpenSearchIngestAsyncClient

public OpenSearchIngestAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchIngestAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchIngestAsyncClient>

deletePipeline

public CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest request)
                                                         throws IOException,
OpenSearchException

Deletes an ingest pipeline.

Throws:

IOException

OpenSearchException

deletePipeline

public final CompletableFuture<DeletePipelineResponse> deletePipeline(Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)
                                                               throws IOException,
OpenSearchException

Deletes an ingest pipeline.

Parameters:

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

Throws:

IOException

OpenSearchException

getPipeline

public CompletableFuture<GetPipelineResponse> getPipeline(GetPipelineRequest request)
                                                   throws IOException,
OpenSearchException

Returns an ingest pipeline.

Throws:

IOException

OpenSearchException

getPipeline

public final CompletableFuture<GetPipelineResponse> getPipeline(Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)
                                                         throws IOException,
OpenSearchException

Returns an ingest pipeline.

Parameters:

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

Throws:

IOException

OpenSearchException

getPipeline

public final CompletableFuture<GetPipelineResponse> getPipeline()
                                                         throws IOException,
OpenSearchException

Returns an ingest pipeline.

Throws:

IOException

OpenSearchException

processorGrok

public CompletableFuture<ProcessorGrokResponse> processorGrok(ProcessorGrokRequest request)
                                                       throws IOException,
OpenSearchException

Returns a list of built-in grok patterns.

Throws:

IOException

OpenSearchException

processorGrok

public final CompletableFuture<ProcessorGrokResponse> processorGrok(Function<ProcessorGrokRequest.Builder,ObjectBuilder<ProcessorGrokRequest>> fn)
                                                             throws IOException,
OpenSearchException

Returns a list of built-in grok patterns.

Parameters:

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

Throws:

IOException

OpenSearchException

processorGrok

public final CompletableFuture<ProcessorGrokResponse> processorGrok()
                                                             throws IOException,
OpenSearchException

Returns a list of built-in grok patterns.

Throws:

IOException

OpenSearchException

putPipeline

public CompletableFuture<PutPipelineResponse> putPipeline(PutPipelineRequest request)
                                                   throws IOException,
OpenSearchException

Creates or updates an ingest pipeline.

Throws:

IOException

OpenSearchException

putPipeline

public final CompletableFuture<PutPipelineResponse> putPipeline(Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)
                                                         throws IOException,
OpenSearchException

Creates or updates an ingest pipeline.

Parameters:

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

Throws:

IOException

OpenSearchException

simulate

public CompletableFuture<SimulateResponse> simulate(SimulateRequest request)
                                             throws IOException,
OpenSearchException

Simulates an ingest pipeline with example documents.

Throws:

IOException

OpenSearchException

simulate

public final CompletableFuture<SimulateResponse> simulate(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)
                                                   throws IOException,
OpenSearchException

Simulates an ingest pipeline with example documents.

Parameters:

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

Throws:

IOException

OpenSearchException

simulate

public final CompletableFuture<SimulateResponse> simulate()
                                                   throws IOException,
OpenSearchException

Simulates an ingest pipeline with example documents.

Throws:

IOException

OpenSearchException