Package org.opensearch.client.opensearch.ingest

Class GetPipelineRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.GetPipelineRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetPipelineRequest

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

Builder for GetPipelineRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetPipelineRequest	build()	Builds a GetPipelineRequest.
final GetPipelineRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final GetPipelineRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
GetPipelineRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetPipelineRequest.Builder	id(String value)	A comma-separated list of pipeline IDs to retrieve.
final GetPipelineRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final GetPipelineRequest.Builder	masterTimeout(Time value)	Deprecated.
protected GetPipelineRequest.Builder	self()

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

Returns:

a new builder instance.

self

@Nonnull
protected GetPipelineRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetPipelineRequest.Builder>

clusterManagerTimeout

@Nonnull
public final GetPipelineRequest.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 GetPipelineRequest.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 GetPipelineRequest.Builder id(@Nullable
 String value)

A comma-separated list of pipeline IDs to retrieve. Wildcard (*) expressions are supported. To get all ingest pipelines, omit this parameter or use *.

API name: id

masterTimeout

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

build

@Nonnull
public GetPipelineRequest build()

Builds a GetPipelineRequest.

Specified by:

build in interface ObjectBuilder<GetPipelineRequest>

Throws:

NullPointerException - if some of the required fields are null.