Class LowLevelSmNamespace

Sm APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelSmNamespace

Inherited Members

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

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

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.SmApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelSmNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

CreatePolicyAsync<TResponse>(string, PostData, CreatePolicyRequestParameters, CancellationToken)

POST on /_plugins/_sm/policies/{policy_name}

Declaration

public Task<TResponse> CreatePolicyAsync<TResponse>(string policyName, PostData body, CreatePolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to create.
PostData	body
CreatePolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

CreatePolicy<TResponse>(string, PostData, CreatePolicyRequestParameters)

POST on /_plugins/_sm/policies/{policy_name}

Declaration

public TResponse CreatePolicy<TResponse>(string policyName, PostData body, CreatePolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to create.
PostData	body
CreatePolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

DeletePolicyAsync<TResponse>(string, DeletePolicyRequestParameters, CancellationToken)

DELETE on /_plugins/_sm/policies/{policy_name}

Declaration

public Task<TResponse> DeletePolicyAsync<TResponse>(string policyName, DeletePolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to delete.
DeletePolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

DeletePolicy<TResponse>(string, DeletePolicyRequestParameters)

DELETE on /_plugins/_sm/policies/{policy_name}

Declaration

public TResponse DeletePolicy<TResponse>(string policyName, DeletePolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to delete.
DeletePolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

ExplainPolicyAsync<TResponse>(string, ExplainPolicyRequestParameters, CancellationToken)

GET on /_plugins/_sm/policies/{policy_name}/_explain

Declaration

public Task<TResponse> ExplainPolicyAsync<TResponse>(string policyName, ExplainPolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to explain.
ExplainPolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

ExplainPolicy<TResponse>(string, ExplainPolicyRequestParameters)

GET on /_plugins/_sm/policies/{policy_name}/_explain

Declaration

public TResponse ExplainPolicy<TResponse>(string policyName, ExplainPolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to explain.
ExplainPolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

GetPoliciesAsync<TResponse>(GetPoliciesRequestParameters, CancellationToken)

GET on /_plugins/_sm/policies

Declaration

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

Parameters

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

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

GetPolicies<TResponse>(GetPoliciesRequestParameters)

GET on /_plugins/_sm/policies

Declaration

public TResponse GetPolicies<TResponse>(GetPoliciesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

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

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

GetPolicyAsync<TResponse>(string, GetPolicyRequestParameters, CancellationToken)

GET on /_plugins/_sm/policies/{policy_name}

Declaration

public Task<TResponse> GetPolicyAsync<TResponse>(string policyName, GetPolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to retrieve.
GetPolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

GetPolicy<TResponse>(string, GetPolicyRequestParameters)

GET on /_plugins/_sm/policies/{policy_name}

Declaration

public TResponse GetPolicy<TResponse>(string policyName, GetPolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to retrieve.
GetPolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

StartPolicyAsync<TResponse>(string, StartPolicyRequestParameters, CancellationToken)

POST on /_plugins/_sm/policies/{policy_name}/_start

Declaration

public Task<TResponse> StartPolicyAsync<TResponse>(string policyName, StartPolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to start.
StartPolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

StartPolicy<TResponse>(string, StartPolicyRequestParameters)

POST on /_plugins/_sm/policies/{policy_name}/_start

Declaration

public TResponse StartPolicy<TResponse>(string policyName, StartPolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to start.
StartPolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

StopPolicyAsync<TResponse>(string, StopPolicyRequestParameters, CancellationToken)

POST on /_plugins/_sm/policies/{policy_name}/_stop

Declaration

public Task<TResponse> StopPolicyAsync<TResponse>(string policyName, StopPolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to stop.
StopPolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

StopPolicy<TResponse>(string, StopPolicyRequestParameters)

POST on /_plugins/_sm/policies/{policy_name}/_stop

Declaration

public TResponse StopPolicy<TResponse>(string policyName, StopPolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to stop.
StopPolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

UpdatePolicyAsync<TResponse>(string, PostData, UpdatePolicyRequestParameters, CancellationToken)

PUT on /_plugins/_sm/policies/{policy_name}

Declaration

public Task<TResponse> UpdatePolicyAsync<TResponse>(string policyName, PostData body, UpdatePolicyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to update.
PostData	body
UpdatePolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

UpdatePolicy<TResponse>(string, PostData, UpdatePolicyRequestParameters)

PUT on /_plugins/_sm/policies/{policy_name}

Declaration

public TResponse UpdatePolicy<TResponse>(string policyName, PostData body, UpdatePolicyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	policyName	The name of the snapshot management policy to update.
PostData	body
UpdatePolicyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)