Interface IDynamicIndexSettings

Dynamic index settings

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IDynamicIndexSettings : IIsADictionary<string, object>, IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IIsADictionary

Properties

| Edit this page View Source

Analysis

Configure analysis

Declaration
IAnalysis Analysis { get; set; }
Property Value
Type Description
IAnalysis
| Edit this page View Source

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
AutoExpandReplicas AutoExpandReplicas { get; set; }
Property Value
Type Description
AutoExpandReplicas
| Edit this page View Source

BlocksMetadata

Set to true to disable index metadata reads and writes.

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

BlocksRead

Set to true to disable read operations against the index.

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

BlocksReadOnly

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

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

BlocksReadOnlyAllowDelete

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

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

BlocksWrite

Set to true to disable write operations against the index.

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

DefaultPipeline

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
string DefaultPipeline { get; set; }
Property Value
Type Description
string
| Edit this page View Source

FinalPipeline

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
string FinalPipeline { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Merge

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

Declaration
IMergeSettings Merge { get; set; }
Property Value
Type Description
IMergeSettings
| Edit this page View Source

NumberOfReplicas

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

Declaration
int? NumberOfReplicas { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Priority

Unallocated shards are recovered in order of priority when set

Declaration
int? Priority { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

RecoveryInitialShards

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

Declaration
Union<int, RecoveryInitialShards> RecoveryInitialShards { get; set; }
Property Value
Type Description
Union<int, RecoveryInitialShards>
| Edit this page View Source

RefreshInterval

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
Time RefreshInterval { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

RequestsCacheEnabled

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

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

RoutingAllocationTotalShardsPerNode

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

Declaration
int? RoutingAllocationTotalShardsPerNode { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Similarity

Configure similarity

Declaration
ISimilarities Similarity { get; set; }
Property Value
Type Description
ISimilarities
| Edit this page View Source

SlowLog

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

Declaration
ISlowLog SlowLog { get; set; }
Property Value
Type Description
ISlowLog
| Edit this page View Source

Translog

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

Declaration
ITranslogSettings Translog { get; set; }
Property Value
Type Description
ITranslogSettings
| Edit this page View Source

UnassignedNodeLeftDelayedTimeout

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
Time UnassignedNodeLeftDelayedTimeout { get; set; }
Property Value
Type Description
Time

Extension Methods