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

Class IngestClient

java.lang.Object

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

org.opensearch.client.opensearch.api.ingest.IngestClient

public class IngestClient
extends ApiClient<IngestClient>

Client for the ingest namespace.

Field Summary

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

requestOptions, transport

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DeletePipelineResponse	deletePipeline(java.util.function.Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)	Deletes a pipeline.
DeletePipelineResponse	deletePipeline(DeletePipelineRequest request)	Deletes a pipeline.
GeoIpStatsResponse	geoIpStats()	Returns statistical information about geoip databases
GetPipelineResponse	getPipeline(java.util.function.Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)	Returns a pipeline.
GetPipelineResponse	getPipeline(GetPipelineRequest request)	Returns a pipeline.
ProcessorGrokResponse	processorGrok()	Returns a list of the built-in patterns.
PutPipelineResponse	putPipeline(java.util.function.Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)	Creates or updates a pipeline.
PutPipelineResponse	putPipeline(PutPipelineRequest request)	Creates or updates a pipeline.
SimulatePipelineResponse	simulate(java.util.function.Function<SimulatePipelineRequest.Builder,ObjectBuilder<SimulatePipelineRequest>> fn)	Allows to simulate a pipeline with example documents.
SimulatePipelineResponse	simulate(SimulatePipelineRequest request)	Allows to simulate a pipeline with example documents.
IngestClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new IngestClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
IngestClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new IngestClient(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

IngestClient

public IngestClient(Transport transport)

IngestClient

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

Method Details

deletePipeline

public DeletePipelineResponse deletePipeline(DeletePipelineRequest request) throws java.io.IOException

Deletes a pipeline.

Throws:

java.io.IOException

deletePipeline

public final 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 GeoIpStatsResponse geoIpStats() throws java.io.IOException

Returns statistical information about geoip databases

Throws:

java.io.IOException

getPipeline

public GetPipelineResponse getPipeline(GetPipelineRequest request) throws java.io.IOException

Returns a pipeline.

Throws:

java.io.IOException

getPipeline

public final 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 ProcessorGrokResponse processorGrok() throws java.io.IOException

Returns a list of the built-in patterns.

Throws:

java.io.IOException

putPipeline

public PutPipelineResponse putPipeline(PutPipelineRequest request) throws java.io.IOException

Creates or updates a pipeline.

Throws:

java.io.IOException

putPipeline

public final 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 SimulatePipelineResponse simulate(SimulatePipelineRequest request) throws java.io.IOException

Allows to simulate a pipeline with example documents.

Throws:

java.io.IOException

simulate

public final 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 IngestClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

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

Specified by:

withRequestOptions in class ApiClient<IngestClient>

withRequestOptions

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

Creates a new IngestClient(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.