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

@JsonpDeserializable
public class PutScriptRequest
extends RequestBase
implements PlainJsonSerializable

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 JsonpDeserializer<PutScriptRequest>	_DESERIALIZER	Json deserializer for PutScriptRequest
static Endpoint<PutScriptRequest,PutScriptResponse,ErrorResponse>	_ENDPOINT	Endpoint "put_script".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
java.lang.String	context()	Script context
java.lang.String	id()	Required - Script ID
Time	masterTimeout()	Deprecated.
static PutScriptRequest	of(java.util.function.Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)
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)
Time	timeout()	Explicit operation timeout
PutScriptRequest.Builder	toBuilder()

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.json.PlainJsonSerializable

toJsonString

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<PutScriptRequest> _DESERIALIZER

Json deserializer for PutScriptRequest

_ENDPOINT

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

Endpoint "put_script".

Method Detail

of

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

context

@Nullable
public final java.lang.String context()

Script context

API name: context

id

public final java.lang.String id()

Required - Script ID

API name: id

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

script

public final StoredScript script()

Required - API name: script

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

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

public PutScriptRequest.Builder toBuilder()

setupPutScriptRequestDeserializer

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