Package org.opensearch.client.opensearch.ingest

Class OpenSearchIngestAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.ingest.OpenSearchIngestAsyncClient

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
java.util.concurrent.CompletableFuture<DeletePipelineResponse>	deletePipeline(java.util.function.Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)	Deletes a pipeline.
java.util.concurrent.CompletableFuture<DeletePipelineResponse>	deletePipeline(DeletePipelineRequest request)	Deletes a pipeline.
java.util.concurrent.CompletableFuture<GeoIpStatsResponse>	geoIpStats()	Returns statistical information about geoip databases
java.util.concurrent.CompletableFuture<GetPipelineResponse>	getPipeline()	Returns a pipeline.
java.util.concurrent.CompletableFuture<GetPipelineResponse>	getPipeline(java.util.function.Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)	Returns a pipeline.
java.util.concurrent.CompletableFuture<GetPipelineResponse>	getPipeline(GetPipelineRequest request)	Returns a pipeline.
java.util.concurrent.CompletableFuture<ProcessorGrokResponse>	processorGrok()	Returns a list of the built-in patterns.
java.util.concurrent.CompletableFuture<PutPipelineResponse>	putPipeline(java.util.function.Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)	Creates or updates a pipeline.
java.util.concurrent.CompletableFuture<PutPipelineResponse>	putPipeline(PutPipelineRequest request)	Creates or updates a pipeline.
java.util.concurrent.CompletableFuture<SimulateResponse>	simulate()	Allows to simulate a pipeline with example documents.
java.util.concurrent.CompletableFuture<SimulateResponse>	simulate(java.util.function.Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)	Allows to simulate a pipeline with example documents.
java.util.concurrent.CompletableFuture<SimulateResponse>	simulate(SimulateRequest request)	Allows to simulate a 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 Detail

OpenSearchIngestAsyncClient

public OpenSearchIngestAsyncClient(OpenSearchTransport transport)

OpenSearchIngestAsyncClient

public OpenSearchIngestAsyncClient(OpenSearchTransport transport,
                                   @Nullable
                                   TransportOptions transportOptions)

Method Detail

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 java.util.concurrent.CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest request)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Deletes a pipeline.

Throws:

java.io.IOException

OpenSearchException

deletePipeline

public final java.util.concurrent.CompletableFuture<DeletePipelineResponse> deletePipeline(java.util.function.Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)
                                                                                    throws java.io.IOException,
                                                                                           OpenSearchException

Deletes a pipeline.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

geoIpStats

public java.util.concurrent.CompletableFuture<GeoIpStatsResponse> geoIpStats()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Returns statistical information about geoip databases

Throws:

java.io.IOException

OpenSearchException

getPipeline

public java.util.concurrent.CompletableFuture<GetPipelineResponse> getPipeline(GetPipelineRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Returns a pipeline.

Throws:

java.io.IOException

OpenSearchException

getPipeline

public final java.util.concurrent.CompletableFuture<GetPipelineResponse> getPipeline(java.util.function.Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Returns a pipeline.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getPipeline

public java.util.concurrent.CompletableFuture<GetPipelineResponse> getPipeline()
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Returns a pipeline.

Throws:

java.io.IOException

OpenSearchException

processorGrok

public java.util.concurrent.CompletableFuture<ProcessorGrokResponse> processorGrok()
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Returns a list of the built-in patterns.

Throws:

java.io.IOException

OpenSearchException

putPipeline

public java.util.concurrent.CompletableFuture<PutPipelineResponse> putPipeline(PutPipelineRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Creates or updates a pipeline.

Throws:

java.io.IOException

OpenSearchException

putPipeline

public final java.util.concurrent.CompletableFuture<PutPipelineResponse> putPipeline(java.util.function.Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Creates or updates a pipeline.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

simulate

public java.util.concurrent.CompletableFuture<SimulateResponse> simulate(SimulateRequest request)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Allows to simulate a pipeline with example documents.

Throws:

java.io.IOException

OpenSearchException

simulate

public final java.util.concurrent.CompletableFuture<SimulateResponse> simulate(java.util.function.Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Allows to simulate a pipeline with example documents.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

simulate

public java.util.concurrent.CompletableFuture<SimulateResponse> simulate()
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Allows to simulate a pipeline with example documents.

Throws:

java.io.IOException

OpenSearchException