Class RolloverIndexDescriptor
Descriptor for Rollover
https://opensearch.org/docs/latest/opensearch/data-streams/#step-5-rollover-a-data-stream
Inheritance
RolloverIndexDescriptor
Assembly: OpenSearch.Client.dll
Syntax
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)
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
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public RolloverIndexDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
Conditions(Func<RolloverConditionsDescriptor, IRolloverConditions>)
Declaration
public RolloverIndexDescriptor Conditions(Func<RolloverConditionsDescriptor, IRolloverConditions> selector)
Parameters
Returns
|
Edit this page
View Source
DryRun(bool?)
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 RolloverIndexDescriptor DryRun(bool? dryrun = true)
Parameters
Type |
Name |
Description |
bool? |
dryrun |
|
Returns
|
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
|
Edit this page
View Source
Map(Func<TypeMappingDescriptor<object>, ITypeMapping>)
Declaration
public RolloverIndexDescriptor Map(Func<TypeMappingDescriptor<object>, ITypeMapping> selector)
Parameters
Returns
|
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
Returns
Type Parameters
|
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
Returns
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public RolloverIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
NewIndex(IndexName)
The name of the rollover index
Declaration
public RolloverIndexDescriptor NewIndex(IndexName newIndex)
Parameters
Returns
|
Edit this page
View Source
Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)
Declaration
public RolloverIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector)
Parameters
Returns
|
Edit this page
View Source
Timeout(Time)
Explicit operation timeout
Declaration
public RolloverIndexDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
WaitForActiveShards(string)
Set the number of active shards to wait for on the newly created rollover index before the operation returns.
Declaration
public RolloverIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type |
Name |
Description |
string |
waitforactiveshards |
|
Returns
Implements
Extension Methods