Package com.azure.resourcemanager.logic.models

Interface WorkflowRuns

public interface WorkflowRuns
Resource collection API of WorkflowRuns.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<WorkflowRun> 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<WorkflowRun> list(String resourceGroupName, String workflowName, Integer top, String filter, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<WorkflowRun> getWithResponse(String resourceGroupName, String workflowName, String runName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      WorkflowRun 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • cancelWithResponse

      com.azure.core.http.rest.Response<Void> cancelWithResponse(String resourceGroupName, String workflowName, String runName, com.azure.core.util.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:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • cancel

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.