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 name, String workflowName, String runName)

Cancels a workflow run.

abstract Mono<Void> cancelAsync(String resourceGroupName, String name, String workflowName, String runName)

Cancels a workflow run.

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

Cancels a workflow run.

abstract Mono<Response<Void>> cancelWithResponseAsync(String resourceGroupName, String name, String workflowName, String runName)

Cancels a workflow run.

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

Gets a workflow run.

abstract Mono<WorkflowRunInner> getAsync(String resourceGroupName, String name, String workflowName, String runName)

Gets a workflow run.

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

Gets a workflow run.

abstract Mono<Response<WorkflowRunInner>> getWithResponseAsync(String resourceGroupName, String name, String workflowName, String runName)

Gets a workflow run.

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

Gets a list of workflow runs.

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

Gets a list of workflow runs.

abstract PagedFlux<WorkflowRunInner> listAsync(String resourceGroupName, String name, String workflowName)

Gets a list of workflow runs.

abstract PagedFlux<WorkflowRunInner> listAsync(String resourceGroupName, String name, String workflowName, Integer top, String filter)

Gets a list of workflow runs.

Method Details

cancel

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

Cancels a workflow run.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site name.
workflowName - The workflow name.
runName - The workflow run name.

cancelAsync

public abstract Mono cancelAsync(String resourceGroupName, String name, String workflowName, String runName)

Cancels a workflow run.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site name.
workflowName - The workflow name.
runName - The workflow run name.

Returns:

A Mono that completes when a successful response is received.

cancelWithResponse

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

Cancels a workflow run.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site name.
workflowName - The workflow name.
runName - The workflow run name.
context - The context to associate with this operation.

Returns:

cancelWithResponseAsync

public abstract Mono> cancelWithResponseAsync(String resourceGroupName, String name, String workflowName, String runName)

Cancels a workflow run.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site name.
workflowName - The workflow name.
runName - The workflow run name.

Returns:

the Response<T> on successful completion of Mono.

get

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

Gets a workflow run.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site name.
workflowName - The workflow name.
runName - The workflow run name.

Returns:

a workflow run.

getAsync

public abstract Mono getAsync(String resourceGroupName, String name, String workflowName, String runName)

Gets a workflow run.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site name.
workflowName - The workflow name.
runName - The workflow run name.

Returns:

a workflow run on successful completion of Mono.

getWithResponse

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

Gets a workflow run.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site 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>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String name, String workflowName, String runName)

Gets a workflow run.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site name.
workflowName - The workflow name.
runName - The workflow run name.

Returns:

a workflow run along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list(String resourceGroupName, String name, String workflowName)

Gets a list of workflow runs.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site 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 name, String workflowName, Integer top, String filter, Context context)

Gets a list of workflow runs.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site 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>.

listAsync

public abstract PagedFlux listAsync(String resourceGroupName, String name, String workflowName)

Gets a list of workflow runs.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site name.
workflowName - The workflow name.

Returns:

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

listAsync

public abstract PagedFlux listAsync(String resourceGroupName, String name, String workflowName, Integer top, String filter)

Gets a list of workflow runs.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.
name - Site 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.

Returns:

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

Applies to