Class ClusterNamespace

Cluster implementation.

Not intended to be instantiated directly. Use the Cluster property on IOpenSearchClient.

Inheritance

object

NamespacedClientProxy

ClusterNamespace

Implements

IClusterNamespace

Inherited Members

NamespacedClientProxy.DoCat<TRequest, TParams, TCatRecord>(TRequest)

NamespacedClientProxy.DoCatAsync<TRequest, TParams, TCatRecord>(TRequest, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client.Specification.ClusterApi

Assembly: OpenSearch.Client.dll

Syntax

public class ClusterNamespace : NamespacedClientProxy, IClusterNamespace

Methods

| Edit this page View Source

AllocationExplain(IClusterAllocationExplainRequest)

POST request to the cluster.allocation_explain API, read more about this API online:

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

Declaration

public ClusterAllocationExplainResponse AllocationExplain(IClusterAllocationExplainRequest request)

Parameters

Type	Name	Description
IClusterAllocationExplainRequest	request

Returns

Type	Description
ClusterAllocationExplainResponse

| Edit this page View Source

AllocationExplain(Func<ClusterAllocationExplainDescriptor, IClusterAllocationExplainRequest>)

POST request to the cluster.allocation_explain API, read more about this API online:

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

Declaration

public ClusterAllocationExplainResponse AllocationExplain(Func<ClusterAllocationExplainDescriptor, IClusterAllocationExplainRequest> selector = null)

Parameters

Type	Name	Description
Func<ClusterAllocationExplainDescriptor, IClusterAllocationExplainRequest>	selector

Returns

Type	Description
ClusterAllocationExplainResponse

| Edit this page View Source

AllocationExplainAsync(IClusterAllocationExplainRequest, CancellationToken)

POST request to the cluster.allocation_explain API, read more about this API online:

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

Declaration

public Task<ClusterAllocationExplainResponse> AllocationExplainAsync(IClusterAllocationExplainRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IClusterAllocationExplainRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClusterAllocationExplainResponse>

| Edit this page View Source

AllocationExplainAsync(Func<ClusterAllocationExplainDescriptor, IClusterAllocationExplainRequest>, CancellationToken)

POST request to the cluster.allocation_explain API, read more about this API online:

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

Declaration

public Task<ClusterAllocationExplainResponse> AllocationExplainAsync(Func<ClusterAllocationExplainDescriptor, IClusterAllocationExplainRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<ClusterAllocationExplainDescriptor, IClusterAllocationExplainRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClusterAllocationExplainResponse>

| Edit this page View Source

ComponentTemplateExists(IComponentTemplateExistsRequest)

HEAD request to the cluster.exists_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public ExistsResponse ComponentTemplateExists(IComponentTemplateExistsRequest request)

Parameters

Type	Name	Description
IComponentTemplateExistsRequest	request

Returns

Type	Description
ExistsResponse

| Edit this page View Source

ComponentTemplateExists(Name, Func<ComponentTemplateExistsDescriptor, IComponentTemplateExistsRequest>)

HEAD request to the cluster.exists_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public ExistsResponse ComponentTemplateExists(Name name, Func<ComponentTemplateExistsDescriptor, IComponentTemplateExistsRequest> selector = null)

Parameters

Type	Name	Description
Name	name
Func<ComponentTemplateExistsDescriptor, IComponentTemplateExistsRequest>	selector

Returns

Type	Description
ExistsResponse

| Edit this page View Source

ComponentTemplateExistsAsync(IComponentTemplateExistsRequest, CancellationToken)

HEAD request to the cluster.exists_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<ExistsResponse> ComponentTemplateExistsAsync(IComponentTemplateExistsRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IComponentTemplateExistsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ExistsResponse>

| Edit this page View Source

ComponentTemplateExistsAsync(Name, Func<ComponentTemplateExistsDescriptor, IComponentTemplateExistsRequest>, CancellationToken)

HEAD request to the cluster.exists_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<ExistsResponse> ComponentTemplateExistsAsync(Name name, Func<ComponentTemplateExistsDescriptor, IComponentTemplateExistsRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Name	name
Func<ComponentTemplateExistsDescriptor, IComponentTemplateExistsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ExistsResponse>

| Edit this page View Source

DeleteComponentTemplate(IDeleteComponentTemplateRequest)

DELETE request to the cluster.delete_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public DeleteComponentTemplateResponse DeleteComponentTemplate(IDeleteComponentTemplateRequest request)

Parameters

Type	Name	Description
IDeleteComponentTemplateRequest	request

Returns

Type	Description
DeleteComponentTemplateResponse

| Edit this page View Source

DeleteComponentTemplate(Name, Func<DeleteComponentTemplateDescriptor, IDeleteComponentTemplateRequest>)

DELETE request to the cluster.delete_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public DeleteComponentTemplateResponse DeleteComponentTemplate(Name name, Func<DeleteComponentTemplateDescriptor, IDeleteComponentTemplateRequest> selector = null)

Parameters

Type	Name	Description
Name	name
Func<DeleteComponentTemplateDescriptor, IDeleteComponentTemplateRequest>	selector

Returns

Type	Description
DeleteComponentTemplateResponse

| Edit this page View Source

DeleteComponentTemplateAsync(IDeleteComponentTemplateRequest, CancellationToken)

DELETE request to the cluster.delete_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<DeleteComponentTemplateResponse> DeleteComponentTemplateAsync(IDeleteComponentTemplateRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IDeleteComponentTemplateRequest	request
CancellationToken	ct

Returns

Type	Description
Task<DeleteComponentTemplateResponse>

| Edit this page View Source

DeleteComponentTemplateAsync(Name, Func<DeleteComponentTemplateDescriptor, IDeleteComponentTemplateRequest>, CancellationToken)

DELETE request to the cluster.delete_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<DeleteComponentTemplateResponse> DeleteComponentTemplateAsync(Name name, Func<DeleteComponentTemplateDescriptor, IDeleteComponentTemplateRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Name	name
Func<DeleteComponentTemplateDescriptor, IDeleteComponentTemplateRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<DeleteComponentTemplateResponse>

| Edit this page View Source

DeleteVotingConfigExclusions(IDeleteVotingConfigExclusionsRequest)

DELETE request to the cluster.delete_voting_config_exclusions API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions(IDeleteVotingConfigExclusionsRequest request)

Parameters

Type	Name	Description
IDeleteVotingConfigExclusionsRequest	request

Returns

Type	Description
DeleteVotingConfigExclusionsResponse

| Edit this page View Source

DeleteVotingConfigExclusions(Func<DeleteVotingConfigExclusionsDescriptor, IDeleteVotingConfigExclusionsRequest>)

DELETE request to the cluster.delete_voting_config_exclusions API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions(Func<DeleteVotingConfigExclusionsDescriptor, IDeleteVotingConfigExclusionsRequest> selector = null)

Parameters

Type	Name	Description
Func<DeleteVotingConfigExclusionsDescriptor, IDeleteVotingConfigExclusionsRequest>	selector

Returns

Type	Description
DeleteVotingConfigExclusionsResponse

| Edit this page View Source

DeleteVotingConfigExclusionsAsync(IDeleteVotingConfigExclusionsRequest, CancellationToken)

DELETE request to the cluster.delete_voting_config_exclusions API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<DeleteVotingConfigExclusionsResponse> DeleteVotingConfigExclusionsAsync(IDeleteVotingConfigExclusionsRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IDeleteVotingConfigExclusionsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<DeleteVotingConfigExclusionsResponse>

| Edit this page View Source

DeleteVotingConfigExclusionsAsync(Func<DeleteVotingConfigExclusionsDescriptor, IDeleteVotingConfigExclusionsRequest>, CancellationToken)

DELETE request to the cluster.delete_voting_config_exclusions API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<DeleteVotingConfigExclusionsResponse> DeleteVotingConfigExclusionsAsync(Func<DeleteVotingConfigExclusionsDescriptor, IDeleteVotingConfigExclusionsRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<DeleteVotingConfigExclusionsDescriptor, IDeleteVotingConfigExclusionsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<DeleteVotingConfigExclusionsResponse>

| Edit this page View Source

GetComponentTemplate(IGetComponentTemplateRequest)

GET request to the cluster.get_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public GetComponentTemplateResponse GetComponentTemplate(IGetComponentTemplateRequest request)

Parameters

Type	Name	Description
IGetComponentTemplateRequest	request

Returns

Type	Description
GetComponentTemplateResponse

| Edit this page View Source

GetComponentTemplate(Name, Func<GetComponentTemplateDescriptor, IGetComponentTemplateRequest>)

GET request to the cluster.get_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public GetComponentTemplateResponse GetComponentTemplate(Name name = null, Func<GetComponentTemplateDescriptor, IGetComponentTemplateRequest> selector = null)

Parameters

Type	Name	Description
Name	name
Func<GetComponentTemplateDescriptor, IGetComponentTemplateRequest>	selector

Returns

Type	Description
GetComponentTemplateResponse

| Edit this page View Source

GetComponentTemplateAsync(IGetComponentTemplateRequest, CancellationToken)

GET request to the cluster.get_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<GetComponentTemplateResponse> GetComponentTemplateAsync(IGetComponentTemplateRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IGetComponentTemplateRequest	request
CancellationToken	ct

Returns

Type	Description
Task<GetComponentTemplateResponse>

| Edit this page View Source

GetComponentTemplateAsync(Name, Func<GetComponentTemplateDescriptor, IGetComponentTemplateRequest>, CancellationToken)

GET request to the cluster.get_component_template API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<GetComponentTemplateResponse> GetComponentTemplateAsync(Name name = null, Func<GetComponentTemplateDescriptor, IGetComponentTemplateRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Name	name
Func<GetComponentTemplateDescriptor, IGetComponentTemplateRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<GetComponentTemplateResponse>

| Edit this page View Source

GetSettings(IClusterGetSettingsRequest)

GET request to the cluster.get_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/

Declaration

public ClusterGetSettingsResponse GetSettings(IClusterGetSettingsRequest request)

Parameters

Type	Name	Description
IClusterGetSettingsRequest	request

Returns

Type	Description
ClusterGetSettingsResponse

| Edit this page View Source

GetSettings(Func<ClusterGetSettingsDescriptor, IClusterGetSettingsRequest>)

GET request to the cluster.get_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/

Declaration

public ClusterGetSettingsResponse GetSettings(Func<ClusterGetSettingsDescriptor, IClusterGetSettingsRequest> selector = null)

Parameters

Type	Name	Description
Func<ClusterGetSettingsDescriptor, IClusterGetSettingsRequest>	selector

Returns

Type	Description
ClusterGetSettingsResponse

| Edit this page View Source

GetSettingsAsync(IClusterGetSettingsRequest, CancellationToken)

GET request to the cluster.get_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/

Declaration

public Task<ClusterGetSettingsResponse> GetSettingsAsync(IClusterGetSettingsRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IClusterGetSettingsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClusterGetSettingsResponse>

| Edit this page View Source

GetSettingsAsync(Func<ClusterGetSettingsDescriptor, IClusterGetSettingsRequest>, CancellationToken)

GET request to the cluster.get_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/

Declaration

public Task<ClusterGetSettingsResponse> GetSettingsAsync(Func<ClusterGetSettingsDescriptor, IClusterGetSettingsRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<ClusterGetSettingsDescriptor, IClusterGetSettingsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClusterGetSettingsResponse>

| Edit this page View Source

Health(IClusterHealthRequest)

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

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

Declaration

public ClusterHealthResponse Health(IClusterHealthRequest request)

Parameters

Type	Name	Description
IClusterHealthRequest	request

Returns

Type	Description
ClusterHealthResponse

| Edit this page View Source

Health(Indices, Func<ClusterHealthDescriptor, IClusterHealthRequest>)

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

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

Declaration

public ClusterHealthResponse Health(Indices index = null, Func<ClusterHealthDescriptor, IClusterHealthRequest> selector = null)

Parameters

Type	Name	Description
Indices	index
Func<ClusterHealthDescriptor, IClusterHealthRequest>	selector

Returns

Type	Description
ClusterHealthResponse

| Edit this page View Source

HealthAsync(IClusterHealthRequest, CancellationToken)

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

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

Declaration

public Task<ClusterHealthResponse> HealthAsync(IClusterHealthRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IClusterHealthRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClusterHealthResponse>

| Edit this page View Source

HealthAsync(Indices, Func<ClusterHealthDescriptor, IClusterHealthRequest>, CancellationToken)

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

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

Declaration

public Task<ClusterHealthResponse> HealthAsync(Indices index = null, Func<ClusterHealthDescriptor, IClusterHealthRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Indices	index
Func<ClusterHealthDescriptor, IClusterHealthRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClusterHealthResponse>

| Edit this page View Source

PendingTasks(IClusterPendingTasksRequest)

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

https://opensearch.org/docs/latest

Declaration

public ClusterPendingTasksResponse PendingTasks(IClusterPendingTasksRequest request)

Parameters

Type	Name	Description
IClusterPendingTasksRequest	request

Returns

Type	Description
ClusterPendingTasksResponse

| Edit this page View Source

PendingTasks(Func<ClusterPendingTasksDescriptor, IClusterPendingTasksRequest>)

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

https://opensearch.org/docs/latest

Declaration

public ClusterPendingTasksResponse PendingTasks(Func<ClusterPendingTasksDescriptor, IClusterPendingTasksRequest> selector = null)

Parameters

Type	Name	Description
Func<ClusterPendingTasksDescriptor, IClusterPendingTasksRequest>	selector

Returns

Type	Description
ClusterPendingTasksResponse

| Edit this page View Source

PendingTasksAsync(IClusterPendingTasksRequest, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

public Task<ClusterPendingTasksResponse> PendingTasksAsync(IClusterPendingTasksRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IClusterPendingTasksRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClusterPendingTasksResponse>

| Edit this page View Source

PendingTasksAsync(Func<ClusterPendingTasksDescriptor, IClusterPendingTasksRequest>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

public Task<ClusterPendingTasksResponse> PendingTasksAsync(Func<ClusterPendingTasksDescriptor, IClusterPendingTasksRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<ClusterPendingTasksDescriptor, IClusterPendingTasksRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClusterPendingTasksResponse>

| Edit this page View Source

PostVotingConfigExclusions(IPostVotingConfigExclusionsRequest)

POST request to the cluster.post_voting_config_exclusions API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public PostVotingConfigExclusionsResponse PostVotingConfigExclusions(IPostVotingConfigExclusionsRequest request)

Parameters

Type	Name	Description
IPostVotingConfigExclusionsRequest	request

Returns

Type	Description
PostVotingConfigExclusionsResponse

| Edit this page View Source

PostVotingConfigExclusions(Func<PostVotingConfigExclusionsDescriptor, IPostVotingConfigExclusionsRequest>)

POST request to the cluster.post_voting_config_exclusions API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Func<PostVotingConfigExclusionsDescriptor, IPostVotingConfigExclusionsRequest> selector = null)

Parameters

Type	Name	Description
Func<PostVotingConfigExclusionsDescriptor, IPostVotingConfigExclusionsRequest>	selector

Returns

Type	Description
PostVotingConfigExclusionsResponse

| Edit this page View Source

PostVotingConfigExclusionsAsync(IPostVotingConfigExclusionsRequest, CancellationToken)

POST request to the cluster.post_voting_config_exclusions API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<PostVotingConfigExclusionsResponse> PostVotingConfigExclusionsAsync(IPostVotingConfigExclusionsRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IPostVotingConfigExclusionsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<PostVotingConfigExclusionsResponse>

| Edit this page View Source

PostVotingConfigExclusionsAsync(Func<PostVotingConfigExclusionsDescriptor, IPostVotingConfigExclusionsRequest>, CancellationToken)

POST request to the cluster.post_voting_config_exclusions API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<PostVotingConfigExclusionsResponse> PostVotingConfigExclusionsAsync(Func<PostVotingConfigExclusionsDescriptor, IPostVotingConfigExclusionsRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<PostVotingConfigExclusionsDescriptor, IPostVotingConfigExclusionsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<PostVotingConfigExclusionsResponse>

| Edit this page View Source

PutComponentTemplate(IPutComponentTemplateRequest)

PUT request to the cluster.put_component_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Declaration

public PutComponentTemplateResponse PutComponentTemplate(IPutComponentTemplateRequest request)

Parameters

Type	Name	Description
IPutComponentTemplateRequest	request

Returns

Type	Description
PutComponentTemplateResponse

| Edit this page View Source

PutComponentTemplate(Name, Func<PutComponentTemplateDescriptor, IPutComponentTemplateRequest>)

PUT request to the cluster.put_component_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Declaration

public PutComponentTemplateResponse PutComponentTemplate(Name name, Func<PutComponentTemplateDescriptor, IPutComponentTemplateRequest> selector)

Parameters

Type	Name	Description
Name	name
Func<PutComponentTemplateDescriptor, IPutComponentTemplateRequest>	selector

Returns

Type	Description
PutComponentTemplateResponse

| Edit this page View Source

PutComponentTemplateAsync(IPutComponentTemplateRequest, CancellationToken)

PUT request to the cluster.put_component_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Declaration

public Task<PutComponentTemplateResponse> PutComponentTemplateAsync(IPutComponentTemplateRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IPutComponentTemplateRequest	request
CancellationToken	ct

Returns

Type	Description
Task<PutComponentTemplateResponse>

| Edit this page View Source

PutComponentTemplateAsync(Name, Func<PutComponentTemplateDescriptor, IPutComponentTemplateRequest>, CancellationToken)

PUT request to the cluster.put_component_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Declaration

public Task<PutComponentTemplateResponse> PutComponentTemplateAsync(Name name, Func<PutComponentTemplateDescriptor, IPutComponentTemplateRequest> selector, CancellationToken ct = default)

Parameters

Type	Name	Description
Name	name
Func<PutComponentTemplateDescriptor, IPutComponentTemplateRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<PutComponentTemplateResponse>

| Edit this page View Source

PutSettings(IClusterPutSettingsRequest)

PUT request to the cluster.put_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-settings/

Declaration

public ClusterPutSettingsResponse PutSettings(IClusterPutSettingsRequest request)

Parameters

Type	Name	Description
IClusterPutSettingsRequest	request

Returns

Type	Description
ClusterPutSettingsResponse

| Edit this page View Source

PutSettings(Func<ClusterPutSettingsDescriptor, IClusterPutSettingsRequest>)

PUT request to the cluster.put_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-settings/

Declaration

public ClusterPutSettingsResponse PutSettings(Func<ClusterPutSettingsDescriptor, IClusterPutSettingsRequest> selector)

Parameters

Type	Name	Description
Func<ClusterPutSettingsDescriptor, IClusterPutSettingsRequest>	selector

Returns

Type	Description
ClusterPutSettingsResponse

| Edit this page View Source

PutSettingsAsync(IClusterPutSettingsRequest, CancellationToken)

PUT request to the cluster.put_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-settings/

Declaration

public Task<ClusterPutSettingsResponse> PutSettingsAsync(IClusterPutSettingsRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IClusterPutSettingsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClusterPutSettingsResponse>

| Edit this page View Source

PutSettingsAsync(Func<ClusterPutSettingsDescriptor, IClusterPutSettingsRequest>, CancellationToken)

PUT request to the cluster.put_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-settings/

Declaration

public Task<ClusterPutSettingsResponse> PutSettingsAsync(Func<ClusterPutSettingsDescriptor, IClusterPutSettingsRequest> selector, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<ClusterPutSettingsDescriptor, IClusterPutSettingsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClusterPutSettingsResponse>

| Edit this page View Source

RemoteInfo(IRemoteInfoRequest)

GET request to the cluster.remote_info API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/remote-info/

Declaration

public RemoteInfoResponse RemoteInfo(IRemoteInfoRequest request)

Parameters

Type	Name	Description
IRemoteInfoRequest	request

Returns

Type	Description
RemoteInfoResponse

| Edit this page View Source

RemoteInfo(Func<RemoteInfoDescriptor, IRemoteInfoRequest>)

GET request to the cluster.remote_info API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/remote-info/

Declaration

public RemoteInfoResponse RemoteInfo(Func<RemoteInfoDescriptor, IRemoteInfoRequest> selector = null)

Parameters

Type	Name	Description
Func<RemoteInfoDescriptor, IRemoteInfoRequest>	selector

Returns

Type	Description
RemoteInfoResponse

| Edit this page View Source

RemoteInfoAsync(IRemoteInfoRequest, CancellationToken)

GET request to the cluster.remote_info API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/remote-info/

Declaration

public Task<RemoteInfoResponse> RemoteInfoAsync(IRemoteInfoRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IRemoteInfoRequest	request
CancellationToken	ct

Returns

Type	Description
Task<RemoteInfoResponse>

| Edit this page View Source

RemoteInfoAsync(Func<RemoteInfoDescriptor, IRemoteInfoRequest>, CancellationToken)

GET request to the cluster.remote_info API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/remote-info/

Declaration

public Task<RemoteInfoResponse> RemoteInfoAsync(Func<RemoteInfoDescriptor, IRemoteInfoRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<RemoteInfoDescriptor, IRemoteInfoRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<RemoteInfoResponse>

| Edit this page View Source

Reroute(IClusterRerouteRequest)

POST request to the cluster.reroute API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public ClusterRerouteResponse Reroute(IClusterRerouteRequest request)

Parameters

Type	Name	Description
IClusterRerouteRequest	request

Returns

Type	Description
ClusterRerouteResponse

| Edit this page View Source

Reroute(Func<ClusterRerouteDescriptor, IClusterRerouteRequest>)

POST request to the cluster.reroute API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public ClusterRerouteResponse Reroute(Func<ClusterRerouteDescriptor, IClusterRerouteRequest> selector = null)

Parameters

Type	Name	Description
Func<ClusterRerouteDescriptor, IClusterRerouteRequest>	selector

Returns

Type	Description
ClusterRerouteResponse

| Edit this page View Source

RerouteAsync(IClusterRerouteRequest, CancellationToken)

POST request to the cluster.reroute API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<ClusterRerouteResponse> RerouteAsync(IClusterRerouteRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IClusterRerouteRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClusterRerouteResponse>

| Edit this page View Source

RerouteAsync(Func<ClusterRerouteDescriptor, IClusterRerouteRequest>, CancellationToken)

POST request to the cluster.reroute API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<ClusterRerouteResponse> RerouteAsync(Func<ClusterRerouteDescriptor, IClusterRerouteRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<ClusterRerouteDescriptor, IClusterRerouteRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClusterRerouteResponse>

| Edit this page View Source

State(IClusterStateRequest)

GET request to the cluster.state API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public ClusterStateResponse State(IClusterStateRequest request)

Parameters

Type	Name	Description
IClusterStateRequest	request

Returns

Type	Description
ClusterStateResponse

| Edit this page View Source

State(Indices, Func<ClusterStateDescriptor, IClusterStateRequest>)

GET request to the cluster.state API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public ClusterStateResponse State(Indices index = null, Func<ClusterStateDescriptor, IClusterStateRequest> selector = null)

Parameters

Type	Name	Description
Indices	index
Func<ClusterStateDescriptor, IClusterStateRequest>	selector

Returns

Type	Description
ClusterStateResponse

| Edit this page View Source

StateAsync(IClusterStateRequest, CancellationToken)

GET request to the cluster.state API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<ClusterStateResponse> StateAsync(IClusterStateRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IClusterStateRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClusterStateResponse>

| Edit this page View Source

StateAsync(Indices, Func<ClusterStateDescriptor, IClusterStateRequest>, CancellationToken)

GET request to the cluster.state API, read more about this API online:

https://opensearch.org/docs/latest

Declaration

public Task<ClusterStateResponse> StateAsync(Indices index = null, Func<ClusterStateDescriptor, IClusterStateRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Indices	index
Func<ClusterStateDescriptor, IClusterStateRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClusterStateResponse>

| Edit this page View Source

Stats(IClusterStatsRequest)

GET request to the cluster.stats API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

Declaration

public ClusterStatsResponse Stats(IClusterStatsRequest request)

Parameters

Type	Name	Description
IClusterStatsRequest	request

Returns

Type	Description
ClusterStatsResponse

| Edit this page View Source

Stats(Func<ClusterStatsDescriptor, IClusterStatsRequest>)

GET request to the cluster.stats API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

Declaration

public ClusterStatsResponse Stats(Func<ClusterStatsDescriptor, IClusterStatsRequest> selector = null)

Parameters

Type	Name	Description
Func<ClusterStatsDescriptor, IClusterStatsRequest>	selector

Returns

Type	Description
ClusterStatsResponse

| Edit this page View Source

StatsAsync(IClusterStatsRequest, CancellationToken)

GET request to the cluster.stats API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

Declaration

public Task<ClusterStatsResponse> StatsAsync(IClusterStatsRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IClusterStatsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClusterStatsResponse>

| Edit this page View Source

StatsAsync(Func<ClusterStatsDescriptor, IClusterStatsRequest>, CancellationToken)

GET request to the cluster.stats API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

Declaration

public Task<ClusterStatsResponse> StatsAsync(Func<ClusterStatsDescriptor, IClusterStatsRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<ClusterStatsDescriptor, IClusterStatsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClusterStatsResponse>

Implements

IClusterNamespace

Extension Methods

SuffixExtensions.Suffix(object, string)