Package co.elastic.clients.elasticsearch.ingest

Class PutPipelineRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.ingest.PutPipelineRequest.Builder

All Implemented Interfaces:

WithJson<PutPipelineRequest.Builder>, ObjectBuilder<PutPipelineRequest>

Enclosing class:

PutPipelineRequest

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

Builder for PutPipelineRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutPipelineRequest	build()	Builds a PutPipelineRequest.
final PutPipelineRequest.Builder	description(String value)	Description of the ingest pipeline.
final PutPipelineRequest.Builder	id(String value)	Required - Pipeline ID
final PutPipelineRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final PutPipelineRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final PutPipelineRequest.Builder	meta(String key, JsonData value)	Optional metadata about the ingest pipeline.
final PutPipelineRequest.Builder	meta(Map<String,JsonData> map)	Optional metadata about the ingest pipeline.
final PutPipelineRequest.Builder	onFailure(Processor value, Processor... values)	API name: on_failure
final PutPipelineRequest.Builder	onFailure(Function<Processor.Builder,ObjectBuilder<Processor>> fn)	API name: on_failure
final PutPipelineRequest.Builder	onFailure(List<Processor> list)	API name: on_failure
final PutPipelineRequest.Builder	processors(Processor value, Processor... values)	API name: processors
final PutPipelineRequest.Builder	processors(Function<Processor.Builder,ObjectBuilder<Processor>> fn)	API name: processors
final PutPipelineRequest.Builder	processors(List<Processor> list)	API name: processors
protected PutPipelineRequest.Builder	self()
final PutPipelineRequest.Builder	timeout(Time value)	Explicit operation timeout
final PutPipelineRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
final PutPipelineRequest.Builder	version(Long value)	API name: version

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

meta

public final PutPipelineRequest.Builder meta(Map<String,JsonData> map)

Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.

API name: _meta

Adds all entries of map to meta.

meta

public final PutPipelineRequest.Builder meta(String key,
 JsonData value)

Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.

API name: _meta

Adds an entry to meta.

description

public final PutPipelineRequest.Builder description(@Nullable
 String value)

Description of the ingest pipeline.

API name: description

id

public final PutPipelineRequest.Builder id(String value)

Required - Pipeline ID

API name: id

masterTimeout

public final PutPipelineRequest.Builder masterTimeout(@Nullable
 Time value)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

public final PutPipelineRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

onFailure

public final PutPipelineRequest.Builder onFailure(List<Processor> list)

API name: on_failure

Adds all elements of list to onFailure.

onFailure

public final PutPipelineRequest.Builder onFailure(Processor value,
 Processor... values)

API name: on_failure

Adds one or more values to onFailure.

onFailure

public final PutPipelineRequest.Builder onFailure(Function<Processor.Builder,ObjectBuilder<Processor>> fn)

API name: on_failure

Adds a value to onFailure using a builder lambda.

processors

public final PutPipelineRequest.Builder processors(List<Processor> list)

API name: processors

Adds all elements of list to processors.

processors

public final PutPipelineRequest.Builder processors(Processor value,
 Processor... values)

API name: processors

Adds one or more values to processors.

processors

public final PutPipelineRequest.Builder processors(Function<Processor.Builder,ObjectBuilder<Processor>> fn)

API name: processors

Adds a value to processors using a builder lambda.

timeout

public final PutPipelineRequest.Builder timeout(@Nullable
 Time value)

Explicit operation timeout

API name: timeout

timeout

public final PutPipelineRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

version

public final PutPipelineRequest.Builder version(@Nullable
 Long value)

API name: version

self

protected PutPipelineRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutPipelineRequest.Builder>

build

public PutPipelineRequest build()

Builds a PutPipelineRequest.

Specified by:

build in interface ObjectBuilder<PutPipelineRequest>

Throws:

NullPointerException - if some of the required fields are null.