Class DynamicIndexSettings
Implements
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class DynamicIndexSettings : IsADictionaryBase<string, object>, IDynamicIndexSettings, IIsADictionary<string, object>, IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IIsADictionaryConstructors
| Edit this page View SourceDynamicIndexSettings()
Declaration
public DynamicIndexSettings()DynamicIndexSettings(IDictionary<string, object>)
Declaration
public DynamicIndexSettings(IDictionary<string, object> container)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<string, object> | container |
Properties
| Edit this page View SourceAnalysis
Configure analysis
Declaration
public IAnalysis Analysis { get; set; }Property Value
| Type | Description |
|---|---|
| IAnalysis |
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 AutoExpandReplicas AutoExpandReplicas { get; set; }Property Value
| Type | Description |
|---|---|
| Auto |
BlocksMetadata
Set to true to disable index metadata reads and writes.
Declaration
public bool? BlocksMetadata { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
BlocksRead
Set to true to disable read operations against the index.
Declaration
public bool? BlocksRead { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
BlocksReadOnly
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
Declaration
public bool? BlocksReadOnly { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
BlocksReadOnlyAllowDelete
Set to true to disable read operations, but allow delete operations, against the index.
Declaration
public bool? BlocksReadOnlyAllowDelete { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
BlocksWrite
Set to true to disable write operations against the index.
Declaration
public bool? BlocksWrite { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
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
public string DefaultPipeline { get; set; }Property Value
| Type | Description |
|---|---|
| string |
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
public string FinalPipeline { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Merge
All of the settings exposed in the merge module are expert only and may be obsoleted in the future at any time!
Declaration
public IMergeSettings Merge { get; set; }Property Value
| Type | Description |
|---|---|
| IMerge |
NumberOfReplicas
The number of replicas each primary shard has. Defaults to 1.
Declaration
public int? NumberOfReplicas { get; set; }Property Value
| Type | Description |
|---|---|
| int? |
Priority
Unallocated shards are recovered in order of priority when set
Declaration
public int? Priority { get; set; }Property Value
| Type | Description |
|---|---|
| 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 Union<int, RecoveryInitialShards> RecoveryInitialShards { get; set; }Property Value
| Type | Description |
|---|---|
| Union<int, Recovery |
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
public Time RefreshInterval { get; set; }Property Value
| Type | Description |
|---|---|
| Time |
RequestsCacheEnabled
Enables the shard-level request cache. Not enabled by default.
Declaration
public bool? RequestsCacheEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
RoutingAllocationTotalShardsPerNode
The maximum number of shards (replicas and primaries) that will be allocated to a single node. Defaults to unbounded.
Declaration
public int? RoutingAllocationTotalShardsPerNode { get; set; }Property Value
| Type | Description |
|---|---|
| int? |
Similarity
Configure similarity
Declaration
public ISimilarities Similarity { get; set; }Property Value
| Type | Description |
|---|---|
| ISimilarities |
SlowLog
Configure logging thresholds and levels in OpenSearch for search/fetch and indexing
Declaration
public ISlowLog SlowLog { get; set; }Property Value
| Type | Description |
|---|---|
| ISlow |
Translog
Configure translog settings. This should only be used by experts who know what they're doing
Declaration
public ITranslogSettings Translog { get; set; }Property Value
| Type | Description |
|---|---|
| ITranslog |
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
public Time UnassignedNodeLeftDelayedTimeout { get; set; }Property Value
| Type | Description |
|---|---|
| Time |
Methods
| Edit this page View SourceAdd(string, object)
Add any setting to the index
Declaration
public void Add(string setting, object value)