Class DynamicIndexSettingsDescriptorBase<TDescriptor, TIndexSettings>

Base descriptor implementation for dynamic index settings

Inheritance
object
DescriptorPromiseBase<TDescriptor, TIndexSettings>
IsADictionaryDescriptorBase<TDescriptor, TIndexSettings, string, object>
DynamicIndexSettingsDescriptorBase<TDescriptor, TIndexSettings>
DynamicIndexSettingsDescriptor
IndexSettingsDescriptor
Implements
IPromise<TIndexSettings>
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public abstract class DynamicIndexSettingsDescriptorBase<TDescriptor, TIndexSettings> : IsADictionaryDescriptorBase<TDescriptor, TIndexSettings, string, object>, IDescriptor, IPromise<TIndexSettings> where TDescriptor : DynamicIndexSettingsDescriptorBase<TDescriptor, TIndexSettings> where TIndexSettings : class, IDynamicIndexSettings
Type Parameters
Name Description
TDescriptor
TIndexSettings

Constructors

| Edit this page View Source

DynamicIndexSettingsDescriptorBase(TIndexSettings)

Declaration
protected DynamicIndexSettingsDescriptorBase(TIndexSettings instance)
Parameters
Type Name Description
TIndexSettings instance

Methods

| Edit this page View Source

Analysis(Func<AnalysisDescriptor, IAnalysis>)

Configure analysis

Declaration
public TDescriptor Analysis(Func<AnalysisDescriptor, IAnalysis> selector)
Parameters
Type Name Description
Func<AnalysisDescriptor, IAnalysis> selector
Returns
Type Description
TDescriptor
| Edit this page View Source

AutoExpandReplicas(AutoExpandReplicas)

Auto-expand the number of replicas based on the number of available nodes. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all). Defaults to false (i.e. disabled).

Declaration
public TDescriptor AutoExpandReplicas(AutoExpandReplicas autoExpandReplicas)
Parameters
Type Name Description
AutoExpandReplicas autoExpandReplicas
Returns
Type Description
TDescriptor
| Edit this page View Source

BlocksMetadata(bool?)

Set to true to disable index metadata reads and writes.

Declaration
public TDescriptor BlocksMetadata(bool? blocksMetadata = true)
Parameters
Type Name Description
bool? blocksMetadata
Returns
Type Description
TDescriptor
| Edit this page View Source

BlocksRead(bool?)

Set to true to disable read operations against the index.

Declaration
public TDescriptor BlocksRead(bool? blocksRead = true)
Parameters
Type Name Description
bool? blocksRead
Returns
Type Description
TDescriptor
| Edit this page View Source

BlocksReadOnly(bool?)

Set to true to make the index and index metadata read only, false to allow writes and metadata changes.

Declaration
public TDescriptor BlocksReadOnly(bool? blocksReadOnly = true)
Parameters
Type Name Description
bool? blocksReadOnly
Returns
Type Description
TDescriptor
| Edit this page View Source

BlocksReadOnlyAllowDelete(bool?)

Set to true to disable read operations, but allow delete operations, against the index.

Declaration
public TDescriptor BlocksReadOnlyAllowDelete(bool? blocksReadOnlyAllowDelete = true)
Parameters
Type Name Description
bool? blocksReadOnlyAllowDelete
Returns
Type Description
TDescriptor
| Edit this page View Source

BlocksWrite(bool?)

Set to true to disable write operations against the index.

Declaration
public TDescriptor BlocksWrite(bool? blocksWrite = true)
Parameters
Type Name Description
bool? blocksWrite
Returns
Type Description
TDescriptor
| Edit this page View Source

DefaultPipeline(string)

The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist. The default may be overridden using the pipeline parameter. The special pipeline name _none indicates no ingest pipeline should be run.`

Declaration
public TDescriptor DefaultPipeline(string defaultPipeline)
Parameters
Type Name Description
string defaultPipeline
Returns
Type Description
TDescriptor
| Edit this page View Source

FinalPipeline(string)

The final ingest pipeline for this index. Index requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.

Declaration
public TDescriptor FinalPipeline(string finalPipeline)
Parameters
Type Name Description
string finalPipeline
Returns
Type Description
TDescriptor
| Edit this page View Source

Merge(Func<MergeSettingsDescriptor, IMergeSettings>)

All of the settings exposed in the merge module are expert only and may be obsoleted in the future at any time!

Declaration
public TDescriptor Merge(Func<MergeSettingsDescriptor, IMergeSettings> merge)
Parameters
Type Name Description
Func<MergeSettingsDescriptor, IMergeSettings> merge
Returns
Type Description
TDescriptor
| Edit this page View Source

NumberOfReplicas(int?)

The number of replicas each primary shard has. Defaults to 1.

Declaration
public TDescriptor NumberOfReplicas(int? numberOfReplicas)
Parameters
Type Name Description
int? numberOfReplicas
Returns
Type Description
TDescriptor
| Edit this page View Source

Priority(int?)

Unallocated shards are recovered in order of priority when set

Declaration
public TDescriptor Priority(int? priority)
Parameters
Type Name Description
int? priority
Returns
Type Description
TDescriptor
| Edit this page View Source

RecoveryInitialShards(Union<int, RecoveryInitialShards>)

A primary shard is only recovered only if there are enough nodes available to allocate sufficient replicas to form a quorum.

Declaration
public TDescriptor RecoveryInitialShards(Union<int, RecoveryInitialShards> initialShards)
Parameters
Type Name Description
Union<int, RecoveryInitialShards> initialShards
Returns
Type Description
TDescriptor
| Edit this page View Source

RefreshInterval(Time)

How often to perform a refresh operation, which makes recent changes to the index visible to search. Defaults to 1s. Can be set to -1 to disable refresh.

Declaration
public TDescriptor RefreshInterval(Time time)
Parameters
Type Name Description
Time time
Returns
Type Description
TDescriptor
| Edit this page View Source

RequestsCacheEnabled(bool?)

Enables the shard-level request cache. Not enabled by default.

Declaration
public TDescriptor RequestsCacheEnabled(bool? enable = true)
Parameters
Type Name Description
bool? enable
Returns
Type Description
TDescriptor
| Edit this page View Source

RoutingAllocationTotalShardsPerNode(int?)

The maximum number of shards (replicas and primaries) that will be allocated to a single node. Defaults to unbounded.

Declaration
public TDescriptor RoutingAllocationTotalShardsPerNode(int? totalShardsPerNode)
Parameters
Type Name Description
int? totalShardsPerNode
Returns
Type Description
TDescriptor
| Edit this page View Source

Setting(string, object)

Add any setting to the index

Declaration
public TDescriptor Setting(string setting, object value)
Parameters
Type Name Description
string setting
object value
Returns
Type Description
TDescriptor
| Edit this page View Source

Similarity(Func<SimilaritiesDescriptor, IPromise<ISimilarities>>)

Configure similarity

Declaration
public TDescriptor Similarity(Func<SimilaritiesDescriptor, IPromise<ISimilarities>> selector)
Parameters
Type Name Description
Func<SimilaritiesDescriptor, IPromise<ISimilarities>> selector
Returns
Type Description
TDescriptor
| Edit this page View Source

SlowLog(Func<SlowLogDescriptor, ISlowLog>)

Configure logging thresholds and levels in OpenSearch for search/fetch and indexing

Declaration
public TDescriptor SlowLog(Func<SlowLogDescriptor, ISlowLog> slowLogSelector)
Parameters
Type Name Description
Func<SlowLogDescriptor, ISlowLog> slowLogSelector
Returns
Type Description
TDescriptor
| Edit this page View Source

Translog(Func<TranslogSettingsDescriptor, ITranslogSettings>)

Configure translog settings. This should only be used by experts who know what they're doing

Declaration
public TDescriptor Translog(Func<TranslogSettingsDescriptor, ITranslogSettings> translogSelector)
Parameters
Type Name Description
Func<TranslogSettingsDescriptor, ITranslogSettings> translogSelector
Returns
Type Description
TDescriptor
| Edit this page View Source

UnassignedNodeLeftDelayedTimeout(Time)

The allocation of replica shards which become unassigned because a node has left can be delayed with this dynamic setting, which defaults to 1m.

Declaration
public TDescriptor UnassignedNodeLeftDelayedTimeout(Time time)
Parameters
Type Name Description
Time time
Returns
Type Description
TDescriptor

Implements

Extension Methods