Package org.opensearch.client.opensearch.ingest

Class OpenSearchIngestClient

java.lang.Object

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

org.opensearch.client.opensearch.ingest.OpenSearchIngestClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
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
final DeletePipelineResponse	deletePipeline(Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)	Deletes an ingest pipeline.
DeletePipelineResponse	deletePipeline(DeletePipelineRequest request)	Deletes an ingest pipeline.
final GetPipelineResponse	getPipeline()	Returns an ingest pipeline.
final GetPipelineResponse	getPipeline(Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)	Returns an ingest pipeline.
GetPipelineResponse	getPipeline(GetPipelineRequest request)	Returns an ingest pipeline.
final ProcessorGrokResponse	processorGrok()	Returns a list of built-in grok patterns.
final ProcessorGrokResponse	processorGrok(Function<ProcessorGrokRequest.Builder,ObjectBuilder<ProcessorGrokRequest>> fn)	Returns a list of built-in grok patterns.
ProcessorGrokResponse	processorGrok(ProcessorGrokRequest request)	Returns a list of built-in grok patterns.
final PutPipelineResponse	putPipeline(Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)	Creates or updates an ingest pipeline.
PutPipelineResponse	putPipeline(PutPipelineRequest request)	Creates or updates an ingest pipeline.
final SimulateResponse	simulate()	Simulates an ingest pipeline with example documents.
final SimulateResponse	simulate(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)	Simulates an ingest pipeline with example documents.
SimulateResponse	simulate(SimulateRequest request)	Simulates an ingest 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 Details

OpenSearchIngestClient

public OpenSearchIngestClient(OpenSearchTransport transport)

OpenSearchIngestClient

public OpenSearchIngestClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

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 IOException,
OpenSearchException

Deletes an ingest pipeline.

Throws:

IOException

OpenSearchException

deletePipeline

public final 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 GetPipelineResponse getPipeline(GetPipelineRequest request)
                                throws IOException,
OpenSearchException

Returns an ingest pipeline.

Throws:

IOException

OpenSearchException

getPipeline

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

Returns an ingest pipeline.

Throws:

IOException

OpenSearchException

processorGrok

public ProcessorGrokResponse processorGrok(ProcessorGrokRequest request)
                                    throws IOException,
OpenSearchException

Returns a list of built-in grok patterns.

Throws:

IOException

OpenSearchException

processorGrok

public final 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 ProcessorGrokResponse processorGrok()
                                          throws IOException,
OpenSearchException

Returns a list of built-in grok patterns.

Throws:

IOException

OpenSearchException

putPipeline

public PutPipelineResponse putPipeline(PutPipelineRequest request)
                                throws IOException,
OpenSearchException

Creates or updates an ingest pipeline.

Throws:

IOException

OpenSearchException

putPipeline

public final 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 SimulateResponse simulate(SimulateRequest request)
                          throws IOException,
OpenSearchException

Simulates an ingest pipeline with example documents.

Throws:

IOException

OpenSearchException

simulate

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

Simulates an ingest pipeline with example documents.

Throws:

IOException

OpenSearchException