public class RolloverIndexDescriptor : RequestDescriptorBase<RolloverIndexDescriptor, RolloverIndexRequestParameters, IRolloverIndexRequest>, IDescriptor, IRolloverIndexRequest, IIndexState, IRequest<RolloverIndexRequestParameters>, IRequest

Constructors

| Edit this page View Source

RolloverIndexDescriptor()

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

Declaration

protected RolloverIndexDescriptor()

| Edit this page View Source

RolloverIndexDescriptor(Name)

/{alias}/_rollover

Declaration

public RolloverIndexDescriptor(Name alias)

Parameters

Type	Name	Description
Name	alias	this parameter is required

| Edit this page View Source

RolloverIndexDescriptor(Name, IndexName)

/{alias}/_rollover/{new_index}

Declaration

public RolloverIndexDescriptor(Name alias, IndexName newIndex)

Parameters

Type	Name	Description
Name	alias	this parameter is required
IndexName	newIndex	Optional, accepts null

Methods

| Edit this page View Source

Aliases(Func<AliasesDescriptor, IPromise<IAliases>>)

Declaration

public RolloverIndexDescriptor Aliases(Func<AliasesDescriptor, IPromise<IAliases>> selector)

Parameters

Type	Name	Description
Func<AliasesDescriptor, IPromise<IAliases>>	selector

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration

public RolloverIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout)

Parameters

Type	Name	Description
Time	clustermanagertimeout

Returns

Type	Description
RolloverIndexDescriptor

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Conditions(Func<RolloverConditionsDescriptor, IRolloverConditions>)

Declaration

public RolloverIndexDescriptor Conditions(Func<RolloverConditionsDescriptor, IRolloverConditions> selector)

Parameters

Type	Name	Description
Func<RolloverConditionsDescriptor, IRolloverConditions>	selector

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

DryRun(bool?)

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

Declaration

public RolloverIndexDescriptor DryRun(bool? dryrun = true)

Parameters

Type	Name	Description
bool?	dryrun

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

IncludeTypeName(bool?)

Whether a type should be included in the body of the mappings.

Declaration

public RolloverIndexDescriptor IncludeTypeName(bool? includetypename = true)

Parameters

Type	Name	Description
bool?	includetypename

Returns

Type	Description
RolloverIndexDescriptor

Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

Map(Func<TypeMappingDescriptor<object>, ITypeMapping>)

Declaration

public RolloverIndexDescriptor Map(Func<TypeMappingDescriptor<object>, ITypeMapping> selector)

Parameters

Type	Name	Description
Func<TypeMappingDescriptor<object>, ITypeMapping>	selector

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

Map<T>(Func<TypeMappingDescriptor<T>, ITypeMapping>)

Declaration

public RolloverIndexDescriptor Map<T>(Func<TypeMappingDescriptor<T>, ITypeMapping> selector) where T : class

Parameters

Type	Name	Description
Func<TypeMappingDescriptor<T>, ITypeMapping>	selector

Returns

Type	Description
RolloverIndexDescriptor

Type Parameters

Name	Description
T

| Edit this page View Source

Mappings(Func<MappingsDescriptor, ITypeMapping>)

Declaration

[Obsolete("Mappings is no longer a dictionary, please use the simplified Map() method on this descriptor instead")]
public RolloverIndexDescriptor Mappings(Func<MappingsDescriptor, ITypeMapping> selector)

Parameters

Type	Name	Description
Func<MappingsDescriptor, ITypeMapping>	selector

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the master 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 RolloverIndexDescriptor MasterTimeout(Time mastertimeout)

Parameters

Type	Name	Description
Time	mastertimeout

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

NewIndex(IndexName)

Name of the index to create. Supports date math. Data streams do not support this parameter.

Declaration

public RolloverIndexDescriptor NewIndex(IndexName newIndex)

Parameters

Type	Name	Description
IndexName	newIndex

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)

Declaration

public RolloverIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector)

Parameters

Type	Name	Description
Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>	selector

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

Timeout(Time)

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

Declaration

public RolloverIndexDescriptor Timeout(Time timeout)

Parameters

Type	Name	Description
Time	timeout

Returns

Type	Description
RolloverIndexDescriptor

| Edit this page View Source

WaitForActiveShards(string)

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 RolloverIndexDescriptor WaitForActiveShards(string waitforactiveshards)

Parameters

Type	Name	Description
string	waitforactiveshards

Returns

Type	Description
RolloverIndexDescriptor

Implements

IDescriptor

IRolloverIndexRequest

IIndexState

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)