Class RolloverIndexRequest
Request for Rollover
https://opensearch.org/docs/latest/opensearch/data-streams/#step-5-rollover-a-data-stream
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class RolloverIndexRequest : PlainRequestBase<RolloverIndexRequestParameters>, IRolloverIndexRequest, IIndexState, IRequest<RolloverIndexRequestParameters>, IRequest
Constructors
| Edit this page View SourceRolloverIndexRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected RolloverIndexRequest()
RolloverIndexRequest(Name)
/{alias}/_rollover
Declaration
public RolloverIndexRequest(Name alias)
Parameters
Type | Name | Description |
---|---|---|
Name | alias | this parameter is required |
RolloverIndexRequest(Name, IndexName)
/{alias}/_rollover/{new_index}
Declaration
public RolloverIndexRequest(Name alias, IndexName newIndex)
Parameters
Type | Name | Description |
---|---|---|
Name | alias | this parameter is required |
IndexName | newIndex | Optional, accepts null |
Properties
| Edit this page View SourceAliases
Declaration
public IAliases Aliases { get; set; }
Property Value
Type | Description |
---|---|
IAliases |
ClusterManagerTimeout
Specify timeout for connection to cluster_manager node
Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout
Conditions
Declaration
public IRolloverConditions Conditions { get; set; }
Property Value
Type | Description |
---|---|
IRolloverConditions |
DryRun
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
Mappings
Declaration
public ITypeMapping Mappings { get; set; }
Property Value
Type | Description |
---|---|
ITypeMapping |
MasterTimeout
Specify timeout for connection to master node
Declaration
public Time MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout instead
Self
Declaration
protected IRolloverIndexRequest Self { get; }
Property Value
Type | Description |
---|---|
IRolloverIndexRequest |
Settings
Declaration
public IIndexSettings Settings { get; set; }
Property Value
Type | Description |
---|---|
IIndexSettings |
Timeout
Explicit operation timeout
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
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 |