Package com.azure.resourcemanager.appservice.fluent

Interface WorkflowRunsClient

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

  • Method Details

    • listAsync

      com.azure.core.http.rest.PagedFlux<WorkflowRunInner> 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.
      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.

    • listAsync

      com.azure.core.http.rest.PagedFlux<WorkflowRunInner> 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.
      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<WorkflowRunInner> 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.
      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<WorkflowRunInner> list(String resourceGroupName, String name, String workflowName, Integer top, String filter, com.azure.core.util.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.
      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.

    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<WorkflowRunInner>> 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 on successful completion of Mono.
      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.

    • getAsync

      Mono<WorkflowRunInner> 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.
      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

      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.
      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<WorkflowRunInner> getWithResponse(String resourceGroupName, String name, String workflowName, String runName, com.azure.core.util.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.
      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.

    • cancelWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> 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 on successful completion of Mono.
      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.

    • cancelAsync

      Mono<Void> 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.
      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 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.
      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 name, String workflowName, String runName, com.azure.core.util.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:
      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.