Class LowLevelListNamespace

List APIs.

Not intended to be instantiated directly. Use the List property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelListNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.ListApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelListNamespace : NamespacedClientProxy

Methods

HelpAsync<TResponse>(HelpRequestParameters, CancellationToken)

GET on /_list

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

Declaration

public Task<TResponse> HelpAsync<TResponse>(HelpRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
HelpRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Help<TResponse>(HelpRequestParameters)

GET on /_list

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

Declaration

public TResponse Help<TResponse>(HelpRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
HelpRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

IndicesAsync<TResponse>(IndicesRequestParameters, CancellationToken)

GET on /_list/indices

https://opensearch.org/docs/latest/api-reference/list/list-indices/

Declaration

public Task<TResponse> IndicesAsync<TResponse>(IndicesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
IndicesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

IndicesAsync<TResponse>(string, IndicesRequestParameters, CancellationToken)

GET on /_list/indices/{index}

https://opensearch.org/docs/latest/api-reference/list/list-indices/

Declaration

public Task<TResponse> IndicesAsync<TResponse>(string index, IndicesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
IndicesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Indices<TResponse>(IndicesRequestParameters)

GET on /_list/indices

https://opensearch.org/docs/latest/api-reference/list/list-indices/

Declaration

public TResponse Indices<TResponse>(IndicesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
IndicesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Indices<TResponse>(string, IndicesRequestParameters)

GET on /_list/indices/{index}

https://opensearch.org/docs/latest/api-reference/list/list-indices/

Declaration

public TResponse Indices<TResponse>(string index, IndicesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
IndicesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

ShardsAsync<TResponse>(ShardsRequestParameters, CancellationToken)

GET on /_list/shards

https://opensearch.org/docs/latest/api-reference/list/list-shards/

Declaration

public Task<TResponse> ShardsAsync<TResponse>(ShardsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ShardsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

ShardsAsync<TResponse>(string, ShardsRequestParameters, CancellationToken)

GET on /_list/shards/{index}

https://opensearch.org/docs/latest/api-reference/list/list-shards/

Declaration

public Task<TResponse> ShardsAsync<TResponse>(string index, ShardsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
ShardsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Shards<TResponse>(ShardsRequestParameters)

GET on /_list/shards

https://opensearch.org/docs/latest/api-reference/list/list-shards/

Declaration

public TResponse Shards<TResponse>(ShardsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ShardsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Shards<TResponse>(string, ShardsRequestParameters)

GET on /_list/shards/{index}

https://opensearch.org/docs/latest/api-reference/list/list-shards/

Declaration

public TResponse Shards<TResponse>(string index, ShardsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
ShardsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)