Package com.azure.resourcemanager.datafactory.models

Interface PipelineRuns

public interface PipelineRuns
Resource collection API of PipelineRuns.

  • Method Details

    • queryByFactoryWithResponse

      com.azure.core.http.rest.Response<PipelineRunsQueryResponse> queryByFactoryWithResponse(String resourceGroupName, String factoryName, RunFilterParameters filterParameters, com.azure.core.util.Context context)
      Query pipeline runs in the factory based on input filter conditions.
      Parameters:
      resourceGroupName - The resource group name.
      factoryName - The factory name.
      filterParameters - Parameters to filter the pipeline run.
      context - The context to associate with this operation.
      Returns:
      a list pipeline runs 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.

    • queryByFactory

      PipelineRunsQueryResponse queryByFactory(String resourceGroupName, String factoryName, RunFilterParameters filterParameters)
      Query pipeline runs in the factory based on input filter conditions.
      Parameters:
      resourceGroupName - The resource group name.
      factoryName - The factory name.
      filterParameters - Parameters to filter the pipeline run.
      Returns:
      a list pipeline runs.
      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<PipelineRun> getWithResponse(String resourceGroupName, String factoryName, String runId, com.azure.core.util.Context context)
      Get a pipeline run by its run ID.
      Parameters:
      resourceGroupName - The resource group name.
      factoryName - The factory name.
      runId - The pipeline run identifier.
      context - The context to associate with this operation.
      Returns:
      a pipeline run by its run ID 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

      PipelineRun get(String resourceGroupName, String factoryName, String runId)
      Get a pipeline run by its run ID.
      Parameters:
      resourceGroupName - The resource group name.
      factoryName - The factory name.
      runId - The pipeline run identifier.
      Returns:
      a pipeline run by its run ID.
      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 factoryName, String runId, Boolean isRecursive, com.azure.core.util.Context context)
      Cancel a pipeline run by its run ID.
      Parameters:
      resourceGroupName - The resource group name.
      factoryName - The factory name.
      runId - The pipeline run identifier.
      isRecursive - If true, cancel all the Child pipelines that are triggered by the current pipeline.
      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 factoryName, String runId)
      Cancel a pipeline run by its run ID.
      Parameters:
      resourceGroupName - The resource group name.
      factoryName - The factory name.
      runId - The pipeline run identifier.
      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.