Package org.opensearch.client.opensearch.search_pipeline

Class GetSearchPipelineRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.search_pipeline.GetSearchPipelineRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetSearchPipelineRequest

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

Builder for GetSearchPipelineRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetSearchPipelineRequest	build()	Builds a GetSearchPipelineRequest.
final GetSearchPipelineRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	operation timeout for connection to cluster-manager node.
final GetSearchPipelineRequest.Builder	clusterManagerTimeout(Time value)	operation timeout for connection to cluster-manager node.
GetSearchPipelineRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetSearchPipelineRequest.Builder	id(String value)	Comma-separated list of search pipeline ids.
protected GetSearchPipelineRequest.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 GetSearchPipelineRequest.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<GetSearchPipelineRequest.Builder,GetSearchPipelineRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetSearchPipelineRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetSearchPipelineRequest.Builder>

clusterManagerTimeout

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

operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

id

@Nonnull
public final GetSearchPipelineRequest.Builder id(@Nullable
 String value)

Comma-separated list of search pipeline ids. Wildcards supported.

API name: id

build

@Nonnull
public GetSearchPipelineRequest build()

Builds a GetSearchPipelineRequest.

Specified by:

build in interface ObjectBuilder<GetSearchPipelineRequest>

Throws:

NullPointerException - if some of the required fields are null.