Class RolloverIndexRequest

Request for Rollover

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/

Inheritance
object
RequestBase<RolloverIndexRequestParameters>
PlainRequestBase<RolloverIndexRequestParameters>
RolloverIndexRequest
Implements
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 Source

RolloverIndexRequest()

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

Declaration
protected RolloverIndexRequest()
| Edit this page View Source

RolloverIndexRequest(Name)

/{alias}/_rollover

Declaration
public RolloverIndexRequest(Name alias)
Parameters
Type Name Description
Name alias

this parameter is required
| Edit this page View Source

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 Source

Aliases

Declaration
public IAliases Aliases { get; set; }
Property Value
Type Description
IAliases
| 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

Conditions

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

DryRun

If true, checks whether the current index satisfies the specified conditions but does not perform a rollover.

Declaration
public bool? DryRun { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

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

| Edit this page View Source

Mappings

Declaration
public ITypeMapping Mappings { get; set; }
Property Value
Type Description
ITypeMapping
| 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

Self

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

Settings

Declaration
public IIndexSettings Settings { get; set; }
Property Value
Type Description
IIndexSettings
| 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
| 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

Implements

Extension Methods