Package org.opensearch.client.opensearch.ingest

Class DeletePipelineRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.DeletePipelineRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

DeletePipelineRequest

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

Builder for DeletePipelineRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeletePipelineRequest	build()	Builds a DeletePipelineRequest.
final DeletePipelineRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final DeletePipelineRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
DeletePipelineRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DeletePipelineRequest.Builder	id(String value)	Required - The pipeline ID or wildcard expression of pipeline IDs used to limit the request.
final DeletePipelineRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final DeletePipelineRequest.Builder	masterTimeout(Time value)	Deprecated.
protected DeletePipelineRequest.Builder	self()
final DeletePipelineRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response.
final DeletePipelineRequest.Builder	timeout(Time value)	The amount of time to wait for a response.

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

Returns:

a new builder instance.

self

@Nonnull
protected DeletePipelineRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<DeletePipelineRequest.Builder>

clusterManagerTimeout

@Nonnull
public final DeletePipelineRequest.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 DeletePipelineRequest.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

id

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

Required - The pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of *.

API name: id

masterTimeout

@Deprecated
@Nonnull
public final DeletePipelineRequest.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 DeletePipelineRequest.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

timeout

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

The amount of time to wait for a response.

API name: timeout

timeout

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

The amount of time to wait for a response.

API name: timeout

build

@Nonnull
public DeletePipelineRequest build()

Builds a DeletePipelineRequest.

Specified by:

build in interface ObjectBuilder<DeletePipelineRequest>

Throws:

NullPointerException - if some of the required fields are null.