Class CreateIndexRequest
Request for Create
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/
Inheritance
CreateIndexRequest
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CreateIndexRequest : PlainRequestBase<CreateIndexRequestParameters>, ICreateIndexRequest, IIndexState, IRequest<CreateIndexRequestParameters>, IRequest
Constructors
| Edit this page View SourceCreateIndexRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected CreateIndexRequest()
CreateIndexRequest(IndexName)
/{index}
Declaration
public CreateIndexRequest(IndexName index)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index | this parameter is required |
CreateIndexRequest(IndexName, IIndexState)
Declaration
public CreateIndexRequest(IndexName index, IIndexState state)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index | |
IIndexState | state |
Properties
| Edit this page View SourceAliases
Declaration
public IAliases Aliases { get; set; }
Property Value
Type | Description |
---|---|
IAliases |
ClusterManagerTimeout
Specify timeout for connection to cluster_manager node
Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout
IncludeTypeName
Whether a type should be expected in the body of the mappings.
Declaration
public bool? IncludeTypeName { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Remarks
Deprecated as of OpenSearch 2.0
Mappings
Declaration
public ITypeMapping Mappings { get; set; }
Property Value
Type | Description |
---|---|
ITypeMapping |
MasterTimeout
Specify timeout for connection to master node
Declaration
public Time MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout instead
Self
Declaration
protected ICreateIndexRequest Self { get; }
Property Value
Type | Description |
---|---|
ICreateIndexRequest |
Settings
Declaration
public IIndexSettings Settings { get; set; }
Property Value
Type | Description |
---|---|
IIndexSettings |
Timeout
Explicit operation timeout
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
WaitForActiveShards
Set the number of active shards to wait for before the operation returns.
Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type | Description |
---|---|
string |