Package org.opensearch.client.opensearch.ingest

Class SimulateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ingest.SimulateRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<SimulateRequest.Builder,SimulateRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class SimulateRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<SimulateRequest.Builder,SimulateRequest>

Simulates an ingest pipeline with example documents.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._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
protected void	applyQueryParameters(Map<String,String> params)
static SimulateRequest.Builder	builder()
final List<Document>	docs()	A list of sample documents to test in the pipeline.
boolean	equals(Object o)
int	hashCode()
final String	id()	The pipeline to test.
static SimulateRequest	of(Function<SimulateRequest.Builder,ObjectBuilder<SimulateRequest>> fn)
final 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)
SimulateRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Boolean	verbose()	When true, the response includes output data for each processor in the pipeline

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

@Nonnull
public final List<Document> docs()

A list of 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()

API name: pipeline

verbose

@Nullable
public final Boolean verbose()

When true, the response includes output data for each processor in the 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)

toBuilder

@Nonnull
public SimulateRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SimulateRequest.Builder,SimulateRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static SimulateRequest.Builder builder()

setupSimulateRequestDeserializer

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

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object