Class TriggerRunClient

java.lang.Object
com.azure.analytics.synapse.artifacts.TriggerRunClient

public final class TriggerRunClient extends Object
Initializes a new instance of the synchronous ArtifactsClient type.
  • Method Details

    • rerunTriggerInstance

      public void rerunTriggerInstance(String triggerName, String runId)
      Rerun single trigger instance by runId.
      Parameters:
      triggerName - The trigger name.
      runId - The pipeline run identifier.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • rerunTriggerInstanceWithResponse

      public com.azure.core.http.rest.Response<Void> rerunTriggerInstanceWithResponse(String triggerName, String runId, com.azure.core.util.Context context)
      Rerun single trigger instance by runId.
      Parameters:
      triggerName - The trigger name.
      runId - The pipeline run identifier.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • cancelTriggerInstance

      public void cancelTriggerInstance(String triggerName, String runId)
      Cancel single trigger instance by runId.
      Parameters:
      triggerName - The trigger name.
      runId - The pipeline run identifier.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • cancelTriggerInstanceWithResponse

      public com.azure.core.http.rest.Response<Void> cancelTriggerInstanceWithResponse(String triggerName, String runId, com.azure.core.util.Context context)
      Cancel single trigger instance by runId.
      Parameters:
      triggerName - The trigger name.
      runId - The pipeline run identifier.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • queryTriggerRunsByWorkspace

      public TriggerRunsQueryResponse queryTriggerRunsByWorkspace(RunFilterParameters filterParameters)
      Query trigger runs.
      Parameters:
      filterParameters - Parameters to filter the pipeline run.
      Returns:
      a list of trigger runs.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • queryTriggerRunsByWorkspaceWithResponse

      public com.azure.core.http.rest.Response<TriggerRunsQueryResponse> queryTriggerRunsByWorkspaceWithResponse(RunFilterParameters filterParameters, com.azure.core.util.Context context)
      Query trigger runs.
      Parameters:
      filterParameters - Parameters to filter the pipeline run.
      context - The context to associate with this operation.
      Returns:
      a list of trigger runs along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      CloudErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.