Package com.azure.resourcemanager.datafactory.models

Interface TriggerRuns

public interface TriggerRuns

Resource collection API of TriggerRuns.

Method Summary

Modifier and Type	Method	Description
void	cancel(String resourceGroupName, String factoryName, String triggerName, String runId)	Cancel a single trigger instance by runId.
com.azure.core.http.rest.Response<Void>	cancelWithResponse(String resourceGroupName, String factoryName, String triggerName, String runId, com.azure.core.util.Context context)	Cancel a single trigger instance by runId.
TriggerRunsQueryResponse	queryByFactory(String resourceGroupName, String factoryName, RunFilterParameters filterParameters)	Query trigger runs.
com.azure.core.http.rest.Response<TriggerRunsQueryResponse>	queryByFactoryWithResponse(String resourceGroupName, String factoryName, RunFilterParameters filterParameters, com.azure.core.util.Context context)	Query trigger runs.
void	rerun(String resourceGroupName, String factoryName, String triggerName, String runId)	Rerun single trigger instance by runId.
com.azure.core.http.rest.Response<Void>	rerunWithResponse(String resourceGroupName, String factoryName, String triggerName, String runId, com.azure.core.util.Context context)	Rerun single trigger instance by runId.

Method Detail

rerun

void rerun(String resourceGroupName,
           String factoryName,
           String triggerName,
           String runId)

Rerun single trigger instance by runId.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger 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.

rerunWithResponse

com.azure.core.http.rest.Response<Void> rerunWithResponse(String resourceGroupName,
                                                          String factoryName,
                                                          String triggerName,
                                                          String runId,
                                                          com.azure.core.util.Context context)

Rerun single trigger instance by runId.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

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 triggerName,
            String runId)

Cancel a single trigger instance by runId.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger 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.

cancelWithResponse

com.azure.core.http.rest.Response<Void> cancelWithResponse(String resourceGroupName,
                                                           String factoryName,
                                                           String triggerName,
                                                           String runId,
                                                           com.azure.core.util.Context context)

Cancel a single trigger instance by runId.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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.

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

TriggerRunsQueryResponse queryByFactory(String resourceGroupName,
                                        String factoryName,
                                        RunFilterParameters filterParameters)

Query trigger runs.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

filterParameters - Parameters to filter the pipeline run.

Returns:

a list of trigger 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.

queryByFactoryWithResponse

com.azure.core.http.rest.Response<TriggerRunsQueryResponse> queryByFactoryWithResponse(String resourceGroupName,
                                                                                       String factoryName,
                                                                                       RunFilterParameters filterParameters,
                                                                                       com.azure.core.util.Context context)

Query trigger runs.

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 of trigger 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.