Class LowLevelFlowFrameworkNamespace

Flow Framework APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelFlowFrameworkNamespace

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

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelFlowFrameworkNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

CreateAsync<TResponse>(PostData, CreateRequestParameters, CancellationToken)

POST on /_plugins/_flow_framework/workflow

https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/

Declaration

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

Parameters

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

| Edit this page View Source

Create<TResponse>(PostData, CreateRequestParameters)

POST on /_plugins/_flow_framework/workflow

https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/

Declaration

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

Parameters

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

| Edit this page View Source

DeleteAsync<TResponse>(string, DeleteRequestParameters, CancellationToken)

DELETE on /_plugins/_flow_framework/workflow/{workflow_id}

https://opensearch.org/docs/latest/automating-configurations/api/delete-workflow/

Declaration

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

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
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

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

| Edit this page View Source

Delete<TResponse>(string, DeleteRequestParameters)

DELETE on /_plugins/_flow_framework/workflow/{workflow_id}

https://opensearch.org/docs/latest/automating-configurations/api/delete-workflow/

Declaration

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

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
DeleteRequestParameters	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.12.0 or greater.

| Edit this page View Source

DeprovisionAsync<TResponse>(string, DeprovisionRequestParameters, CancellationToken)

POST on /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision

https://opensearch.org/docs/latest/automating-configurations/api/deprovision-workflow/

Declaration

public Task<TResponse> DeprovisionAsync<TResponse>(string workflowId, DeprovisionRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
DeprovisionRequestParameters	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.12.0 or greater.

| Edit this page View Source

Deprovision<TResponse>(string, DeprovisionRequestParameters)

POST on /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision

https://opensearch.org/docs/latest/automating-configurations/api/deprovision-workflow/

Declaration

public TResponse Deprovision<TResponse>(string workflowId, DeprovisionRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
DeprovisionRequestParameters	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.12.0 or greater.

| Edit this page View Source

GetAsync<TResponse>(string, GetRequestParameters, CancellationToken)

GET on /_plugins/_flow_framework/workflow/{workflow_id}

https://opensearch.org/docs/latest/automating-configurations/api/get-workflow/

Declaration

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

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
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

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

| Edit this page View Source

GetStatusAsync<TResponse>(string, GetStatusRequestParameters, CancellationToken)

GET on /_plugins/_flow_framework/workflow/{workflow_id}/_status

https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-status/

Declaration

public Task<TResponse> GetStatusAsync<TResponse>(string workflowId, GetStatusRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
GetStatusRequestParameters	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.12.0 or greater.

| Edit this page View Source

GetStatus<TResponse>(string, GetStatusRequestParameters)

GET on /_plugins/_flow_framework/workflow/{workflow_id}/_status

https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-status/

Declaration

public TResponse GetStatus<TResponse>(string workflowId, GetStatusRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
GetStatusRequestParameters	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.12.0 or greater.

| Edit this page View Source

GetStepsAsync<TResponse>(GetStepsRequestParameters, CancellationToken)

GET on /_plugins/_flow_framework/workflow/_steps

https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-steps/

Declaration

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

Parameters

Type	Name	Description
GetStepsRequestParameters	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.12.0 or greater.

| Edit this page View Source

GetSteps<TResponse>(GetStepsRequestParameters)

GET on /_plugins/_flow_framework/workflow/_steps

https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-steps/

Declaration

public TResponse GetSteps<TResponse>(GetStepsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetStepsRequestParameters	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.12.0 or greater.

| Edit this page View Source

Get<TResponse>(string, GetRequestParameters)

GET on /_plugins/_flow_framework/workflow/{workflow_id}

https://opensearch.org/docs/latest/automating-configurations/api/get-workflow/

Declaration

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

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
GetRequestParameters	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.12.0 or greater.

| Edit this page View Source

ProvisionAsync<TResponse>(string, PostData, ProvisionRequestParameters, CancellationToken)

POST on /_plugins/_flow_framework/workflow/{workflow_id}/_provision

https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/

Declaration

public Task<TResponse> ProvisionAsync<TResponse>(string workflowId, PostData body, ProvisionRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
PostData	body	A map of user-provided substitution expressions and their values.
ProvisionRequestParameters	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.12.0 or greater.

| Edit this page View Source

Provision<TResponse>(string, PostData, ProvisionRequestParameters)

POST on /_plugins/_flow_framework/workflow/{workflow_id}/_provision

https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/

Declaration

public TResponse Provision<TResponse>(string workflowId, PostData body, ProvisionRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
PostData	body	A map of user-provided substitution expressions and their values.
ProvisionRequestParameters	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.12.0 or greater.

| Edit this page View Source

SearchAsync<TResponse>(PostData, SearchRequestParameters, CancellationToken)

POST on /_plugins/_flow_framework/workflow/_search

https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/

Declaration

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

Parameters

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

| Edit this page View Source

SearchStateAsync<TResponse>(PostData, SearchStateRequestParameters, CancellationToken)

POST on /_plugins/_flow_framework/workflow/state/_search

https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/

Declaration

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

Parameters

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

| Edit this page View Source

SearchState<TResponse>(PostData, SearchStateRequestParameters)

POST on /_plugins/_flow_framework/workflow/state/_search

https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/

Declaration

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

Parameters

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

| Edit this page View Source

Search<TResponse>(PostData, SearchRequestParameters)

POST on /_plugins/_flow_framework/workflow/_search

https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/

Declaration

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

Parameters

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

| Edit this page View Source

UpdateAsync<TResponse>(string, PostData, UpdateRequestParameters, CancellationToken)

PUT on /_plugins/_flow_framework/workflow/{workflow_id}

https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/

Declaration

public Task<TResponse> UpdateAsync<TResponse>(string workflowId, PostData body, UpdateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
PostData	body
UpdateRequestParameters	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.12.0 or greater.

| Edit this page View Source

Update<TResponse>(string, PostData, UpdateRequestParameters)

PUT on /_plugins/_flow_framework/workflow/{workflow_id}

https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/

Declaration

public TResponse Update<TResponse>(string workflowId, PostData body, UpdateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	workflowId	The ID of the workflow.
PostData	body
UpdateRequestParameters	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.12.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)