SimulateRequest (java-client 7.17.5 API)

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

Allows to simulate a pipeline with example documents.

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 JsonpDeserializer<SimulateRequest>`	`_DESERIALIZER`	Json deserializer for `SimulateRequest`
`static Endpoint<SimulateRequest,SimulateResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`ingest.simulate`".

Method Summary

Modifier and Type	Method	Description
`java.util.List<Document>`	`docs()`	API name: `docs`
`java.lang.String`	`id()`	Pipeline ID
`static SimulateRequest`	`of(java.util.function.Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)`
`Pipeline`	`pipeline()`	API name: `pipeline`
`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)`
`java.lang.Boolean`	`verbose()`	Verbose mode.

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(java.util.function.Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)
- docs
  
  public final java.util.List<Document> docs()
  
  API name: docs
- id
  
  @Nullable public final java.lang.String id()
  
  Pipeline ID
  API name: id
- pipeline
  
  @Nullable public final Pipeline pipeline()
  
  API name: pipeline
- verbose
  
  @Nullable public final java.lang.Boolean verbose()
  
  Verbose mode. Display data output for each processor in 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)
- setupSimulateRequestDeserializer
  
  protected static void setupSimulateRequestDeserializer(ObjectDeserializer<SimulateRequest.Builder> op)