WorkflowRunsClient Interface

public interface WorkflowRunsClient

An instance of this class provides access to all the operations defined in WorkflowRunsClient.

Method Summary

Modifier and Type Method and Description
abstract void cancel(String resourceGroupName, String workflowName, String runName)

Cancels a workflow run.

abstract Response<Void> cancelWithResponse(String resourceGroupName, String workflowName, String runName, Context context)

Cancels a workflow run.

abstract WorkflowRunInner get(String resourceGroupName, String workflowName, String runName)

Gets a workflow run.

abstract Response<WorkflowRunInner> getWithResponse(String resourceGroupName, String workflowName, String runName, Context context)

Gets a workflow run.

abstract PagedIterable<WorkflowRunInner> list(String resourceGroupName, String workflowName)

Gets a list of workflow runs.

abstract PagedIterable<WorkflowRunInner> list(String resourceGroupName, String workflowName, Integer top, String filter, Context context)

Gets a list of workflow runs.

Method Details

cancel

public abstract void cancel(String resourceGroupName, String workflowName, String runName)

Cancels a workflow run.

Parameters:

resourceGroupName - The resource group name.
workflowName - The workflow name.
runName - The workflow run name.

cancelWithResponse

public abstract Response cancelWithResponse(String resourceGroupName, String workflowName, String runName, Context context)

Cancels a workflow run.

Parameters:

resourceGroupName - The resource group name.
workflowName - The workflow name.
runName - The workflow run name.
context - The context to associate with this operation.

Returns:

get

public abstract WorkflowRunInner get(String resourceGroupName, String workflowName, String runName)

Gets a workflow run.

Parameters:

resourceGroupName - The resource group name.
workflowName - The workflow name.
runName - The workflow run name.

Returns:

a workflow run.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String workflowName, String runName, Context context)

Gets a workflow run.

Parameters:

resourceGroupName - The resource group name.
workflowName - The workflow name.
runName - The workflow run name.
context - The context to associate with this operation.

Returns:

a workflow run along with Response<T>.

list

public abstract PagedIterable list(String resourceGroupName, String workflowName)

Gets a list of workflow runs.

Parameters:

resourceGroupName - The resource group name.
workflowName - The workflow name.

Returns:

a list of workflow runs as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String resourceGroupName, String workflowName, Integer top, String filter, Context context)

Gets a list of workflow runs.

Parameters:

resourceGroupName - The resource group name.
workflowName - The workflow name.
top - The number of items to be included in the result.
filter - The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.
context - The context to associate with this operation.

Returns:

a list of workflow runs as paginated response with PagedIterable<T>.

Applies to