Package org.opensearch.client.opensearch.ingest

Class PutPipelineRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.PutPipelineRequest.Builder

All Implemented Interfaces:

ObjectBuilder<PutPipelineRequest>

Enclosing class:

PutPipelineRequest

public static class PutPipelineRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<PutPipelineRequest>

Builder for PutPipelineRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

meta

public final PutPipelineRequest.Builder meta(java.util.Map<java.lang.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(java.lang.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
                                                    java.lang.String value)

Description of the ingest pipeline.

API name: description

id

public final PutPipelineRequest.Builder id(java.lang.String value)

Required - Pipeline ID

API name: id

masterTimeout

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

Deprecated.

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

@Deprecated
public final PutPipelineRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

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

clusterManagerTimeout

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

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

API name: cluster_manager_timeout

clusterManagerTimeout

public final PutPipelineRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

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

API name: cluster_manager_timeout

onFailure

public final PutPipelineRequest.Builder onFailure(java.util.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(java.util.function.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(java.util.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(java.util.function.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(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

version

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

API name: version

build

public PutPipelineRequest build()

Builds a PutPipelineRequest.

Specified by:

build in interface ObjectBuilder<PutPipelineRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.