Class RolloverIndexRequestParameters
Request options for Rollover
https://opensearch.org/docs/latest/opensearch/data-streams/#step-5-rollover-a-data-stream
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.IndicesApi
Assembly: OpenSearch.Net.dll
Syntax
public class RolloverIndexRequestParameters : RequestParameters<RolloverIndexRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceClusterManagerTimeout
Specify timeout for connection to cluster_manager node
Declaration
public TimeSpan ClusterManagerTimeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
HttpMethod |
Overrides
| Edit this page View SourceDryRun
If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
Declaration
public bool? DryRun { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IncludeTypeName
Whether a type should be included in the body of the mappings.
Declaration
public bool? IncludeTypeName { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Remarks
Deprecated as of OpenSearch 2.0
MasterTimeout
Specify timeout for connection to master node
Declaration
public TimeSpan MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout instead
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
| Edit this page View SourceTimeout
Explicit operation timeout
Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
WaitForActiveShards
Set the number of active shards to wait for on the newly created rollover index before the operation returns.
Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type | Description |
---|---|
string |