Class CreateIndexRequestParameters

Request options for Create

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/

Inheritance

object

RequestParameters<CreateIndexRequestParameters>

CreateIndexRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<CreateIndexRequestParameters>.CustomResponseBuilder

RequestParameters<CreateIndexRequestParameters>.QueryString

RequestParameters<CreateIndexRequestParameters>.RequestConfiguration

RequestParameters<CreateIndexRequestParameters>.ContainsQueryString(string)

RequestParameters<CreateIndexRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<CreateIndexRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<CreateIndexRequestParameters>.SetQueryString(string, object)

RequestParameters<CreateIndexRequestParameters>.Q<TOut>(string)

RequestParameters<CreateIndexRequestParameters>.Q(string, object)

RequestParameters<CreateIndexRequestParameters>.SetAcceptHeader(string)

RequestParameters<CreateIndexRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.IndicesApi

Assembly: OpenSearch.Net.dll

Syntax

public class CreateIndexRequestParameters : RequestParameters<CreateIndexRequestParameters>, IRequestParameters

Properties

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration

public TimeSpan ClusterManagerTimeout { get; set; }

Property Value

Type	Description
TimeSpan

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<CreateIndexRequestParameters>.DefaultHttpMethod

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

MasterTimeout

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration

[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public TimeSpan MasterTimeout { get; set; }

Property Value

Type	Description
TimeSpan

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<CreateIndexRequestParameters>.SupportsBody

Timeout

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

WaitForActiveShards

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

Declaration

public string WaitForActiveShards { get; set; }

Property Value

Type	Description
string

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)