Package org.opensearch.client.opensearch.core

Class PutScriptRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.core.PutScriptRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PutScriptRequest

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

Builder for PutScriptRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutScriptRequest	build()	Builds a PutScriptRequest.
final PutScriptRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final PutScriptRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
final PutScriptRequest.Builder	context(String value)	Context in which the script or search template should run.
PutScriptRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutScriptRequest.Builder	id(String value)	Required - Identifier for the stored script or search template.
final PutScriptRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutScriptRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutScriptRequest.Builder	script(Function<StoredScript.Builder,ObjectBuilder<StoredScript>> fn)	Required - API name: script
final PutScriptRequest.Builder	script(StoredScript value)	Required - API name: script
protected PutScriptRequest.Builder	self()
final PutScriptRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final PutScriptRequest.Builder	timeout(Time value)	Period 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 PutScriptRequest.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<PutScriptRequest.Builder,PutScriptRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutScriptRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutScriptRequest.Builder>

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

context

@Nonnull
public final PutScriptRequest.Builder context(@Nullable
 String value)

Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.

API name: context

id

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

Required - Identifier for the stored script or search template. Must be unique within the cluster.

API name: id

masterTimeout

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

script

@Nonnull
public final PutScriptRequest.Builder script(StoredScript value)

Required - API name: script

script

@Nonnull
public final PutScriptRequest.Builder script(Function<StoredScript.Builder,ObjectBuilder<StoredScript>> fn)

Required - API name: script

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

build

@Nonnull
public PutScriptRequest build()

Builds a PutScriptRequest.

Specified by:

build in interface ObjectBuilder<PutScriptRequest>

Throws:

NullPointerException - if some of the required fields are null.