Package co.elastic.clients.elasticsearch.ingest

Class ElasticsearchIngestClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchIngestClient>

co.elastic.clients.elasticsearch.ingest.ElasticsearchIngestClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchIngestClient
extends ApiClient<ElasticsearchTransport,ElasticsearchIngestClient>

Client for the ingest namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchIngestClient(ElasticsearchTransport transport)
ElasticsearchIngestClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
DeleteGeoipDatabaseResponse	deleteGeoipDatabase(DeleteGeoipDatabaseRequest request)	Deletes a geoip database configuration.
final DeleteGeoipDatabaseResponse	deleteGeoipDatabase(Function<DeleteGeoipDatabaseRequest.Builder,ObjectBuilder<DeleteGeoipDatabaseRequest>> fn)	Deletes a geoip database configuration.
DeletePipelineResponse	deletePipeline(DeletePipelineRequest request)	Deletes one or more existing ingest pipeline.
final DeletePipelineResponse	deletePipeline(Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)	Deletes one or more existing ingest pipeline.
GeoIpStatsResponse	geoIpStats()	Gets download statistics for GeoIP2 databases used with the geoip processor.
GetGeoipDatabaseResponse	getGeoipDatabase()	Returns information about one or more geoip database configurations.
GetGeoipDatabaseResponse	getGeoipDatabase(GetGeoipDatabaseRequest request)	Returns information about one or more geoip database configurations.
final GetGeoipDatabaseResponse	getGeoipDatabase(Function<GetGeoipDatabaseRequest.Builder,ObjectBuilder<GetGeoipDatabaseRequest>> fn)	Returns information about one or more geoip database configurations.
GetPipelineResponse	getPipeline()	Returns information about one or more ingest pipelines.
GetPipelineResponse	getPipeline(GetPipelineRequest request)	Returns information about one or more ingest pipelines.
final GetPipelineResponse	getPipeline(Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)	Returns information about one or more ingest pipelines.
ProcessorGrokResponse	processorGrok()	Extracts structured fields out of a single text field within a document.
PutGeoipDatabaseResponse	putGeoipDatabase(PutGeoipDatabaseRequest request)	Returns information about one or more geoip database configurations.
final PutGeoipDatabaseResponse	putGeoipDatabase(Function<PutGeoipDatabaseRequest.Builder,ObjectBuilder<PutGeoipDatabaseRequest>> fn)	Returns information about one or more geoip database configurations.
PutPipelineResponse	putPipeline(PutPipelineRequest request)	Creates or updates an ingest pipeline.
final PutPipelineResponse	putPipeline(Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)	Creates or updates an ingest pipeline.
SimulateResponse	simulate(SimulateRequest request)	Executes an ingest pipeline against a set of provided documents.
final SimulateResponse	simulate(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)	Executes an ingest pipeline against a set of provided documents.
ElasticsearchIngestClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchIngestClient

public ElasticsearchIngestClient(ElasticsearchTransport transport)

ElasticsearchIngestClient

public ElasticsearchIngestClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchIngestClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchIngestClient>

deleteGeoipDatabase

public DeleteGeoipDatabaseResponse deleteGeoipDatabase(DeleteGeoipDatabaseRequest request)
                                                throws IOException,
ElasticsearchException

Deletes a geoip database configuration.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteGeoipDatabase

public final DeleteGeoipDatabaseResponse deleteGeoipDatabase(Function<DeleteGeoipDatabaseRequest.Builder,ObjectBuilder<DeleteGeoipDatabaseRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Deletes a geoip database configuration.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deletePipeline

public DeletePipelineResponse deletePipeline(DeletePipelineRequest request)
                                      throws IOException,
ElasticsearchException

Deletes one or more existing ingest pipeline.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deletePipeline

public final DeletePipelineResponse deletePipeline(Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)
                                            throws IOException,
ElasticsearchException

Deletes one or more existing ingest pipeline.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

geoIpStats

public GeoIpStatsResponse geoIpStats()
                              throws IOException,
ElasticsearchException

Gets download statistics for GeoIP2 databases used with the geoip processor.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getGeoipDatabase

public GetGeoipDatabaseResponse getGeoipDatabase(GetGeoipDatabaseRequest request)
                                          throws IOException,
ElasticsearchException

Returns information about one or more geoip database configurations.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getGeoipDatabase

public final GetGeoipDatabaseResponse getGeoipDatabase(Function<GetGeoipDatabaseRequest.Builder,ObjectBuilder<GetGeoipDatabaseRequest>> fn)
                                                throws IOException,
ElasticsearchException

Returns information about one or more geoip database configurations.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getGeoipDatabase

public GetGeoipDatabaseResponse getGeoipDatabase()
                                          throws IOException,
ElasticsearchException

Returns information about one or more geoip database configurations.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPipeline

public GetPipelineResponse getPipeline(GetPipelineRequest request)
                                throws IOException,
ElasticsearchException

Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPipeline

public final GetPipelineResponse getPipeline(Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)
                                      throws IOException,
ElasticsearchException

Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPipeline

public GetPipelineResponse getPipeline()
                                throws IOException,
ElasticsearchException

Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

processorGrok

public ProcessorGrokResponse processorGrok()
                                    throws IOException,
ElasticsearchException

Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putGeoipDatabase

public PutGeoipDatabaseResponse putGeoipDatabase(PutGeoipDatabaseRequest request)
                                          throws IOException,
ElasticsearchException

Returns information about one or more geoip database configurations.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putGeoipDatabase

public final PutGeoipDatabaseResponse putGeoipDatabase(Function<PutGeoipDatabaseRequest.Builder,ObjectBuilder<PutGeoipDatabaseRequest>> fn)
                                                throws IOException,
ElasticsearchException

Returns information about one or more geoip database configurations.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPipeline

public PutPipelineResponse putPipeline(PutPipelineRequest request)
                                throws IOException,
ElasticsearchException

Creates or updates an ingest pipeline. Changes made using this API take effect immediately.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPipeline

public final PutPipelineResponse putPipeline(Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)
                                      throws IOException,
ElasticsearchException

Creates or updates an ingest pipeline. Changes made using this API take effect immediately.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulate

public SimulateResponse simulate(SimulateRequest request)
                          throws IOException,
ElasticsearchException

Executes an ingest pipeline against a set of provided documents.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulate

public final SimulateResponse simulate(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)
                                throws IOException,
ElasticsearchException

Executes an ingest pipeline against a set of provided documents.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co