Package org.opensearch.client.opensearch.ingest

Class SimulateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<SimulateRequest.Builder>

org.opensearch.client.opensearch.ingest.SimulateRequest.Builder

All Implemented Interfaces:

CopyableBuilder<SimulateRequest.Builder,SimulateRequest>, MutableBuilder<SimulateRequest.Builder,SimulateRequest>, ObjectBuilder<SimulateRequest>

Enclosing class:

SimulateRequest

public static class SimulateRequest.Builder
extends RequestBase.AbstractBuilder<SimulateRequest.Builder>
implements CopyableBuilder<SimulateRequest.Builder,SimulateRequest>

Builder for SimulateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SimulateRequest	build()	Builds a SimulateRequest.
SimulateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SimulateRequest.Builder	docs(Function<Document.Builder,ObjectBuilder<Document>> fn)	A list of sample documents to test in the pipeline.
final SimulateRequest.Builder	docs(List<Document> list)	A list of sample documents to test in the pipeline.
final SimulateRequest.Builder	docs(Document value, Document... values)	A list of sample documents to test in the pipeline.
final SimulateRequest.Builder	id(String value)	The pipeline to test.
final SimulateRequest.Builder	pipeline(Function<Pipeline.Builder,ObjectBuilder<Pipeline>> fn)	API name: pipeline
final SimulateRequest.Builder	pipeline(Pipeline value)	API name: pipeline
protected SimulateRequest.Builder	self()
final SimulateRequest.Builder	verbose(Boolean value)	When true, the response includes output data for each processor in the pipeline

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public SimulateRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<SimulateRequest.Builder,SimulateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected SimulateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SimulateRequest.Builder>

docs

@Nonnull
public final SimulateRequest.Builder docs(List<Document> list)

A list of sample documents to test in the pipeline.

API name: docs

Adds all elements of list to docs.

docs

@Nonnull
public final SimulateRequest.Builder docs(Document value,
 Document... values)

A list of sample documents to test in the pipeline.

API name: docs

Adds one or more values to docs.

docs

@Nonnull
public final SimulateRequest.Builder docs(Function<Document.Builder,ObjectBuilder<Document>> fn)

A list of sample documents to test in the pipeline.

API name: docs

Adds a value to docs using a builder lambda.

id

@Nonnull
public final SimulateRequest.Builder id(@Nullable
 String value)

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

API name: id

pipeline

@Nonnull
public final SimulateRequest.Builder pipeline(@Nullable
 Pipeline value)

API name: pipeline

pipeline

@Nonnull
public final SimulateRequest.Builder pipeline(Function<Pipeline.Builder,ObjectBuilder<Pipeline>> fn)

API name: pipeline

verbose

@Nonnull
public final SimulateRequest.Builder verbose(@Nullable
 Boolean value)

When true, the response includes output data for each processor in the pipeline

API name: verbose

build

@Nonnull
public SimulateRequest build()

Builds a SimulateRequest.

Specified by:

build in interface ObjectBuilder<SimulateRequest>

Throws:

NullPointerException - if some of the required fields are null.