Class CloneIndexRequestParameters

Request options for Clone

https://opensearch.org/docs/latest/api-reference/index-apis/clone/

Inheritance
object
RequestParameters<CloneIndexRequestParameters>
CloneIndexRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.IndicesApi
Assembly: OpenSearch.Net.dll
Syntax
public class CloneIndexRequestParameters : RequestParameters<CloneIndexRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| 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 TimeSpan MasterTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

TaskExecutionTimeout

Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

Declaration
public TimeSpan TaskExecutionTimeout { get; set; }
Property Value
Type Description
TimeSpan
| 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 TimeSpan Timeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

WaitForActiveShards

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

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

WaitForCompletion

Should this request wait until the operation has completed before returning.

Declaration
public bool? WaitForCompletion { get; set; }
Property Value
Type Description
bool?
Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

Implements

Extension Methods