Package co.elastic.clients.elasticsearch.ingest

Class SimulateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SimulateRequest.Builder>

co.elastic.clients.elasticsearch.ingest.SimulateRequest.Builder

All Implemented Interfaces:

WithJson<SimulateRequest.Builder>, ObjectBuilder<SimulateRequest>

Enclosing class:

SimulateRequest

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

Builder for SimulateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SimulateRequest	build()	Builds a SimulateRequest.
final SimulateRequest.Builder	docs(Document value, Document... values)	Required - Sample documents to test in the pipeline.
final SimulateRequest.Builder	docs(Function<Document.Builder,ObjectBuilder<Document>> fn)	Required - Sample documents to test in the pipeline.
final SimulateRequest.Builder	docs(List<Document> list)	Required - Sample documents to test in the pipeline.
final SimulateRequest.Builder	id(String value)	The pipeline to test.
final SimulateRequest.Builder	pipeline(Pipeline value)	The pipeline to test.
final SimulateRequest.Builder	pipeline(Function<Pipeline.Builder,ObjectBuilder<Pipeline>> fn)	The pipeline to test.
protected SimulateRequest.Builder	self()
final SimulateRequest.Builder	verbose(Boolean value)	If true, the response includes output data for each processor in the executed pipeline.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

docs

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

Required - Sample documents to test in the pipeline.

API name: docs

Adds all elements of list to docs.

docs

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

Required - Sample documents to test in the pipeline.

API name: docs

Adds one or more values to docs.

docs

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

Required - Sample documents to test in the pipeline.

API name: docs

Adds a value to docs using a builder lambda.

id

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

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

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

pipeline

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

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

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

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

API name: verbose

self

protected SimulateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SimulateRequest.Builder>

build

public SimulateRequest build()

Builds a SimulateRequest.

Specified by:

build in interface ObjectBuilder<SimulateRequest>

Throws:

NullPointerException - if some of the required fields are null.