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)	Delete GeoIP database configurations.
final DeleteGeoipDatabaseResponse	deleteGeoipDatabase(Function<DeleteGeoipDatabaseRequest.Builder,ObjectBuilder<DeleteGeoipDatabaseRequest>> fn)	Delete GeoIP database configurations.
DeleteIpLocationDatabaseResponse	deleteIpLocationDatabase(DeleteIpLocationDatabaseRequest request)	Delete IP geolocation database configurations.
final DeleteIpLocationDatabaseResponse	deleteIpLocationDatabase(Function<DeleteIpLocationDatabaseRequest.Builder,ObjectBuilder<DeleteIpLocationDatabaseRequest>> fn)	Delete IP geolocation database configurations.
DeletePipelineResponse	deletePipeline(DeletePipelineRequest request)	Delete pipelines.
final DeletePipelineResponse	deletePipeline(Function<DeletePipelineRequest.Builder,ObjectBuilder<DeletePipelineRequest>> fn)	Delete pipelines.
GeoIpStatsResponse	geoIpStats()	Get GeoIP statistics.
GetGeoipDatabaseResponse	getGeoipDatabase()	Get GeoIP database configurations.
GetGeoipDatabaseResponse	getGeoipDatabase(GetGeoipDatabaseRequest request)	Get GeoIP database configurations.
final GetGeoipDatabaseResponse	getGeoipDatabase(Function<GetGeoipDatabaseRequest.Builder,ObjectBuilder<GetGeoipDatabaseRequest>> fn)	Get GeoIP database configurations.
GetIpLocationDatabaseResponse	getIpLocationDatabase()	Get IP geolocation database configurations.
GetIpLocationDatabaseResponse	getIpLocationDatabase(GetIpLocationDatabaseRequest request)	Get IP geolocation database configurations.
final GetIpLocationDatabaseResponse	getIpLocationDatabase(Function<GetIpLocationDatabaseRequest.Builder,ObjectBuilder<GetIpLocationDatabaseRequest>> fn)	Get IP geolocation database configurations.
GetPipelineResponse	getPipeline()	Get pipelines.
GetPipelineResponse	getPipeline(GetPipelineRequest request)	Get pipelines.
final GetPipelineResponse	getPipeline(Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)	Get pipelines.
ProcessorGrokResponse	processorGrok()	Run a grok processor.
PutGeoipDatabaseResponse	putGeoipDatabase(PutGeoipDatabaseRequest request)	Create or update a GeoIP database configuration.
final PutGeoipDatabaseResponse	putGeoipDatabase(Function<PutGeoipDatabaseRequest.Builder,ObjectBuilder<PutGeoipDatabaseRequest>> fn)	Create or update a GeoIP database configuration.
PutIpLocationDatabaseResponse	putIpLocationDatabase(PutIpLocationDatabaseRequest request)	Create or update an IP geolocation database configuration.
final PutIpLocationDatabaseResponse	putIpLocationDatabase(Function<PutIpLocationDatabaseRequest.Builder,ObjectBuilder<PutIpLocationDatabaseRequest>> fn)	Create or update an IP geolocation database configuration.
PutPipelineResponse	putPipeline(PutPipelineRequest request)	Create or update a pipeline.
final PutPipelineResponse	putPipeline(Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)	Create or update a pipeline.
SimulateResponse	simulate(SimulateRequest request)	Simulate a pipeline.
final SimulateResponse	simulate(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)	Simulate a pipeline.
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

Delete GeoIP database configurations.

Delete one or more IP geolocation database configurations.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteGeoipDatabase

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

Delete GeoIP database configurations.

Delete one or more IP geolocation database configurations.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteIpLocationDatabase

public DeleteIpLocationDatabaseResponse deleteIpLocationDatabase(DeleteIpLocationDatabaseRequest request)
                                                          throws IOException,
ElasticsearchException

Delete IP geolocation database configurations.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteIpLocationDatabase

public final DeleteIpLocationDatabaseResponse deleteIpLocationDatabase(Function<DeleteIpLocationDatabaseRequest.Builder,ObjectBuilder<DeleteIpLocationDatabaseRequest>> fn)
                                                                throws IOException,
ElasticsearchException

Delete IP geolocation database configurations.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deletePipeline

public DeletePipelineResponse deletePipeline(DeletePipelineRequest request)
                                      throws IOException,
ElasticsearchException

Delete pipelines. Delete one or more ingest pipelines.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deletePipeline

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

Delete pipelines. Delete one or more ingest pipelines.

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

Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getGeoipDatabase

public GetGeoipDatabaseResponse getGeoipDatabase(GetGeoipDatabaseRequest request)
                                          throws IOException,
ElasticsearchException

Get GeoIP database configurations.

Get information about one or more IP geolocation 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

Get GeoIP database configurations.

Get information about one or more IP geolocation 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

Get GeoIP database configurations.

Get information about one or more IP geolocation database configurations.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getIpLocationDatabase

public GetIpLocationDatabaseResponse getIpLocationDatabase(GetIpLocationDatabaseRequest request)
                                                    throws IOException,
ElasticsearchException

Get IP geolocation database configurations.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getIpLocationDatabase

public final GetIpLocationDatabaseResponse getIpLocationDatabase(Function<GetIpLocationDatabaseRequest.Builder,ObjectBuilder<GetIpLocationDatabaseRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Get IP geolocation database configurations.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getIpLocationDatabase

public GetIpLocationDatabaseResponse getIpLocationDatabase()
                                                    throws IOException,
ElasticsearchException

Get IP geolocation database configurations.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPipeline

public GetPipelineResponse getPipeline(GetPipelineRequest request)
                                throws IOException,
ElasticsearchException

Get pipelines.

Get 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

Get pipelines.

Get 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

Get pipelines.

Get 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

Run a grok processor. Extract structured fields out of a single text field within a document. You must 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

Create or update a GeoIP database configuration.

Refer to the create or update IP geolocation database configuration API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putGeoipDatabase

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

Create or update a GeoIP database configuration.

Refer to the create or update IP geolocation database configuration API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putIpLocationDatabase

public PutIpLocationDatabaseResponse putIpLocationDatabase(PutIpLocationDatabaseRequest request)
                                                    throws IOException,
ElasticsearchException

Create or update an IP geolocation database configuration.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putIpLocationDatabase

public final PutIpLocationDatabaseResponse putIpLocationDatabase(Function<PutIpLocationDatabaseRequest.Builder,ObjectBuilder<PutIpLocationDatabaseRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Create or update an IP geolocation database configuration.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPipeline

public PutPipelineResponse putPipeline(PutPipelineRequest request)
                                throws IOException,
ElasticsearchException

Create or update a 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

Create or update a 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

Simulate a pipeline.

Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulate

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

Simulate a pipeline.

Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co