Class IndexSettings

The settings for an index

Inheritance
object
IsADictionaryBase<string, object>
DynamicIndexSettings
IndexSettings
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class IndexSettings : DynamicIndexSettings, IIndexSettings, IDynamicIndexSettings, IIsADictionary<string, object>, IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IIsADictionary

Constructors

| Edit this page View Source

IndexSettings()

Declaration
public IndexSettings()
| Edit this page View Source

IndexSettings(IDictionary<string, object>)

Declaration
public IndexSettings(IDictionary<string, object> container)
Parameters
Type Name Description
IDictionary<string, object> container

Properties

| Edit this page View Source

FileSystemStorageImplementation

The store module allows you to control how index data is stored and accessed on disk.

EXPERT MODE toggle

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

Hidden

Indicates whether the index should be hidden by default. Hidden indices are not returned by default when using a wildcard expression.

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

NumberOfRoutingShards

The number of routing shards. Used in conjunction with the Split Index API. If specified, must be greater than or equal to NumberOfShards

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

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

Queries

Settings associated with queries.

Declaration
public IQueriesSettings Queries { get; set; }
Property Value
Type Description
IQueriesSettings
| Edit this page View Source

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

SoftDeletes

Soft delete settings for the index

Declaration
public ISoftDeleteSettings SoftDeletes { get; set; }
Property Value
Type Description
ISoftDeleteSettings
| Edit this page View Source

Sorting

Settings associated with index sorting.

Declaration
public ISortingSettings Sorting { get; set; }
Property Value
Type Description
ISortingSettings

Implements

Extension Methods