Class LowLevelRollupsNamespace

Rollups APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelRollupsNamespace

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.RollupsApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelRollupsNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

DeleteAsync<TResponse>(string, DeleteRequestParameters, CancellationToken)

DELETE on /_plugins/_rollup/jobs/{id}

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job

Declaration

public Task<TResponse> DeleteAsync<TResponse>(string id, DeleteRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
DeleteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Delete<TResponse>(string, DeleteRequestParameters)

DELETE on /_plugins/_rollup/jobs/{id}

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job

Declaration

public TResponse Delete<TResponse>(string id, DeleteRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
DeleteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ExplainAsync<TResponse>(string, ExplainRequestParameters, CancellationToken)

GET on /_plugins/_rollup/jobs/{id}/_explain

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job

Declaration

public Task<TResponse> ExplainAsync<TResponse>(string id, ExplainRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
ExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Explain<TResponse>(string, ExplainRequestParameters)

GET on /_plugins/_rollup/jobs/{id}/_explain

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job

Declaration

public TResponse Explain<TResponse>(string id, ExplainRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
ExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetAsync<TResponse>(string, GetRequestParameters, CancellationToken)

GET on /_plugins/_rollup/jobs/{id}

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job

Declaration

public Task<TResponse> GetAsync<TResponse>(string id, GetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
GetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Get<TResponse>(string, GetRequestParameters)

GET on /_plugins/_rollup/jobs/{id}

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job

Declaration

public TResponse Get<TResponse>(string id, GetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
GetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutAsync<TResponse>(string, PostData, PutRequestParameters, CancellationToken)

PUT on /_plugins/_rollup/jobs/{id}

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job

Declaration

public Task<TResponse> PutAsync<TResponse>(string id, PostData body, PutRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
PostData	body
PutRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Put<TResponse>(string, PostData, PutRequestParameters)

PUT on /_plugins/_rollup/jobs/{id}

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job

Declaration

public TResponse Put<TResponse>(string id, PostData body, PutRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
PostData	body
PutRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StartAsync<TResponse>(string, StartRequestParameters, CancellationToken)

POST on /_plugins/_rollup/jobs/{id}/_start

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job

Declaration

public Task<TResponse> StartAsync<TResponse>(string id, StartRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
StartRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Start<TResponse>(string, StartRequestParameters)

POST on /_plugins/_rollup/jobs/{id}/_start

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job

Declaration

public TResponse Start<TResponse>(string id, StartRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
StartRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StopAsync<TResponse>(string, StopRequestParameters, CancellationToken)

POST on /_plugins/_rollup/jobs/{id}/_stop

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job

Declaration

public Task<TResponse> StopAsync<TResponse>(string id, StopRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
StopRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Stop<TResponse>(string, StopRequestParameters)

POST on /_plugins/_rollup/jobs/{id}/_stop

https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job

Declaration

public TResponse Stop<TResponse>(string id, StopRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Rollup to access.
StopRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)