Package org.opensearch.client.opensearch.core

Class PutScriptRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.PutScriptRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<PutScriptRequest.Builder,PutScriptRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class PutScriptRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<PutScriptRequest.Builder,PutScriptRequest>

Creates or updates a script.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutScriptRequest.Builder	Builder for PutScriptRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PutScriptRequest>	_DESERIALIZER	Json deserializer for PutScriptRequest
static final Endpoint<PutScriptRequest,PutScriptResponse,ErrorResponse>	_ENDPOINT	Endpoint "put_script".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PutScriptRequest.Builder	builder()
final Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
final String	context()	Context in which the script or search template should run.
boolean	equals(Object o)
int	hashCode()
final String	id()	Required - Identifier for the stored script or search template.
final Time	masterTimeout()	Deprecated.
static PutScriptRequest	of(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)
final StoredScript	script()	Required - API name: script
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPutScriptRequestDeserializer(ObjectDeserializer<PutScriptRequest.Builder> op)
final Time	timeout()	Period to wait for a response.
PutScriptRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutScriptRequest> _DESERIALIZER

Json deserializer for PutScriptRequest

_ENDPOINT

public static final Endpoint<PutScriptRequest,PutScriptResponse,ErrorResponse> _ENDPOINT

Endpoint "put_script".

Method Details

of

public static PutScriptRequest of(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

context

@Nullable
public final String context()

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 String id()

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

API name: id

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

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 StoredScript script()

Required - API name: script

timeout

@Nullable
public final Time timeout()

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

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public PutScriptRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutScriptRequest.Builder,PutScriptRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PutScriptRequest.Builder builder()

setupPutScriptRequestDeserializer

protected static void setupPutScriptRequestDeserializer(ObjectDeserializer<PutScriptRequest.Builder> op)

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object