Package org.opensearch.client.opensearch.ingest

Class OpenSearchIngestClient

java.lang.Object

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

org.opensearch.client.opensearch.ingest.OpenSearchIngestClient

public class OpenSearchIngestClient
extends ApiClient<OpenSearchTransport,OpenSearchIngestClient>

Client for the ingest namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

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()	Returns a pipeline.
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.
SimulateResponse	simulate()	Allows to simulate a pipeline with example documents.
SimulateResponse	simulate(java.util.function.Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)	Allows to simulate a pipeline with example documents.
SimulateResponse	simulate(SimulateRequest request)	Allows to simulate a pipeline with example documents.
OpenSearchIngestClient	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

OpenSearchIngestClient

public OpenSearchIngestClient(OpenSearchTransport transport)

OpenSearchIngestClient

public OpenSearchIngestClient(OpenSearchTransport transport,
                              @Nullable
                              TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchIngestClient withTransportOptions(@Nullable
                                                   TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchIngestClient>

deletePipeline

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

Deletes a pipeline.

Throws:

java.io.IOException

OpenSearchException

deletePipeline

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

Returns statistical information about geoip databases

Throws:

java.io.IOException

OpenSearchException

getPipeline

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

Returns a pipeline.

Throws:

java.io.IOException

OpenSearchException

getPipeline

public final 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 GetPipelineResponse getPipeline()
                                throws java.io.IOException,
                                       OpenSearchException

Returns a pipeline.

Throws:

java.io.IOException

OpenSearchException

processorGrok

public ProcessorGrokResponse processorGrok()
                                    throws java.io.IOException,
                                           OpenSearchException

Returns a list of the built-in patterns.

Throws:

java.io.IOException

OpenSearchException

putPipeline

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

Creates or updates a pipeline.

Throws:

java.io.IOException

OpenSearchException

putPipeline

public final 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 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 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 SimulateResponse simulate()
                          throws java.io.IOException,
                                 OpenSearchException

Allows to simulate a pipeline with example documents.

Throws:

java.io.IOException

OpenSearchException