Interface IIndexSettings
The settings for an index
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IIndexSettings : IDynamicIndexSettings, IIsADictionary<string, object>, IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IIsADictionary
Properties
| Edit this page View SourceFileSystemStorageImplementation
The store module allows you to control how index data is stored and accessed on disk.
EXPERT MODE toggle
Declaration
FileSystemStorageImplementation? FileSystemStorageImplementation { get; set; }
Property Value
Type | Description |
---|---|
File |
Hidden
Indicates whether the index should be hidden by default. Hidden indices are not returned by default when using a wildcard expression.
Declaration
bool? Hidden { get; set; }
Property Value
Type | Description |
---|---|
bool? |
NumberOfRoutingShards
The number of routing shards. Used in conjunction with the Split Index API. If specified, must be
greater than or equal to Number
Declaration
int? NumberOfRoutingShards { get; set; }
Property Value
Type | Description |
---|---|
int? |
NumberOfShards
The number of primary shards that an index should have. Defaults to 1. This setting can only be set at index creation time. It cannot be changed on a closed index.
Declaration
int? NumberOfShards { get; set; }
Property Value
Type | Description |
---|---|
int? |
Queries
Settings associated with queries.
Declaration
IQueriesSettings Queries { get; set; }
Property Value
Type | Description |
---|---|
IQueries |
RoutingPartitionSize
By defaulting, routing resolves to a single shard. Use this settings to have it resolve to a set of shards instead. This mitigates creating hotspots and very large shards if you have a few routing keys generating the significant data.
Declaration
int? RoutingPartitionSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
SoftDeletes
Soft delete settings for the index
Declaration
ISoftDeleteSettings SoftDeletes { get; set; }
Property Value
Type | Description |
---|---|
ISoft |
Sorting
Settings associated with index sorting.
Declaration
ISortingSettings Sorting { get; set; }
Property Value
Type | Description |
---|---|
ISorting |