Class IndexSettingsDescriptor

The settings for an index

Inheritance
object
DescriptorPromiseBase<IndexSettingsDescriptor, IndexSettings>
IsADictionaryDescriptorBase<IndexSettingsDescriptor, IndexSettings, string, object>
DynamicIndexSettingsDescriptorBase<IndexSettingsDescriptor, IndexSettings>
IndexSettingsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class IndexSettingsDescriptor : DynamicIndexSettingsDescriptorBase<IndexSettingsDescriptor, IndexSettings>, IDescriptor, IPromise<IndexSettings>

Constructors

| Edit this page View Source

IndexSettingsDescriptor()

Declaration
public IndexSettingsDescriptor()

Methods

| Edit this page View Source

FileSystemStorageImplementation(FileSystemStorageImplementation?)

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

EXPERT MODE toggle

Declaration
public IndexSettingsDescriptor FileSystemStorageImplementation(FileSystemStorageImplementation? fs)
Parameters
Type Name Description
FileSystemStorageImplementation? fs
Returns
Type Description
IndexSettingsDescriptor
| Edit this page View Source

Hidden(bool?)

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

Declaration
public IndexSettingsDescriptor Hidden(bool? hidden = true)
Parameters
Type Name Description
bool? hidden
Returns
Type Description
IndexSettingsDescriptor
| Edit this page View Source

NumberOfRoutingShards(int?)

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 IndexSettingsDescriptor NumberOfRoutingShards(int? numberOfRoutingShards)
Parameters
Type Name Description
int? numberOfRoutingShards
Returns
Type Description
IndexSettingsDescriptor
| Edit this page View Source

NumberOfShards(int?)

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 IndexSettingsDescriptor NumberOfShards(int? numberOfShards)
Parameters
Type Name Description
int? numberOfShards
Returns
Type Description
IndexSettingsDescriptor
| Edit this page View Source

Queries(Func<QueriesSettingsDescriptor, IQueriesSettings>)

Settings associated with queries.

Declaration
public IndexSettingsDescriptor Queries(Func<QueriesSettingsDescriptor, IQueriesSettings> selector)
Parameters
Type Name Description
Func<QueriesSettingsDescriptor, IQueriesSettings> selector
Returns
Type Description
IndexSettingsDescriptor
| Edit this page View Source

RoutingPartitionSize(int?)

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 IndexSettingsDescriptor RoutingPartitionSize(int? routingPartitionSize)
Parameters
Type Name Description
int? routingPartitionSize
Returns
Type Description
IndexSettingsDescriptor
| Edit this page View Source

SoftDeletes(Func<SoftDeleteSettingsDescriptor, ISoftDeleteSettings>)

Soft delete settings for the index

Declaration
public IndexSettingsDescriptor SoftDeletes(Func<SoftDeleteSettingsDescriptor, ISoftDeleteSettings> selector)
Parameters
Type Name Description
Func<SoftDeleteSettingsDescriptor, ISoftDeleteSettings> selector
Returns
Type Description
IndexSettingsDescriptor
| Edit this page View Source

Sorting<T>(Func<SortingSettingsDescriptor<T>, ISortingSettings>)

Settings associated with index sorting.

Declaration
public IndexSettingsDescriptor Sorting<T>(Func<SortingSettingsDescriptor<T>, ISortingSettings> selector) where T : class
Parameters
Type Name Description
Func<SortingSettingsDescriptor<T>, ISortingSettings> selector
Returns
Type Description
IndexSettingsDescriptor
Type Parameters
Name Description
T

Implements

Extension Methods