Package org.opensearch.client.opensearch.api.ingest

Class IngestAsyncClient

java.lang.Object

org.opensearch.client.base.ApiClient<IngestAsyncClient>

org.opensearch.client.opensearch.api.ingest.IngestAsyncClient

public class IngestAsyncClient
extends ApiClient<IngestAsyncClient>

Client for the ingest namespace.

Field Summary

Fields inherited from class org.opensearch.client.base.ApiClient

requestOptions, transport

Constructor Summary

Constructors

Constructor	Description
IngestAsyncClient(Transport transport)
IngestAsyncClient(Transport transport, org.opensearch.client.RequestOptions options)

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(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<SimulatePipelineResponse>	simulate(java.util.function.Function<SimulatePipelineRequest.Builder,ObjectBuilder<SimulatePipelineRequest>> fn)	Allows to simulate a pipeline with example documents.
java.util.concurrent.CompletableFuture<SimulatePipelineResponse>	simulate(SimulatePipelineRequest request)	Allows to simulate a pipeline with example documents.
IngestAsyncClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new IngestAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
IngestAsyncClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new IngestAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Methods inherited from class org.opensearch.client.base.ApiClient

getDeserializer, requestOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IngestAsyncClient

public IngestAsyncClient(Transport transport)

IngestAsyncClient

public IngestAsyncClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Details

deletePipeline

public java.util.concurrent.CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest request) throws java.io.IOException

Deletes a pipeline.

Throws:

java.io.IOException

deletePipeline

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

Deletes a pipeline.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

geoIpStats

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

Returns statistical information about geoip databases

Throws:

java.io.IOException

getPipeline

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

Returns a pipeline.

Throws:

java.io.IOException

getPipeline

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

Returns a pipeline.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

processorGrok

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

Returns a list of the built-in patterns.

Throws:

java.io.IOException

putPipeline

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

Creates or updates a pipeline.

Throws:

java.io.IOException

putPipeline

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

Creates or updates a pipeline.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

simulate

public java.util.concurrent.CompletableFuture<SimulatePipelineResponse> simulate(SimulatePipelineRequest request) throws java.io.IOException

Allows to simulate a pipeline with example documents.

Throws:

java.io.IOException

simulate

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

Allows to simulate a pipeline with example documents.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

withRequestOptions

public IngestAsyncClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

Creates a new IngestAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Specified by:

withRequestOptions in class ApiClient<IngestAsyncClient>

withRequestOptions

public IngestAsyncClient withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)

Creates a new IngestAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.

Parameters:

fn - a function taking an options builder initialized with the current request options, or initialized with default values.