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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutScriptRequest> Json deserializer forPutScriptRequeststatic final Endpoint<PutScriptRequest, PutScriptResponse, ErrorResponse> Endpoint "put_script". -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyQueryParameters(Map<String, String> params) static PutScriptRequest.Builderbuilder()final TimeOperation timeout for connection to cluster-manager node.final Stringcontext()Context in which the script or search template should run.booleaninthashCode()final Stringid()Required - Identifier for the stored script or search template.final TimeDeprecated.static PutScriptRequestfinal StoredScriptscript()Required - API name:scriptvoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal Timetimeout()Period to wait for a response.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forPutScriptRequest -
_ENDPOINT
Endpoint "put_script".
-
-
Method Details
-
of
public static PutScriptRequest of(Function<PutScriptRequest.Builder, ObjectBuilder<PutScriptRequest>> fn) -
clusterManagerTimeout
Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
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
Required - Identifier for the stored script or search template. Must be unique within the cluster.API name:
id -
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
Required - API name:script -
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
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<PutScriptRequest.Builder,PutScriptRequest> - Returns:
- a new builder instance.
-
builder
-
setupPutScriptRequestDeserializer
protected static void setupPutScriptRequestDeserializer(ObjectDeserializer<PutScriptRequest.Builder> op) -
applyQueryParameters
- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode() -
equals
-