Package org.opensearch.client.opensearch.search_pipeline

Class PutSearchPipelineRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.search_pipeline.PutSearchPipelineRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PutSearchPipelineRequest

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

Builder for PutSearchPipelineRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutSearchPipelineRequest	build()	Builds a PutSearchPipelineRequest.
final PutSearchPipelineRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	operation timeout for connection to cluster-manager node.
final PutSearchPipelineRequest.Builder	clusterManagerTimeout(Time value)	operation timeout for connection to cluster-manager node.
PutSearchPipelineRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutSearchPipelineRequest.Builder	description(String value)	API name: description
final PutSearchPipelineRequest.Builder	id(String value)	Required - Pipeline ID.
final PutSearchPipelineRequest.Builder	phaseResultsProcessors(Function<PhaseResultsProcessor.Builder,ObjectBuilder<PhaseResultsProcessor>> fn)	API name: phase_results_processors
final PutSearchPipelineRequest.Builder	phaseResultsProcessors(List<PhaseResultsProcessor> list)	API name: phase_results_processors
final PutSearchPipelineRequest.Builder	phaseResultsProcessors(PhaseResultsProcessor value, PhaseResultsProcessor... values)	API name: phase_results_processors
final PutSearchPipelineRequest.Builder	requestProcessors(Function<RequestProcessor.Builder,ObjectBuilder<RequestProcessor>> fn)	API name: request_processors
final PutSearchPipelineRequest.Builder	requestProcessors(List<RequestProcessor> list)	API name: request_processors
final PutSearchPipelineRequest.Builder	requestProcessors(RequestProcessor value, RequestProcessor... values)	API name: request_processors
final PutSearchPipelineRequest.Builder	responseProcessors(Function<ResponseProcessor.Builder,ObjectBuilder<ResponseProcessor>> fn)	API name: response_processors
final PutSearchPipelineRequest.Builder	responseProcessors(List<ResponseProcessor> list)	API name: response_processors
final PutSearchPipelineRequest.Builder	responseProcessors(ResponseProcessor value, ResponseProcessor... values)	API name: response_processors
protected PutSearchPipelineRequest.Builder	self()
final PutSearchPipelineRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout.
final PutSearchPipelineRequest.Builder	timeout(Time value)	Operation timeout.
final PutSearchPipelineRequest.Builder	version(Integer 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 PutSearchPipelineRequest.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<PutSearchPipelineRequest.Builder,PutSearchPipelineRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutSearchPipelineRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutSearchPipelineRequest.Builder>

clusterManagerTimeout

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

operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

description

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

API name: description

id

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

Required - Pipeline ID.

API name: id

phaseResultsProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder phaseResultsProcessors(List<PhaseResultsProcessor> list)

API name: phase_results_processors

Adds all elements of list to phaseResultsProcessors.

phaseResultsProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder phaseResultsProcessors(PhaseResultsProcessor value,
 PhaseResultsProcessor... values)

API name: phase_results_processors

Adds one or more values to phaseResultsProcessors.

phaseResultsProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder phaseResultsProcessors(Function<PhaseResultsProcessor.Builder,ObjectBuilder<PhaseResultsProcessor>> fn)

API name: phase_results_processors

Adds a value to phaseResultsProcessors using a builder lambda.

requestProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder requestProcessors(List<RequestProcessor> list)

API name: request_processors

Adds all elements of list to requestProcessors.

requestProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder requestProcessors(RequestProcessor value,
 RequestProcessor... values)

API name: request_processors

Adds one or more values to requestProcessors.

requestProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder requestProcessors(Function<RequestProcessor.Builder,ObjectBuilder<RequestProcessor>> fn)

API name: request_processors

Adds a value to requestProcessors using a builder lambda.

responseProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder responseProcessors(List<ResponseProcessor> list)

API name: response_processors

Adds all elements of list to responseProcessors.

responseProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder responseProcessors(ResponseProcessor value,
 ResponseProcessor... values)

API name: response_processors

Adds one or more values to responseProcessors.

responseProcessors

@Nonnull
public final PutSearchPipelineRequest.Builder responseProcessors(Function<ResponseProcessor.Builder,ObjectBuilder<ResponseProcessor>> fn)

API name: response_processors

Adds a value to responseProcessors using a builder lambda.

timeout

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

Operation timeout.

API name: timeout

timeout

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

Operation timeout.

API name: timeout

version

@Nonnull
public final PutSearchPipelineRequest.Builder version(@Nullable
 Integer value)

API name: version

build

@Nonnull
public PutSearchPipelineRequest build()

Builds a PutSearchPipelineRequest.

Specified by:

build in interface ObjectBuilder<PutSearchPipelineRequest>

Throws:

NullPointerException - if some of the required fields are null.