Class TriggerRunClient
java.lang.Object
com.azure.analytics.synapse.artifacts.TriggerRunClient
Initializes a new instance of the synchronous ArtifactsClient type.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cancelTriggerInstance
(String triggerName, String runId) Cancel single trigger instance by runId.cancelTriggerInstanceWithResponse
(String triggerName, String runId, Context context) Cancel single trigger instance by runId.queryTriggerRunsByWorkspace
(RunFilterParameters filterParameters) Query trigger runs.queryTriggerRunsByWorkspaceWithResponse
(RunFilterParameters filterParameters, Context context) Query trigger runs.void
rerunTriggerInstance
(String triggerName, String runId) Rerun single trigger instance by runId.rerunTriggerInstanceWithResponse
(String triggerName, String runId, Context context) Rerun single trigger instance by runId.
-
Method Details
-
rerunTriggerInstance
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 Response<Void> rerunTriggerInstanceWithResponse(String triggerName, String runId, 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
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 Response<Void> cancelTriggerInstanceWithResponse(String triggerName, String runId, 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
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 Response<TriggerRunsQueryResponse> queryTriggerRunsByWorkspaceWithResponse(RunFilterParameters filterParameters, 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.
-