Class CreateIndexDescriptor
Descriptor for Create
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/
Inheritance
CreateIndexDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class CreateIndexDescriptor : RequestDescriptorBase<CreateIndexDescriptor, CreateIndexRequestParameters, ICreateIndexRequest>, IDescriptor, ICreateIndexRequest, IIndexState, IRequest<CreateIndexRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
CreateIndexDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected CreateIndexDescriptor()
|
Edit this page
View Source
CreateIndexDescriptor(IndexName)
Declaration
public CreateIndexDescriptor(IndexName index)
Parameters
Type |
Name |
Description |
IndexName |
index |
this parameter is required
|
Methods
|
Edit this page
View Source
Aliases(Func<AliasesDescriptor, IPromise<IAliases>>)
Declaration
public CreateIndexDescriptor Aliases(Func<AliasesDescriptor, IPromise<IAliases>> selector)
Parameters
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public CreateIndexDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
IncludeTypeName(bool?)
Whether a type should be expected in the body of the mappings.
Declaration
public CreateIndexDescriptor IncludeTypeName(bool? includetypename = true)
Parameters
Type |
Name |
Description |
bool? |
includetypename |
|
Returns
|
Edit this page
View Source
Index(IndexName)
Declaration
public CreateIndexDescriptor Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public CreateIndexDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
InitializeUsing(IIndexState)
Declaration
public CreateIndexDescriptor InitializeUsing(IIndexState indexSettings)
Parameters
Returns
|
Edit this page
View Source
Map(Func<TypeMappingDescriptor<object>, ITypeMapping>)
Declaration
public CreateIndexDescriptor Map(Func<TypeMappingDescriptor<object>, ITypeMapping> selector)
Parameters
Returns
|
Edit this page
View Source
Map<T>(Func<TypeMappingDescriptor<T>, ITypeMapping>)
Declaration
public CreateIndexDescriptor Map<T>(Func<TypeMappingDescriptor<T>, ITypeMapping> selector) where T : class
Parameters
Returns
Type Parameters
|
Edit this page
View Source
Mappings(Func<MappingsDescriptor, ITypeMapping>)
Declaration
[Obsolete("Mappings is no longer a dictionary, please use the simplified Map() method on this descriptor instead")]
public CreateIndexDescriptor Mappings(Func<MappingsDescriptor, ITypeMapping> selector)
Parameters
Returns
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public CreateIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)
Declaration
public CreateIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector)
Parameters
Returns
|
Edit this page
View Source
Timeout(Time)
Explicit operation timeout
Declaration
public CreateIndexDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
WaitForActiveShards(string)
Set the number of active shards to wait for before the operation returns.
Declaration
public CreateIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type |
Name |
Description |
string |
waitforactiveshards |
|
Returns
Implements
Extension Methods