Class PutScriptRequest

Request for PutScript

https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/

Inheritance
object
RequestBase<PutScriptRequestParameters>
PlainRequestBase<PutScriptRequestParameters>
PutScriptRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PutScriptRequest : PlainRequestBase<PutScriptRequestParameters>, IPutScriptRequest, IRequest<PutScriptRequestParameters>, IRequest

Constructors

| Edit this page View Source

PutScriptRequest()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected PutScriptRequest()
| Edit this page View Source

PutScriptRequest(Id)

/_scripts/{id}

Declaration
public PutScriptRequest(Id id)
Parameters
Type Name Description
Id id

this parameter is required
| Edit this page View Source

PutScriptRequest(Id, Name)

/_scripts/{id}/{context}

Declaration
public PutScriptRequest(Id id, Name context)
Parameters
Type Name Description
Id id

this parameter is required
Name context

Optional, accepts null

Properties

| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

MasterTimeout

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.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Script

Declaration
public IStoredScript Script { get; set; }
Property Value
Type Description
IStoredScript
| Edit this page View Source

Self

Declaration
protected IPutScriptRequest Self { get; }
Property Value
Type Description
IPutScriptRequest
| Edit this page View Source

Timeout

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

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time

Implements

Extension Methods