Package org.opensearch.client.opensearch.ingest

Class PutPipelineRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

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

Enclosing class:

PutPipelineRequest

public static class PutPipelineRequest.Builder
extends RequestBase.AbstractBuilder<PutPipelineRequest.Builder>
implements CopyableBuilder<PutPipelineRequest.Builder,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	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final PutPipelineRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
PutPipelineRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutPipelineRequest.Builder	description(String value)	The description for the ingest pipeline.
final PutPipelineRequest.Builder	id(String value)	Required - The ID of the ingest pipeline.
final PutPipelineRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutPipelineRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutPipelineRequest.Builder	meta(String key, JsonData value)	API name: _meta
final PutPipelineRequest.Builder	meta(Map<String,JsonData> map)	API name: _meta
final PutPipelineRequest.Builder	onFailure(Function<Processor.Builder,ObjectBuilder<Processor>> fn)	The new processor to run immediately after another processor fails.
final PutPipelineRequest.Builder	onFailure(List<Processor> list)	The new processor to run immediately after another processor fails.
final PutPipelineRequest.Builder	onFailure(Processor value, Processor... values)	The new processor to run immediately after another processor fails.
final PutPipelineRequest.Builder	processors(Function<Processor.Builder,ObjectBuilder<Processor>> fn)	The processors used to perform transformations on documents before indexing.
final PutPipelineRequest.Builder	processors(List<Processor> list)	The processors used to perform transformations on documents before indexing.
final PutPipelineRequest.Builder	processors(Processor value, Processor... values)	The processors used to perform transformations on documents before indexing.
protected PutPipelineRequest.Builder	self()
final PutPipelineRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response.
final PutPipelineRequest.Builder	timeout(Time value)	The amount of time to wait for a response.
final PutPipelineRequest.Builder	version(Long value)	API name: version

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 PutPipelineRequest.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<PutPipelineRequest.Builder,PutPipelineRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutPipelineRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutPipelineRequest.Builder>

clusterManagerTimeout

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

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final PutPipelineRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

description

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

The description for the ingest pipeline.

API name: description

id

@Nonnull
public final PutPipelineRequest.Builder id(String value)

Required - The ID of the ingest pipeline.

API name: id

masterTimeout

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

Deprecated.

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: master_timeout

masterTimeout

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

Deprecated.

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: master_timeout

meta

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

API name: _meta

Adds all elements of map to meta.

meta

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

API name: _meta

Adds an entry to meta.

onFailure

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

The new processor to run immediately after another processor fails. The processors specified in the on_failure parameter run sequentially in the order specified. If no pipeline are specified in on_failure array is specified, OpenSearch will not attempt to run the pipeline's remaining processors.

API name: on_failure

Adds all elements of list to onFailure.

onFailure

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

The new processor to run immediately after another processor fails. The processors specified in the on_failure parameter run sequentially in the order specified. If no pipeline are specified in on_failure array is specified, OpenSearch will not attempt to run the pipeline's remaining processors.

API name: on_failure

Adds one or more values to onFailure.

onFailure

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

The new processor to run immediately after another processor fails. The processors specified in the on_failure parameter run sequentially in the order specified. If no pipeline are specified in on_failure array is specified, OpenSearch will not attempt to run the pipeline's remaining processors.

API name: on_failure

Adds a value to onFailure using a builder lambda.

processors

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

The processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

API name: processors

Adds all elements of list to processors.

processors

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

The processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

API name: processors

Adds one or more values to processors.

processors

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

The processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

API name: processors

Adds a value to processors using a builder lambda.

timeout

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

The amount of time to wait for a response.

API name: timeout

timeout

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

The amount of time to wait for a response.

API name: timeout

version

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

API name: version

build

@Nonnull
public PutPipelineRequest build()

Builds a PutPipelineRequest.

Specified by:

build in interface ObjectBuilder<PutPipelineRequest>

Throws:

NullPointerException - if some of the required fields are null.