Package co.elastic.clients.elasticsearch.ingest

Class SimulateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ingest.SimulateRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SimulateRequest
extends RequestBase
implements JsonpSerializable

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimulateRequest.Builder	Builder for SimulateRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<SimulateRequest>	_DESERIALIZER	Json deserializer for SimulateRequest
static final Endpoint<SimulateRequest,SimulateResponse,ErrorResponse>	_ENDPOINT	Endpoint "ingest.simulate".

Method Summary

Modifier and Type	Method	Description
final List<Document>	docs()	Required - Sample documents to test in the pipeline.
final String	id()	The pipeline to test.
static SimulateRequest	of(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)
final Pipeline	pipeline()	The pipeline to test.
SimulateRequest.Builder	rebuild()
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSimulateRequestDeserializer(ObjectDeserializer<SimulateRequest.Builder> op)
final Boolean	verbose()	If true, the response includes output data for each processor in the executed pipeline.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SimulateRequest> _DESERIALIZER

Json deserializer for SimulateRequest

_ENDPOINT

public static final Endpoint<SimulateRequest,SimulateResponse,ErrorResponse> _ENDPOINT

Endpoint "ingest.simulate".

Method Details

of

public static SimulateRequest of(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)

docs

public final List<Document> docs()

Required - Sample documents to test in the pipeline.

API name: docs

id

@Nullable
public final String id()

The pipeline to test. If you don't specify a pipeline in the request body, this parameter is required.

API name: id

pipeline

@Nullable
public final Pipeline pipeline()

The pipeline to test. If you don't specify the pipeline request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter.

API name: pipeline

verbose

@Nullable
public final Boolean verbose()

If true, the response includes output data for each processor in the executed pipeline.

API name: verbose

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

rebuild

public SimulateRequest.Builder rebuild()

Returns:

New SimulateRequest.Builder initialized with field values of this instance

setupSimulateRequestDeserializer

protected static void setupSimulateRequestDeserializer(ObjectDeserializer<SimulateRequest.Builder> op)