Search Results for

    Show / Hide Table of Contents

    Interface ICatNamespace

    Cat APIs.

    Use the Cat property on IOpenSearchClient.

    Namespace: OpenSearch.Client.Specification.CatApi
    Assembly: OpenSearch.Client.dll
    Syntax
    public interface ICatNamespace

    Methods

    | Edit this page View Source

    Aliases(ICatAliasesRequest)

    GET request to the cat.aliases API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
    Declaration
    CatResponse<CatAliasesRecord> Aliases(ICatAliasesRequest request)
    Parameters
    Type Name Description
    ICatAliasesRequest request
    Returns
    Type Description
    CatResponse<CatAliasesRecord>
    | Edit this page View Source

    Aliases(Func<CatAliasesDescriptor, ICatAliasesRequest>)

    GET request to the cat.aliases API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
    Declaration
    CatResponse<CatAliasesRecord> Aliases(Func<CatAliasesDescriptor, ICatAliasesRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatAliasesDescriptor, ICatAliasesRequest> selector
    Returns
    Type Description
    CatResponse<CatAliasesRecord>
    | Edit this page View Source

    AliasesAsync(ICatAliasesRequest, CancellationToken)

    GET request to the cat.aliases API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
    Declaration
    Task<CatResponse<CatAliasesRecord>> AliasesAsync(ICatAliasesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatAliasesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatAliasesRecord>>
    | Edit this page View Source

    AliasesAsync(Func<CatAliasesDescriptor, ICatAliasesRequest>, CancellationToken)

    GET request to the cat.aliases API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
    Declaration
    Task<CatResponse<CatAliasesRecord>> AliasesAsync(Func<CatAliasesDescriptor, ICatAliasesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatAliasesDescriptor, ICatAliasesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatAliasesRecord>>
    | Edit this page View Source

    AllPitSegments(ICatAllPitSegmentsRequest)

    GET request to the cat.all_pit_segments API, read more about this API online:

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/
    Declaration
    CatResponse<CatAllPitSegmentsRecord> AllPitSegments(ICatAllPitSegmentsRequest request)
    Parameters
    Type Name Description
    ICatAllPitSegmentsRequest request
    Returns
    Type Description
    CatResponse<CatAllPitSegmentsRecord>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    AllPitSegments(Func<CatAllPitSegmentsDescriptor, ICatAllPitSegmentsRequest>)

    GET request to the cat.all_pit_segments API, read more about this API online:

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/
    Declaration
    CatResponse<CatAllPitSegmentsRecord> AllPitSegments(Func<CatAllPitSegmentsDescriptor, ICatAllPitSegmentsRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatAllPitSegmentsDescriptor, ICatAllPitSegmentsRequest> selector
    Returns
    Type Description
    CatResponse<CatAllPitSegmentsRecord>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    AllPitSegmentsAsync(ICatAllPitSegmentsRequest, CancellationToken)

    GET request to the cat.all_pit_segments API, read more about this API online:

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/
    Declaration
    Task<CatResponse<CatAllPitSegmentsRecord>> AllPitSegmentsAsync(ICatAllPitSegmentsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatAllPitSegmentsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatAllPitSegmentsRecord>>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    AllPitSegmentsAsync(Func<CatAllPitSegmentsDescriptor, ICatAllPitSegmentsRequest>, CancellationToken)

    GET request to the cat.all_pit_segments API, read more about this API online:

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/
    Declaration
    Task<CatResponse<CatAllPitSegmentsRecord>> AllPitSegmentsAsync(Func<CatAllPitSegmentsDescriptor, ICatAllPitSegmentsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatAllPitSegmentsDescriptor, ICatAllPitSegmentsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatAllPitSegmentsRecord>>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    Allocation(ICatAllocationRequest)

    GET request to the cat.allocation API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/
    Declaration
    CatResponse<CatAllocationRecord> Allocation(ICatAllocationRequest request)
    Parameters
    Type Name Description
    ICatAllocationRequest request
    Returns
    Type Description
    CatResponse<CatAllocationRecord>
    | Edit this page View Source

    Allocation(Func<CatAllocationDescriptor, ICatAllocationRequest>)

    GET request to the cat.allocation API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/
    Declaration
    CatResponse<CatAllocationRecord> Allocation(Func<CatAllocationDescriptor, ICatAllocationRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatAllocationDescriptor, ICatAllocationRequest> selector
    Returns
    Type Description
    CatResponse<CatAllocationRecord>
    | Edit this page View Source

    AllocationAsync(ICatAllocationRequest, CancellationToken)

    GET request to the cat.allocation API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/
    Declaration
    Task<CatResponse<CatAllocationRecord>> AllocationAsync(ICatAllocationRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatAllocationRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatAllocationRecord>>
    | Edit this page View Source

    AllocationAsync(Func<CatAllocationDescriptor, ICatAllocationRequest>, CancellationToken)

    GET request to the cat.allocation API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/
    Declaration
    Task<CatResponse<CatAllocationRecord>> AllocationAsync(Func<CatAllocationDescriptor, ICatAllocationRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatAllocationDescriptor, ICatAllocationRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatAllocationRecord>>
    | Edit this page View Source

    ClusterManager(ICatClusterManagerRequest)

    GET request to the cat.cluster_manager API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/
    Declaration
    CatResponse<CatClusterManagerRecord> ClusterManager(ICatClusterManagerRequest request)
    Parameters
    Type Name Description
    ICatClusterManagerRequest request
    Returns
    Type Description
    CatResponse<CatClusterManagerRecord>
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    ClusterManager(Func<CatClusterManagerDescriptor, ICatClusterManagerRequest>)

    GET request to the cat.cluster_manager API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/
    Declaration
    CatResponse<CatClusterManagerRecord> ClusterManager(Func<CatClusterManagerDescriptor, ICatClusterManagerRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatClusterManagerDescriptor, ICatClusterManagerRequest> selector
    Returns
    Type Description
    CatResponse<CatClusterManagerRecord>
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    ClusterManagerAsync(ICatClusterManagerRequest, CancellationToken)

    GET request to the cat.cluster_manager API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/
    Declaration
    Task<CatResponse<CatClusterManagerRecord>> ClusterManagerAsync(ICatClusterManagerRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatClusterManagerRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatClusterManagerRecord>>
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    ClusterManagerAsync(Func<CatClusterManagerDescriptor, ICatClusterManagerRequest>, CancellationToken)

    GET request to the cat.cluster_manager API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/
    Declaration
    Task<CatResponse<CatClusterManagerRecord>> ClusterManagerAsync(Func<CatClusterManagerDescriptor, ICatClusterManagerRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatClusterManagerDescriptor, ICatClusterManagerRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatClusterManagerRecord>>
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Count(ICatCountRequest)

    GET request to the cat.count API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-count/
    Declaration
    CatResponse<CatCountRecord> Count(ICatCountRequest request)
    Parameters
    Type Name Description
    ICatCountRequest request
    Returns
    Type Description
    CatResponse<CatCountRecord>
    | Edit this page View Source

    Count(Func<CatCountDescriptor, ICatCountRequest>)

    GET request to the cat.count API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-count/
    Declaration
    CatResponse<CatCountRecord> Count(Func<CatCountDescriptor, ICatCountRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatCountDescriptor, ICatCountRequest> selector
    Returns
    Type Description
    CatResponse<CatCountRecord>
    | Edit this page View Source

    CountAsync(ICatCountRequest, CancellationToken)

    GET request to the cat.count API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-count/
    Declaration
    Task<CatResponse<CatCountRecord>> CountAsync(ICatCountRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatCountRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatCountRecord>>
    | Edit this page View Source

    CountAsync(Func<CatCountDescriptor, ICatCountRequest>, CancellationToken)

    GET request to the cat.count API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-count/
    Declaration
    Task<CatResponse<CatCountRecord>> CountAsync(Func<CatCountDescriptor, ICatCountRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatCountDescriptor, ICatCountRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatCountRecord>>
    | Edit this page View Source

    Fielddata(ICatFielddataRequest)

    GET request to the cat.fielddata API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/
    Declaration
    CatResponse<CatFielddataRecord> Fielddata(ICatFielddataRequest request)
    Parameters
    Type Name Description
    ICatFielddataRequest request
    Returns
    Type Description
    CatResponse<CatFielddataRecord>
    | Edit this page View Source

    Fielddata(Func<CatFielddataDescriptor, ICatFielddataRequest>)

    GET request to the cat.fielddata API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/
    Declaration
    CatResponse<CatFielddataRecord> Fielddata(Func<CatFielddataDescriptor, ICatFielddataRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatFielddataDescriptor, ICatFielddataRequest> selector
    Returns
    Type Description
    CatResponse<CatFielddataRecord>
    | Edit this page View Source

    FielddataAsync(ICatFielddataRequest, CancellationToken)

    GET request to the cat.fielddata API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/
    Declaration
    Task<CatResponse<CatFielddataRecord>> FielddataAsync(ICatFielddataRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatFielddataRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatFielddataRecord>>
    | Edit this page View Source

    FielddataAsync(Func<CatFielddataDescriptor, ICatFielddataRequest>, CancellationToken)

    GET request to the cat.fielddata API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/
    Declaration
    Task<CatResponse<CatFielddataRecord>> FielddataAsync(Func<CatFielddataDescriptor, ICatFielddataRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatFielddataDescriptor, ICatFielddataRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatFielddataRecord>>
    | Edit this page View Source

    Health(ICatHealthRequest)

    GET request to the cat.health API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-health/
    Declaration
    CatResponse<CatHealthRecord> Health(ICatHealthRequest request)
    Parameters
    Type Name Description
    ICatHealthRequest request
    Returns
    Type Description
    CatResponse<CatHealthRecord>
    | Edit this page View Source

    Health(Func<CatHealthDescriptor, ICatHealthRequest>)

    GET request to the cat.health API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-health/
    Declaration
    CatResponse<CatHealthRecord> Health(Func<CatHealthDescriptor, ICatHealthRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatHealthDescriptor, ICatHealthRequest> selector
    Returns
    Type Description
    CatResponse<CatHealthRecord>
    | Edit this page View Source

    HealthAsync(ICatHealthRequest, CancellationToken)

    GET request to the cat.health API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-health/
    Declaration
    Task<CatResponse<CatHealthRecord>> HealthAsync(ICatHealthRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatHealthRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatHealthRecord>>
    | Edit this page View Source

    HealthAsync(Func<CatHealthDescriptor, ICatHealthRequest>, CancellationToken)

    GET request to the cat.health API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-health/
    Declaration
    Task<CatResponse<CatHealthRecord>> HealthAsync(Func<CatHealthDescriptor, ICatHealthRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatHealthDescriptor, ICatHealthRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatHealthRecord>>
    | Edit this page View Source

    Help(ICatHelpRequest)

    GET request to the cat.help API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/index/
    Declaration
    CatResponse<CatHelpRecord> Help(ICatHelpRequest request)
    Parameters
    Type Name Description
    ICatHelpRequest request
    Returns
    Type Description
    CatResponse<CatHelpRecord>
    | Edit this page View Source

    Help(Func<CatHelpDescriptor, ICatHelpRequest>)

    GET request to the cat.help API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/index/
    Declaration
    CatResponse<CatHelpRecord> Help(Func<CatHelpDescriptor, ICatHelpRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatHelpDescriptor, ICatHelpRequest> selector
    Returns
    Type Description
    CatResponse<CatHelpRecord>
    | Edit this page View Source

    HelpAsync(ICatHelpRequest, CancellationToken)

    GET request to the cat.help API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/index/
    Declaration
    Task<CatResponse<CatHelpRecord>> HelpAsync(ICatHelpRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatHelpRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatHelpRecord>>
    | Edit this page View Source

    HelpAsync(Func<CatHelpDescriptor, ICatHelpRequest>, CancellationToken)

    GET request to the cat.help API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/index/
    Declaration
    Task<CatResponse<CatHelpRecord>> HelpAsync(Func<CatHelpDescriptor, ICatHelpRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatHelpDescriptor, ICatHelpRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatHelpRecord>>
    | Edit this page View Source

    Indices(ICatIndicesRequest)

    GET request to the cat.indices API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-indices/
    Declaration
    CatResponse<CatIndicesRecord> Indices(ICatIndicesRequest request)
    Parameters
    Type Name Description
    ICatIndicesRequest request
    Returns
    Type Description
    CatResponse<CatIndicesRecord>
    | Edit this page View Source

    Indices(Func<CatIndicesDescriptor, ICatIndicesRequest>)

    GET request to the cat.indices API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-indices/
    Declaration
    CatResponse<CatIndicesRecord> Indices(Func<CatIndicesDescriptor, ICatIndicesRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatIndicesDescriptor, ICatIndicesRequest> selector
    Returns
    Type Description
    CatResponse<CatIndicesRecord>
    | Edit this page View Source

    IndicesAsync(ICatIndicesRequest, CancellationToken)

    GET request to the cat.indices API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-indices/
    Declaration
    Task<CatResponse<CatIndicesRecord>> IndicesAsync(ICatIndicesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatIndicesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatIndicesRecord>>
    | Edit this page View Source

    IndicesAsync(Func<CatIndicesDescriptor, ICatIndicesRequest>, CancellationToken)

    GET request to the cat.indices API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-indices/
    Declaration
    Task<CatResponse<CatIndicesRecord>> IndicesAsync(Func<CatIndicesDescriptor, ICatIndicesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatIndicesDescriptor, ICatIndicesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatIndicesRecord>>
    | Edit this page View Source

    Master(ICatMasterRequest)

    GET request to the cat.master API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/
    Declaration
    [Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead.")]
    CatResponse<CatMasterRecord> Master(ICatMasterRequest request)
    Parameters
    Type Name Description
    ICatMasterRequest request
    Returns
    Type Description
    CatResponse<CatMasterRecord>
    | Edit this page View Source

    Master(Func<CatMasterDescriptor, ICatMasterRequest>)

    GET request to the cat.master API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/
    Declaration
    [Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead.")]
    CatResponse<CatMasterRecord> Master(Func<CatMasterDescriptor, ICatMasterRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatMasterDescriptor, ICatMasterRequest> selector
    Returns
    Type Description
    CatResponse<CatMasterRecord>
    | Edit this page View Source

    MasterAsync(ICatMasterRequest, CancellationToken)

    GET request to the cat.master API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/
    Declaration
    [Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead.")]
    Task<CatResponse<CatMasterRecord>> MasterAsync(ICatMasterRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatMasterRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatMasterRecord>>
    | Edit this page View Source

    MasterAsync(Func<CatMasterDescriptor, ICatMasterRequest>, CancellationToken)

    GET request to the cat.master API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/
    Declaration
    [Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead.")]
    Task<CatResponse<CatMasterRecord>> MasterAsync(Func<CatMasterDescriptor, ICatMasterRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatMasterDescriptor, ICatMasterRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatMasterRecord>>
    | Edit this page View Source

    NodeAttributes(ICatNodeAttributesRequest)

    GET request to the cat.nodeattrs API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/
    Declaration
    CatResponse<CatNodeAttributesRecord> NodeAttributes(ICatNodeAttributesRequest request)
    Parameters
    Type Name Description
    ICatNodeAttributesRequest request
    Returns
    Type Description
    CatResponse<CatNodeAttributesRecord>
    | Edit this page View Source

    NodeAttributes(Func<CatNodeAttributesDescriptor, ICatNodeAttributesRequest>)

    GET request to the cat.nodeattrs API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/
    Declaration
    CatResponse<CatNodeAttributesRecord> NodeAttributes(Func<CatNodeAttributesDescriptor, ICatNodeAttributesRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatNodeAttributesDescriptor, ICatNodeAttributesRequest> selector
    Returns
    Type Description
    CatResponse<CatNodeAttributesRecord>
    | Edit this page View Source

    NodeAttributesAsync(ICatNodeAttributesRequest, CancellationToken)

    GET request to the cat.nodeattrs API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/
    Declaration
    Task<CatResponse<CatNodeAttributesRecord>> NodeAttributesAsync(ICatNodeAttributesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatNodeAttributesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatNodeAttributesRecord>>
    | Edit this page View Source

    NodeAttributesAsync(Func<CatNodeAttributesDescriptor, ICatNodeAttributesRequest>, CancellationToken)

    GET request to the cat.nodeattrs API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/
    Declaration
    Task<CatResponse<CatNodeAttributesRecord>> NodeAttributesAsync(Func<CatNodeAttributesDescriptor, ICatNodeAttributesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatNodeAttributesDescriptor, ICatNodeAttributesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatNodeAttributesRecord>>
    | Edit this page View Source

    Nodes(ICatNodesRequest)

    GET request to the cat.nodes API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/
    Declaration
    CatResponse<CatNodesRecord> Nodes(ICatNodesRequest request)
    Parameters
    Type Name Description
    ICatNodesRequest request
    Returns
    Type Description
    CatResponse<CatNodesRecord>
    | Edit this page View Source

    Nodes(Func<CatNodesDescriptor, ICatNodesRequest>)

    GET request to the cat.nodes API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/
    Declaration
    CatResponse<CatNodesRecord> Nodes(Func<CatNodesDescriptor, ICatNodesRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatNodesDescriptor, ICatNodesRequest> selector
    Returns
    Type Description
    CatResponse<CatNodesRecord>
    | Edit this page View Source

    NodesAsync(ICatNodesRequest, CancellationToken)

    GET request to the cat.nodes API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/
    Declaration
    Task<CatResponse<CatNodesRecord>> NodesAsync(ICatNodesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatNodesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatNodesRecord>>
    | Edit this page View Source

    NodesAsync(Func<CatNodesDescriptor, ICatNodesRequest>, CancellationToken)

    GET request to the cat.nodes API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/
    Declaration
    Task<CatResponse<CatNodesRecord>> NodesAsync(Func<CatNodesDescriptor, ICatNodesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatNodesDescriptor, ICatNodesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatNodesRecord>>
    | Edit this page View Source

    PendingTasks(ICatPendingTasksRequest)

    GET request to the cat.pending_tasks API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/
    Declaration
    CatResponse<CatPendingTasksRecord> PendingTasks(ICatPendingTasksRequest request)
    Parameters
    Type Name Description
    ICatPendingTasksRequest request
    Returns
    Type Description
    CatResponse<CatPendingTasksRecord>
    | Edit this page View Source

    PendingTasks(Func<CatPendingTasksDescriptor, ICatPendingTasksRequest>)

    GET request to the cat.pending_tasks API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/
    Declaration
    CatResponse<CatPendingTasksRecord> PendingTasks(Func<CatPendingTasksDescriptor, ICatPendingTasksRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatPendingTasksDescriptor, ICatPendingTasksRequest> selector
    Returns
    Type Description
    CatResponse<CatPendingTasksRecord>
    | Edit this page View Source

    PendingTasksAsync(ICatPendingTasksRequest, CancellationToken)

    GET request to the cat.pending_tasks API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/
    Declaration
    Task<CatResponse<CatPendingTasksRecord>> PendingTasksAsync(ICatPendingTasksRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatPendingTasksRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatPendingTasksRecord>>
    | Edit this page View Source

    PendingTasksAsync(Func<CatPendingTasksDescriptor, ICatPendingTasksRequest>, CancellationToken)

    GET request to the cat.pending_tasks API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/
    Declaration
    Task<CatResponse<CatPendingTasksRecord>> PendingTasksAsync(Func<CatPendingTasksDescriptor, ICatPendingTasksRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatPendingTasksDescriptor, ICatPendingTasksRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatPendingTasksRecord>>
    | Edit this page View Source

    PitSegments(ICatPitSegmentsRequest)

    GET request to the cat.pit_segments API, read more about this API online:

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/
    Declaration
    CatResponse<CatPitSegmentsRecord> PitSegments(ICatPitSegmentsRequest request)
    Parameters
    Type Name Description
    ICatPitSegmentsRequest request
    Returns
    Type Description
    CatResponse<CatPitSegmentsRecord>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    PitSegments(Func<CatPitSegmentsDescriptor, ICatPitSegmentsRequest>)

    GET request to the cat.pit_segments API, read more about this API online:

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/
    Declaration
    CatResponse<CatPitSegmentsRecord> PitSegments(Func<CatPitSegmentsDescriptor, ICatPitSegmentsRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatPitSegmentsDescriptor, ICatPitSegmentsRequest> selector
    Returns
    Type Description
    CatResponse<CatPitSegmentsRecord>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    PitSegmentsAsync(ICatPitSegmentsRequest, CancellationToken)

    GET request to the cat.pit_segments API, read more about this API online:

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/
    Declaration
    Task<CatResponse<CatPitSegmentsRecord>> PitSegmentsAsync(ICatPitSegmentsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatPitSegmentsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatPitSegmentsRecord>>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    PitSegmentsAsync(Func<CatPitSegmentsDescriptor, ICatPitSegmentsRequest>, CancellationToken)

    GET request to the cat.pit_segments API, read more about this API online:

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/
    Declaration
    Task<CatResponse<CatPitSegmentsRecord>> PitSegmentsAsync(Func<CatPitSegmentsDescriptor, ICatPitSegmentsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatPitSegmentsDescriptor, ICatPitSegmentsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatPitSegmentsRecord>>
    Remarks

    Supported by OpenSearch servers of version 2.4.0 or greater.

    | Edit this page View Source

    Plugins(ICatPluginsRequest)

    GET request to the cat.plugins API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
    Declaration
    CatResponse<CatPluginsRecord> Plugins(ICatPluginsRequest request)
    Parameters
    Type Name Description
    ICatPluginsRequest request
    Returns
    Type Description
    CatResponse<CatPluginsRecord>
    | Edit this page View Source

    Plugins(Func<CatPluginsDescriptor, ICatPluginsRequest>)

    GET request to the cat.plugins API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
    Declaration
    CatResponse<CatPluginsRecord> Plugins(Func<CatPluginsDescriptor, ICatPluginsRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatPluginsDescriptor, ICatPluginsRequest> selector
    Returns
    Type Description
    CatResponse<CatPluginsRecord>
    | Edit this page View Source

    PluginsAsync(ICatPluginsRequest, CancellationToken)

    GET request to the cat.plugins API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
    Declaration
    Task<CatResponse<CatPluginsRecord>> PluginsAsync(ICatPluginsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatPluginsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatPluginsRecord>>
    | Edit this page View Source

    PluginsAsync(Func<CatPluginsDescriptor, ICatPluginsRequest>, CancellationToken)

    GET request to the cat.plugins API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
    Declaration
    Task<CatResponse<CatPluginsRecord>> PluginsAsync(Func<CatPluginsDescriptor, ICatPluginsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatPluginsDescriptor, ICatPluginsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatPluginsRecord>>
    | Edit this page View Source

    Recovery(ICatRecoveryRequest)

    GET request to the cat.recovery API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
    Declaration
    CatResponse<CatRecoveryRecord> Recovery(ICatRecoveryRequest request)
    Parameters
    Type Name Description
    ICatRecoveryRequest request
    Returns
    Type Description
    CatResponse<CatRecoveryRecord>
    | Edit this page View Source

    Recovery(Func<CatRecoveryDescriptor, ICatRecoveryRequest>)

    GET request to the cat.recovery API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
    Declaration
    CatResponse<CatRecoveryRecord> Recovery(Func<CatRecoveryDescriptor, ICatRecoveryRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatRecoveryDescriptor, ICatRecoveryRequest> selector
    Returns
    Type Description
    CatResponse<CatRecoveryRecord>
    | Edit this page View Source

    RecoveryAsync(ICatRecoveryRequest, CancellationToken)

    GET request to the cat.recovery API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
    Declaration
    Task<CatResponse<CatRecoveryRecord>> RecoveryAsync(ICatRecoveryRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatRecoveryRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatRecoveryRecord>>
    | Edit this page View Source

    RecoveryAsync(Func<CatRecoveryDescriptor, ICatRecoveryRequest>, CancellationToken)

    GET request to the cat.recovery API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
    Declaration
    Task<CatResponse<CatRecoveryRecord>> RecoveryAsync(Func<CatRecoveryDescriptor, ICatRecoveryRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatRecoveryDescriptor, ICatRecoveryRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatRecoveryRecord>>
    | Edit this page View Source

    Repositories(ICatRepositoriesRequest)

    GET request to the cat.repositories API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/
    Declaration
    CatResponse<CatRepositoriesRecord> Repositories(ICatRepositoriesRequest request)
    Parameters
    Type Name Description
    ICatRepositoriesRequest request
    Returns
    Type Description
    CatResponse<CatRepositoriesRecord>
    | Edit this page View Source

    Repositories(Func<CatRepositoriesDescriptor, ICatRepositoriesRequest>)

    GET request to the cat.repositories API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/
    Declaration
    CatResponse<CatRepositoriesRecord> Repositories(Func<CatRepositoriesDescriptor, ICatRepositoriesRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatRepositoriesDescriptor, ICatRepositoriesRequest> selector
    Returns
    Type Description
    CatResponse<CatRepositoriesRecord>
    | Edit this page View Source

    RepositoriesAsync(ICatRepositoriesRequest, CancellationToken)

    GET request to the cat.repositories API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/
    Declaration
    Task<CatResponse<CatRepositoriesRecord>> RepositoriesAsync(ICatRepositoriesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatRepositoriesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatRepositoriesRecord>>
    | Edit this page View Source

    RepositoriesAsync(Func<CatRepositoriesDescriptor, ICatRepositoriesRequest>, CancellationToken)

    GET request to the cat.repositories API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/
    Declaration
    Task<CatResponse<CatRepositoriesRecord>> RepositoriesAsync(Func<CatRepositoriesDescriptor, ICatRepositoriesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatRepositoriesDescriptor, ICatRepositoriesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatRepositoriesRecord>>
    | Edit this page View Source

    SegmentReplication(ICatSegmentReplicationRequest)

    GET request to the cat.segment_replication API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/
    Declaration
    CatResponse<CatSegmentReplicationRecord> SegmentReplication(ICatSegmentReplicationRequest request)
    Parameters
    Type Name Description
    ICatSegmentReplicationRequest request
    Returns
    Type Description
    CatResponse<CatSegmentReplicationRecord>
    Remarks

    Supported by OpenSearch servers of version 2.6.0 or greater.

    | Edit this page View Source

    SegmentReplication(Func<CatSegmentReplicationDescriptor, ICatSegmentReplicationRequest>)

    GET request to the cat.segment_replication API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/
    Declaration
    CatResponse<CatSegmentReplicationRecord> SegmentReplication(Func<CatSegmentReplicationDescriptor, ICatSegmentReplicationRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatSegmentReplicationDescriptor, ICatSegmentReplicationRequest> selector
    Returns
    Type Description
    CatResponse<CatSegmentReplicationRecord>
    Remarks

    Supported by OpenSearch servers of version 2.6.0 or greater.

    | Edit this page View Source

    SegmentReplicationAsync(ICatSegmentReplicationRequest, CancellationToken)

    GET request to the cat.segment_replication API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/
    Declaration
    Task<CatResponse<CatSegmentReplicationRecord>> SegmentReplicationAsync(ICatSegmentReplicationRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatSegmentReplicationRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatSegmentReplicationRecord>>
    Remarks

    Supported by OpenSearch servers of version 2.6.0 or greater.

    | Edit this page View Source

    SegmentReplicationAsync(Func<CatSegmentReplicationDescriptor, ICatSegmentReplicationRequest>, CancellationToken)

    GET request to the cat.segment_replication API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/
    Declaration
    Task<CatResponse<CatSegmentReplicationRecord>> SegmentReplicationAsync(Func<CatSegmentReplicationDescriptor, ICatSegmentReplicationRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatSegmentReplicationDescriptor, ICatSegmentReplicationRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatSegmentReplicationRecord>>
    Remarks

    Supported by OpenSearch servers of version 2.6.0 or greater.

    | Edit this page View Source

    Segments(ICatSegmentsRequest)

    GET request to the cat.segments API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-segments/
    Declaration
    CatResponse<CatSegmentsRecord> Segments(ICatSegmentsRequest request)
    Parameters
    Type Name Description
    ICatSegmentsRequest request
    Returns
    Type Description
    CatResponse<CatSegmentsRecord>
    | Edit this page View Source

    Segments(Func<CatSegmentsDescriptor, ICatSegmentsRequest>)

    GET request to the cat.segments API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-segments/
    Declaration
    CatResponse<CatSegmentsRecord> Segments(Func<CatSegmentsDescriptor, ICatSegmentsRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatSegmentsDescriptor, ICatSegmentsRequest> selector
    Returns
    Type Description
    CatResponse<CatSegmentsRecord>
    | Edit this page View Source

    SegmentsAsync(ICatSegmentsRequest, CancellationToken)

    GET request to the cat.segments API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-segments/
    Declaration
    Task<CatResponse<CatSegmentsRecord>> SegmentsAsync(ICatSegmentsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatSegmentsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatSegmentsRecord>>
    | Edit this page View Source

    SegmentsAsync(Func<CatSegmentsDescriptor, ICatSegmentsRequest>, CancellationToken)

    GET request to the cat.segments API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-segments/
    Declaration
    Task<CatResponse<CatSegmentsRecord>> SegmentsAsync(Func<CatSegmentsDescriptor, ICatSegmentsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatSegmentsDescriptor, ICatSegmentsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatSegmentsRecord>>
    | Edit this page View Source

    Shards(ICatShardsRequest)

    GET request to the cat.shards API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-shards/
    Declaration
    CatResponse<CatShardsRecord> Shards(ICatShardsRequest request)
    Parameters
    Type Name Description
    ICatShardsRequest request
    Returns
    Type Description
    CatResponse<CatShardsRecord>
    | Edit this page View Source

    Shards(Func<CatShardsDescriptor, ICatShardsRequest>)

    GET request to the cat.shards API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-shards/
    Declaration
    CatResponse<CatShardsRecord> Shards(Func<CatShardsDescriptor, ICatShardsRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatShardsDescriptor, ICatShardsRequest> selector
    Returns
    Type Description
    CatResponse<CatShardsRecord>
    | Edit this page View Source

    ShardsAsync(ICatShardsRequest, CancellationToken)

    GET request to the cat.shards API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-shards/
    Declaration
    Task<CatResponse<CatShardsRecord>> ShardsAsync(ICatShardsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatShardsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatShardsRecord>>
    | Edit this page View Source

    ShardsAsync(Func<CatShardsDescriptor, ICatShardsRequest>, CancellationToken)

    GET request to the cat.shards API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-shards/
    Declaration
    Task<CatResponse<CatShardsRecord>> ShardsAsync(Func<CatShardsDescriptor, ICatShardsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatShardsDescriptor, ICatShardsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatShardsRecord>>
    | Edit this page View Source

    Snapshots(ICatSnapshotsRequest)

    GET request to the cat.snapshots API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/
    Declaration
    CatResponse<CatSnapshotsRecord> Snapshots(ICatSnapshotsRequest request)
    Parameters
    Type Name Description
    ICatSnapshotsRequest request
    Returns
    Type Description
    CatResponse<CatSnapshotsRecord>
    | Edit this page View Source

    Snapshots(Func<CatSnapshotsDescriptor, ICatSnapshotsRequest>)

    GET request to the cat.snapshots API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/
    Declaration
    CatResponse<CatSnapshotsRecord> Snapshots(Func<CatSnapshotsDescriptor, ICatSnapshotsRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatSnapshotsDescriptor, ICatSnapshotsRequest> selector
    Returns
    Type Description
    CatResponse<CatSnapshotsRecord>
    | Edit this page View Source

    SnapshotsAsync(ICatSnapshotsRequest, CancellationToken)

    GET request to the cat.snapshots API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/
    Declaration
    Task<CatResponse<CatSnapshotsRecord>> SnapshotsAsync(ICatSnapshotsRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatSnapshotsRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatSnapshotsRecord>>
    | Edit this page View Source

    SnapshotsAsync(Func<CatSnapshotsDescriptor, ICatSnapshotsRequest>, CancellationToken)

    GET request to the cat.snapshots API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/
    Declaration
    Task<CatResponse<CatSnapshotsRecord>> SnapshotsAsync(Func<CatSnapshotsDescriptor, ICatSnapshotsRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatSnapshotsDescriptor, ICatSnapshotsRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatSnapshotsRecord>>
    | Edit this page View Source

    Tasks(ICatTasksRequest)

    GET request to the cat.tasks API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/
    Declaration
    CatResponse<CatTasksRecord> Tasks(ICatTasksRequest request)
    Parameters
    Type Name Description
    ICatTasksRequest request
    Returns
    Type Description
    CatResponse<CatTasksRecord>
    | Edit this page View Source

    Tasks(Func<CatTasksDescriptor, ICatTasksRequest>)

    GET request to the cat.tasks API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/
    Declaration
    CatResponse<CatTasksRecord> Tasks(Func<CatTasksDescriptor, ICatTasksRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatTasksDescriptor, ICatTasksRequest> selector
    Returns
    Type Description
    CatResponse<CatTasksRecord>
    | Edit this page View Source

    TasksAsync(ICatTasksRequest, CancellationToken)

    GET request to the cat.tasks API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/
    Declaration
    Task<CatResponse<CatTasksRecord>> TasksAsync(ICatTasksRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatTasksRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatTasksRecord>>
    | Edit this page View Source

    TasksAsync(Func<CatTasksDescriptor, ICatTasksRequest>, CancellationToken)

    GET request to the cat.tasks API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/
    Declaration
    Task<CatResponse<CatTasksRecord>> TasksAsync(Func<CatTasksDescriptor, ICatTasksRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatTasksDescriptor, ICatTasksRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatTasksRecord>>
    | Edit this page View Source

    Templates(ICatTemplatesRequest)

    GET request to the cat.templates API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-templates/
    Declaration
    CatResponse<CatTemplatesRecord> Templates(ICatTemplatesRequest request)
    Parameters
    Type Name Description
    ICatTemplatesRequest request
    Returns
    Type Description
    CatResponse<CatTemplatesRecord>
    | Edit this page View Source

    Templates(Func<CatTemplatesDescriptor, ICatTemplatesRequest>)

    GET request to the cat.templates API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-templates/
    Declaration
    CatResponse<CatTemplatesRecord> Templates(Func<CatTemplatesDescriptor, ICatTemplatesRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatTemplatesDescriptor, ICatTemplatesRequest> selector
    Returns
    Type Description
    CatResponse<CatTemplatesRecord>
    | Edit this page View Source

    TemplatesAsync(ICatTemplatesRequest, CancellationToken)

    GET request to the cat.templates API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-templates/
    Declaration
    Task<CatResponse<CatTemplatesRecord>> TemplatesAsync(ICatTemplatesRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatTemplatesRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatTemplatesRecord>>
    | Edit this page View Source

    TemplatesAsync(Func<CatTemplatesDescriptor, ICatTemplatesRequest>, CancellationToken)

    GET request to the cat.templates API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-templates/
    Declaration
    Task<CatResponse<CatTemplatesRecord>> TemplatesAsync(Func<CatTemplatesDescriptor, ICatTemplatesRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatTemplatesDescriptor, ICatTemplatesRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatTemplatesRecord>>
    | Edit this page View Source

    ThreadPool(ICatThreadPoolRequest)

    GET request to the cat.thread_pool API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/
    Declaration
    CatResponse<CatThreadPoolRecord> ThreadPool(ICatThreadPoolRequest request)
    Parameters
    Type Name Description
    ICatThreadPoolRequest request
    Returns
    Type Description
    CatResponse<CatThreadPoolRecord>
    | Edit this page View Source

    ThreadPool(Func<CatThreadPoolDescriptor, ICatThreadPoolRequest>)

    GET request to the cat.thread_pool API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/
    Declaration
    CatResponse<CatThreadPoolRecord> ThreadPool(Func<CatThreadPoolDescriptor, ICatThreadPoolRequest> selector = null)
    Parameters
    Type Name Description
    Func<CatThreadPoolDescriptor, ICatThreadPoolRequest> selector
    Returns
    Type Description
    CatResponse<CatThreadPoolRecord>
    | Edit this page View Source

    ThreadPoolAsync(ICatThreadPoolRequest, CancellationToken)

    GET request to the cat.thread_pool API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/
    Declaration
    Task<CatResponse<CatThreadPoolRecord>> ThreadPoolAsync(ICatThreadPoolRequest request, CancellationToken ct = default)
    Parameters
    Type Name Description
    ICatThreadPoolRequest request
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatThreadPoolRecord>>
    | Edit this page View Source

    ThreadPoolAsync(Func<CatThreadPoolDescriptor, ICatThreadPoolRequest>, CancellationToken)

    GET request to the cat.thread_pool API, read more about this API online:

    https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/
    Declaration
    Task<CatResponse<CatThreadPoolRecord>> ThreadPoolAsync(Func<CatThreadPoolDescriptor, ICatThreadPoolRequest> selector = null, CancellationToken ct = default)
    Parameters
    Type Name Description
    Func<CatThreadPoolDescriptor, ICatThreadPoolRequest> selector
    CancellationToken ct
    Returns
    Type Description
    Task<CatResponse<CatThreadPoolRecord>>

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • Aliases(ICatAliasesRequest)
      • Aliases(Func<CatAliasesDescriptor, ICatAliasesRequest>)
      • AliasesAsync(ICatAliasesRequest, CancellationToken)
      • AliasesAsync(Func<CatAliasesDescriptor, ICatAliasesRequest>, CancellationToken)
      • AllPitSegments(ICatAllPitSegmentsRequest)
      • AllPitSegments(Func<CatAllPitSegmentsDescriptor, ICatAllPitSegmentsRequest>)
      • AllPitSegmentsAsync(ICatAllPitSegmentsRequest, CancellationToken)
      • AllPitSegmentsAsync(Func<CatAllPitSegmentsDescriptor, ICatAllPitSegmentsRequest>, CancellationToken)
      • Allocation(ICatAllocationRequest)
      • Allocation(Func<CatAllocationDescriptor, ICatAllocationRequest>)
      • AllocationAsync(ICatAllocationRequest, CancellationToken)
      • AllocationAsync(Func<CatAllocationDescriptor, ICatAllocationRequest>, CancellationToken)
      • ClusterManager(ICatClusterManagerRequest)
      • ClusterManager(Func<CatClusterManagerDescriptor, ICatClusterManagerRequest>)
      • ClusterManagerAsync(ICatClusterManagerRequest, CancellationToken)
      • ClusterManagerAsync(Func<CatClusterManagerDescriptor, ICatClusterManagerRequest>, CancellationToken)
      • Count(ICatCountRequest)
      • Count(Func<CatCountDescriptor, ICatCountRequest>)
      • CountAsync(ICatCountRequest, CancellationToken)
      • CountAsync(Func<CatCountDescriptor, ICatCountRequest>, CancellationToken)
      • Fielddata(ICatFielddataRequest)
      • Fielddata(Func<CatFielddataDescriptor, ICatFielddataRequest>)
      • FielddataAsync(ICatFielddataRequest, CancellationToken)
      • FielddataAsync(Func<CatFielddataDescriptor, ICatFielddataRequest>, CancellationToken)
      • Health(ICatHealthRequest)
      • Health(Func<CatHealthDescriptor, ICatHealthRequest>)
      • HealthAsync(ICatHealthRequest, CancellationToken)
      • HealthAsync(Func<CatHealthDescriptor, ICatHealthRequest>, CancellationToken)
      • Help(ICatHelpRequest)
      • Help(Func<CatHelpDescriptor, ICatHelpRequest>)
      • HelpAsync(ICatHelpRequest, CancellationToken)
      • HelpAsync(Func<CatHelpDescriptor, ICatHelpRequest>, CancellationToken)
      • Indices(ICatIndicesRequest)
      • Indices(Func<CatIndicesDescriptor, ICatIndicesRequest>)
      • IndicesAsync(ICatIndicesRequest, CancellationToken)
      • IndicesAsync(Func<CatIndicesDescriptor, ICatIndicesRequest>, CancellationToken)
      • Master(ICatMasterRequest)
      • Master(Func<CatMasterDescriptor, ICatMasterRequest>)
      • MasterAsync(ICatMasterRequest, CancellationToken)
      • MasterAsync(Func<CatMasterDescriptor, ICatMasterRequest>, CancellationToken)
      • NodeAttributes(ICatNodeAttributesRequest)
      • NodeAttributes(Func<CatNodeAttributesDescriptor, ICatNodeAttributesRequest>)
      • NodeAttributesAsync(ICatNodeAttributesRequest, CancellationToken)
      • NodeAttributesAsync(Func<CatNodeAttributesDescriptor, ICatNodeAttributesRequest>, CancellationToken)
      • Nodes(ICatNodesRequest)
      • Nodes(Func<CatNodesDescriptor, ICatNodesRequest>)
      • NodesAsync(ICatNodesRequest, CancellationToken)
      • NodesAsync(Func<CatNodesDescriptor, ICatNodesRequest>, CancellationToken)
      • PendingTasks(ICatPendingTasksRequest)
      • PendingTasks(Func<CatPendingTasksDescriptor, ICatPendingTasksRequest>)
      • PendingTasksAsync(ICatPendingTasksRequest, CancellationToken)
      • PendingTasksAsync(Func<CatPendingTasksDescriptor, ICatPendingTasksRequest>, CancellationToken)
      • PitSegments(ICatPitSegmentsRequest)
      • PitSegments(Func<CatPitSegmentsDescriptor, ICatPitSegmentsRequest>)
      • PitSegmentsAsync(ICatPitSegmentsRequest, CancellationToken)
      • PitSegmentsAsync(Func<CatPitSegmentsDescriptor, ICatPitSegmentsRequest>, CancellationToken)
      • Plugins(ICatPluginsRequest)
      • Plugins(Func<CatPluginsDescriptor, ICatPluginsRequest>)
      • PluginsAsync(ICatPluginsRequest, CancellationToken)
      • PluginsAsync(Func<CatPluginsDescriptor, ICatPluginsRequest>, CancellationToken)
      • Recovery(ICatRecoveryRequest)
      • Recovery(Func<CatRecoveryDescriptor, ICatRecoveryRequest>)
      • RecoveryAsync(ICatRecoveryRequest, CancellationToken)
      • RecoveryAsync(Func<CatRecoveryDescriptor, ICatRecoveryRequest>, CancellationToken)
      • Repositories(ICatRepositoriesRequest)
      • Repositories(Func<CatRepositoriesDescriptor, ICatRepositoriesRequest>)
      • RepositoriesAsync(ICatRepositoriesRequest, CancellationToken)
      • RepositoriesAsync(Func<CatRepositoriesDescriptor, ICatRepositoriesRequest>, CancellationToken)
      • SegmentReplication(ICatSegmentReplicationRequest)
      • SegmentReplication(Func<CatSegmentReplicationDescriptor, ICatSegmentReplicationRequest>)
      • SegmentReplicationAsync(ICatSegmentReplicationRequest, CancellationToken)
      • SegmentReplicationAsync(Func<CatSegmentReplicationDescriptor, ICatSegmentReplicationRequest>, CancellationToken)
      • Segments(ICatSegmentsRequest)
      • Segments(Func<CatSegmentsDescriptor, ICatSegmentsRequest>)
      • SegmentsAsync(ICatSegmentsRequest, CancellationToken)
      • SegmentsAsync(Func<CatSegmentsDescriptor, ICatSegmentsRequest>, CancellationToken)
      • Shards(ICatShardsRequest)
      • Shards(Func<CatShardsDescriptor, ICatShardsRequest>)
      • ShardsAsync(ICatShardsRequest, CancellationToken)
      • ShardsAsync(Func<CatShardsDescriptor, ICatShardsRequest>, CancellationToken)
      • Snapshots(ICatSnapshotsRequest)
      • Snapshots(Func<CatSnapshotsDescriptor, ICatSnapshotsRequest>)
      • SnapshotsAsync(ICatSnapshotsRequest, CancellationToken)
      • SnapshotsAsync(Func<CatSnapshotsDescriptor, ICatSnapshotsRequest>, CancellationToken)
      • Tasks(ICatTasksRequest)
      • Tasks(Func<CatTasksDescriptor, ICatTasksRequest>)
      • TasksAsync(ICatTasksRequest, CancellationToken)
      • TasksAsync(Func<CatTasksDescriptor, ICatTasksRequest>, CancellationToken)
      • Templates(ICatTemplatesRequest)
      • Templates(Func<CatTemplatesDescriptor, ICatTemplatesRequest>)
      • TemplatesAsync(ICatTemplatesRequest, CancellationToken)
      • TemplatesAsync(Func<CatTemplatesDescriptor, ICatTemplatesRequest>, CancellationToken)
      • ThreadPool(ICatThreadPoolRequest)
      • ThreadPool(Func<CatThreadPoolDescriptor, ICatThreadPoolRequest>)
      • ThreadPoolAsync(ICatThreadPoolRequest, CancellationToken)
      • ThreadPoolAsync(Func<CatThreadPoolDescriptor, ICatThreadPoolRequest>, CancellationToken)
    • Extension Methods
    Back to top Generated by DocFX