Class LowLevelCatNamespace

Cat APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelCatNamespace

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)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.CatApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelCatNamespace : NamespacedClientProxy

Properties

ContentType

Declaration

protected override string ContentType { get; }

Property Value

Type	Description
string

Overrides

NamespacedClientProxy.ContentType

Methods

AliasesAsync<TResponse>(CatAliasesRequestParameters, CancellationToken)

GET on /_cat/aliases

https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

AliasesAsync<TResponse>(string, CatAliasesRequestParameters, CancellationToken)

GET on /_cat/aliases/{name}

https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/

Declaration

public Task<TResponse> AliasesAsync<TResponse>(string name, CatAliasesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
CatAliasesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Aliases<TResponse>(CatAliasesRequestParameters)

GET on /_cat/aliases

https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/

Declaration

public TResponse Aliases<TResponse>(CatAliasesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Aliases<TResponse>(string, CatAliasesRequestParameters)

GET on /_cat/aliases/{name}

https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/

Declaration

public TResponse Aliases<TResponse>(string name, CatAliasesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
CatAliasesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

AllPitSegmentsAsync<TResponse>(CatAllPitSegmentsRequestParameters, CancellationToken)

GET on /_cat/pit_segments/_all

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

Declaration

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

Parameters

Type	Name	Description
CatAllPitSegmentsRequestParameters	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.4.0 or greater.

AllPitSegments<TResponse>(CatAllPitSegmentsRequestParameters)

GET on /_cat/pit_segments/_all

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

Declaration

public TResponse AllPitSegments<TResponse>(CatAllPitSegmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
CatAllPitSegmentsRequestParameters	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.4.0 or greater.

AllocationAsync<TResponse>(CatAllocationRequestParameters, CancellationToken)

GET on /_cat/allocation

https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

AllocationAsync<TResponse>(string, CatAllocationRequestParameters, CancellationToken)

GET on /_cat/allocation/{node_id}

https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/

Declaration

public Task<TResponse> AllocationAsync<TResponse>(string nodeId, CatAllocationRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names used to limit the returned information.
CatAllocationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Allocation<TResponse>(CatAllocationRequestParameters)

GET on /_cat/allocation

https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/

Declaration

public TResponse Allocation<TResponse>(CatAllocationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Allocation<TResponse>(string, CatAllocationRequestParameters)

GET on /_cat/allocation/{node_id}

https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/

Declaration

public TResponse Allocation<TResponse>(string nodeId, CatAllocationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names used to limit the returned information.
CatAllocationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ClusterManagerAsync<TResponse>(CatClusterManagerRequestParameters, CancellationToken)

GET on /_cat/cluster_manager

https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/

Declaration

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

Parameters

Type	Name	Description
CatClusterManagerRequestParameters	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.0.0 or greater.

ClusterManager<TResponse>(CatClusterManagerRequestParameters)

GET on /_cat/cluster_manager

https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/

Declaration

public TResponse ClusterManager<TResponse>(CatClusterManagerRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
CatClusterManagerRequestParameters	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.0.0 or greater.

CountAsync<TResponse>(CatCountRequestParameters, CancellationToken)

GET on /_cat/count

https://opensearch.org/docs/latest/api-reference/cat/cat-count/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

CountAsync<TResponse>(string, CatCountRequestParameters, CancellationToken)

GET on /_cat/count/{index}

https://opensearch.org/docs/latest/api-reference/cat/cat-count/

Declaration

public Task<TResponse> CountAsync<TResponse>(string index, CatCountRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatCountRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Count<TResponse>(CatCountRequestParameters)

GET on /_cat/count

https://opensearch.org/docs/latest/api-reference/cat/cat-count/

Declaration

public TResponse Count<TResponse>(CatCountRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Count<TResponse>(string, CatCountRequestParameters)

GET on /_cat/count/{index}

https://opensearch.org/docs/latest/api-reference/cat/cat-count/

Declaration

public TResponse Count<TResponse>(string index, CatCountRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatCountRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

FielddataAsync<TResponse>(CatFielddataRequestParameters, CancellationToken)

GET on /_cat/fielddata

https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

FielddataAsync<TResponse>(string, CatFielddataRequestParameters, CancellationToken)

GET on /_cat/fielddata/{fields}

https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/

Declaration

public Task<TResponse> FielddataAsync<TResponse>(string fields, CatFielddataRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	fields	A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter.
CatFielddataRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Fielddata<TResponse>(CatFielddataRequestParameters)

GET on /_cat/fielddata

https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/

Declaration

public TResponse Fielddata<TResponse>(CatFielddataRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Fielddata<TResponse>(string, CatFielddataRequestParameters)

GET on /_cat/fielddata/{fields}

https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/

Declaration

public TResponse Fielddata<TResponse>(string fields, CatFielddataRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	fields	A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter.
CatFielddataRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

HealthAsync<TResponse>(CatHealthRequestParameters, CancellationToken)

GET on /_cat/health

https://opensearch.org/docs/latest/api-reference/cat/cat-health/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Health<TResponse>(CatHealthRequestParameters)

GET on /_cat/health

https://opensearch.org/docs/latest/api-reference/cat/cat-health/

Declaration

public TResponse Health<TResponse>(CatHealthRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

HelpAsync<TResponse>(CatHelpRequestParameters, CancellationToken)

GET on /_cat

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Help<TResponse>(CatHelpRequestParameters)

GET on /_cat

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

IndicesAsync<TResponse>(CatIndicesRequestParameters, CancellationToken)

GET on /_cat/indices

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

IndicesAsync<TResponse>(string, CatIndicesRequestParameters, CancellationToken)

GET on /_cat/indices/{index}

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

Declaration

public Task<TResponse> IndicesAsync<TResponse>(string index, CatIndicesRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatIndicesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Indices<TResponse>(CatIndicesRequestParameters)

GET on /_cat/indices

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Indices<TResponse>(string, CatIndicesRequestParameters)

GET on /_cat/indices/{index}

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

Declaration

public TResponse Indices<TResponse>(string index, CatIndicesRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatIndicesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

MasterAsync<TResponse>(CatMasterRequestParameters, CancellationToken)

GET on /_cat/master

https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/

Declaration

[Obsolete("Deprecated in version 2.0.0: To promote inclusive language, use '/_cat/cluster_manager' instead.")]
public Task<TResponse> MasterAsync<TResponse>(CatMasterRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Master<TResponse>(CatMasterRequestParameters)

GET on /_cat/master

https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/

Declaration

[Obsolete("Deprecated in version 2.0.0: To promote inclusive language, use '/_cat/cluster_manager' instead.")]
public TResponse Master<TResponse>(CatMasterRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

NodeAttributesAsync<TResponse>(CatNodeAttributesRequestParameters, CancellationToken)

GET on /_cat/nodeattrs

https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

NodeAttributes<TResponse>(CatNodeAttributesRequestParameters)

GET on /_cat/nodeattrs

https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/

Declaration

public TResponse NodeAttributes<TResponse>(CatNodeAttributesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

NodesAsync<TResponse>(CatNodesRequestParameters, CancellationToken)

GET on /_cat/nodes

https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Nodes<TResponse>(CatNodesRequestParameters)

GET on /_cat/nodes

https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/

Declaration

public TResponse Nodes<TResponse>(CatNodesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PendingTasksAsync<TResponse>(CatPendingTasksRequestParameters, CancellationToken)

GET on /_cat/pending_tasks

https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PendingTasks<TResponse>(CatPendingTasksRequestParameters)

GET on /_cat/pending_tasks

https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/

Declaration

public TResponse PendingTasks<TResponse>(CatPendingTasksRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PitSegmentsAsync<TResponse>(PostData, CatPitSegmentsRequestParameters, CancellationToken)

GET on /_cat/pit_segments

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

Declaration

public Task<TResponse> PitSegmentsAsync<TResponse>(PostData body, CatPitSegmentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
CatPitSegmentsRequestParameters	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.4.0 or greater.

PitSegments<TResponse>(PostData, CatPitSegmentsRequestParameters)

GET on /_cat/pit_segments

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

Declaration

public TResponse PitSegments<TResponse>(PostData body, CatPitSegmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
CatPitSegmentsRequestParameters	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.4.0 or greater.

PluginsAsync<TResponse>(CatPluginsRequestParameters, CancellationToken)

GET on /_cat/plugins

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Plugins<TResponse>(CatPluginsRequestParameters)

GET on /_cat/plugins

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

Declaration

public TResponse Plugins<TResponse>(CatPluginsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RecoveryAsync<TResponse>(CatRecoveryRequestParameters, CancellationToken)

GET on /_cat/recovery

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RecoveryAsync<TResponse>(string, CatRecoveryRequestParameters, CancellationToken)

GET on /_cat/recovery/{index}

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

Declaration

public Task<TResponse> RecoveryAsync<TResponse>(string index, CatRecoveryRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatRecoveryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Recovery<TResponse>(CatRecoveryRequestParameters)

GET on /_cat/recovery

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

Declaration

public TResponse Recovery<TResponse>(CatRecoveryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Recovery<TResponse>(string, CatRecoveryRequestParameters)

GET on /_cat/recovery/{index}

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

Declaration

public TResponse Recovery<TResponse>(string index, CatRecoveryRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatRecoveryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RepositoriesAsync<TResponse>(CatRepositoriesRequestParameters, CancellationToken)

GET on /_cat/repositories

https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Repositories<TResponse>(CatRepositoriesRequestParameters)

GET on /_cat/repositories

https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/

Declaration

public TResponse Repositories<TResponse>(CatRepositoriesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SegmentReplicationAsync<TResponse>(CatSegmentReplicationRequestParameters, CancellationToken)

GET on /_cat/segment_replication

https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/

Declaration

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

Parameters

Type	Name	Description
CatSegmentReplicationRequestParameters	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.6.0 or greater.

SegmentReplicationAsync<TResponse>(string, CatSegmentReplicationRequestParameters, CancellationToken)

GET on /_cat/segment_replication/{index}

https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/

Declaration

public Task<TResponse> SegmentReplicationAsync<TResponse>(string index, CatSegmentReplicationRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatSegmentReplicationRequestParameters	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.6.0 or greater.

SegmentReplication<TResponse>(CatSegmentReplicationRequestParameters)

GET on /_cat/segment_replication

https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/

Declaration

public TResponse SegmentReplication<TResponse>(CatSegmentReplicationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
CatSegmentReplicationRequestParameters	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.6.0 or greater.

SegmentReplication<TResponse>(string, CatSegmentReplicationRequestParameters)

GET on /_cat/segment_replication/{index}

https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/

Declaration

public TResponse SegmentReplication<TResponse>(string index, CatSegmentReplicationRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatSegmentReplicationRequestParameters	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.6.0 or greater.

SegmentsAsync<TResponse>(CatSegmentsRequestParameters, CancellationToken)

GET on /_cat/segments

https://opensearch.org/docs/latest/api-reference/cat/cat-segments/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SegmentsAsync<TResponse>(string, CatSegmentsRequestParameters, CancellationToken)

GET on /_cat/segments/{index}

https://opensearch.org/docs/latest/api-reference/cat/cat-segments/

Declaration

public Task<TResponse> SegmentsAsync<TResponse>(string index, CatSegmentsRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatSegmentsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Segments<TResponse>(CatSegmentsRequestParameters)

GET on /_cat/segments

https://opensearch.org/docs/latest/api-reference/cat/cat-segments/

Declaration

public TResponse Segments<TResponse>(CatSegmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Segments<TResponse>(string, CatSegmentsRequestParameters)

GET on /_cat/segments/{index}

https://opensearch.org/docs/latest/api-reference/cat/cat-segments/

Declaration

public TResponse Segments<TResponse>(string index, CatSegmentsRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatSegmentsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ShardsAsync<TResponse>(CatShardsRequestParameters, CancellationToken)

GET on /_cat/shards

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

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ShardsAsync<TResponse>(string, CatShardsRequestParameters, CancellationToken)

GET on /_cat/shards/{index}

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

Declaration

public Task<TResponse> ShardsAsync<TResponse>(string index, CatShardsRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatShardsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Shards<TResponse>(CatShardsRequestParameters)

GET on /_cat/shards

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

Declaration

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

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Shards<TResponse>(string, CatShardsRequestParameters)

GET on /_cat/shards/{index}

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

Declaration

public TResponse Shards<TResponse>(string index, CatShardsRequestParameters 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 (*). To target all data streams and indexes, omit this parameter or use * or _all.
CatShardsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SnapshotsAsync<TResponse>(CatSnapshotsRequestParameters, CancellationToken)

GET on /_cat/snapshots

https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SnapshotsAsync<TResponse>(string, CatSnapshotsRequestParameters, CancellationToken)

GET on /_cat/snapshots/{repository}

https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/

Declaration

public Task<TResponse> SnapshotsAsync<TResponse>(string repository, CatSnapshotsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, OpenSearch returns an error.
CatSnapshotsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Snapshots<TResponse>(CatSnapshotsRequestParameters)

GET on /_cat/snapshots

https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/

Declaration

public TResponse Snapshots<TResponse>(CatSnapshotsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Snapshots<TResponse>(string, CatSnapshotsRequestParameters)

GET on /_cat/snapshots/{repository}

https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/

Declaration

public TResponse Snapshots<TResponse>(string repository, CatSnapshotsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, OpenSearch returns an error.
CatSnapshotsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

TasksAsync<TResponse>(CatTasksRequestParameters, CancellationToken)

GET on /_cat/tasks

https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Tasks<TResponse>(CatTasksRequestParameters)

GET on /_cat/tasks

https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/

Declaration

public TResponse Tasks<TResponse>(CatTasksRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

TemplatesAsync<TResponse>(CatTemplatesRequestParameters, CancellationToken)

GET on /_cat/templates

https://opensearch.org/docs/latest/api-reference/cat/cat-templates/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

TemplatesAsync<TResponse>(string, CatTemplatesRequestParameters, CancellationToken)

GET on /_cat/templates/{name}

https://opensearch.org/docs/latest/api-reference/cat/cat-templates/

Declaration

public Task<TResponse> TemplatesAsync<TResponse>(string name, CatTemplatesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.
CatTemplatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Templates<TResponse>(CatTemplatesRequestParameters)

GET on /_cat/templates

https://opensearch.org/docs/latest/api-reference/cat/cat-templates/

Declaration

public TResponse Templates<TResponse>(CatTemplatesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Templates<TResponse>(string, CatTemplatesRequestParameters)

GET on /_cat/templates/{name}

https://opensearch.org/docs/latest/api-reference/cat/cat-templates/

Declaration

public TResponse Templates<TResponse>(string name, CatTemplatesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.
CatTemplatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ThreadPoolAsync<TResponse>(CatThreadPoolRequestParameters, CancellationToken)

GET on /_cat/thread_pool

https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ThreadPoolAsync<TResponse>(string, CatThreadPoolRequestParameters, CancellationToken)

GET on /_cat/thread_pool/{thread_pool_patterns}

https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/

Declaration

public Task<TResponse> ThreadPoolAsync<TResponse>(string threadPoolPatterns, CatThreadPoolRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	threadPoolPatterns	A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.
CatThreadPoolRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ThreadPool<TResponse>(CatThreadPoolRequestParameters)

GET on /_cat/thread_pool

https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/

Declaration

public TResponse ThreadPool<TResponse>(CatThreadPoolRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ThreadPool<TResponse>(string, CatThreadPoolRequestParameters)

GET on /_cat/thread_pool/{thread_pool_patterns}

https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/

Declaration

public TResponse ThreadPool<TResponse>(string threadPoolPatterns, CatThreadPoolRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	threadPoolPatterns	A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.
CatThreadPoolRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)