Package com.azure.resourcemanager.datafactory.models

Interface Triggers

public interface Triggers

Resource collection API of Triggers.

Method Summary

Modifier and Type	Method	Description
TriggerResource.DefinitionStages.Blank	define(String name)	Begins definition for a new TriggerResource resource.
void	delete(String resourceGroupName, String factoryName, String triggerName)	Deletes a trigger.
void	deleteById(String id)	Deletes a trigger.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a trigger.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String factoryName, String triggerName, com.azure.core.util.Context context)	Deletes a trigger.
TriggerResource	get(String resourceGroupName, String factoryName, String triggerName)	Gets a trigger.
TriggerResource	getById(String id)	Gets a trigger.
com.azure.core.http.rest.Response<TriggerResource>	getByIdWithResponse(String id, String ifNoneMatch, com.azure.core.util.Context context)	Gets a trigger.
TriggerSubscriptionOperationStatus	getEventSubscriptionStatus(String resourceGroupName, String factoryName, String triggerName)	Get a trigger's event subscription status.
com.azure.core.http.rest.Response<TriggerSubscriptionOperationStatus>	getEventSubscriptionStatusWithResponse(String resourceGroupName, String factoryName, String triggerName, com.azure.core.util.Context context)	Get a trigger's event subscription status.
com.azure.core.http.rest.Response<TriggerResource>	getWithResponse(String resourceGroupName, String factoryName, String triggerName, String ifNoneMatch, com.azure.core.util.Context context)	Gets a trigger.
com.azure.core.http.rest.PagedIterable<TriggerResource>	listByFactory(String resourceGroupName, String factoryName)	Lists triggers.
com.azure.core.http.rest.PagedIterable<TriggerResource>	listByFactory(String resourceGroupName, String factoryName, com.azure.core.util.Context context)	Lists triggers.
TriggerQueryResponse	queryByFactory(String resourceGroupName, String factoryName, TriggerFilterParameters filterParameters)	Query triggers.
com.azure.core.http.rest.Response<TriggerQueryResponse>	queryByFactoryWithResponse(String resourceGroupName, String factoryName, TriggerFilterParameters filterParameters, com.azure.core.util.Context context)	Query triggers.
void	start(String resourceGroupName, String factoryName, String triggerName)	Starts a trigger.
void	start(String resourceGroupName, String factoryName, String triggerName, com.azure.core.util.Context context)	Starts a trigger.
void	stop(String resourceGroupName, String factoryName, String triggerName)	Stops a trigger.
void	stop(String resourceGroupName, String factoryName, String triggerName, com.azure.core.util.Context context)	Stops a trigger.
TriggerSubscriptionOperationStatus	subscribeToEvents(String resourceGroupName, String factoryName, String triggerName)	Subscribe event trigger to events.
TriggerSubscriptionOperationStatus	subscribeToEvents(String resourceGroupName, String factoryName, String triggerName, com.azure.core.util.Context context)	Subscribe event trigger to events.
TriggerSubscriptionOperationStatus	unsubscribeFromEvents(String resourceGroupName, String factoryName, String triggerName)	Unsubscribe event trigger from events.
TriggerSubscriptionOperationStatus	unsubscribeFromEvents(String resourceGroupName, String factoryName, String triggerName, com.azure.core.util.Context context)	Unsubscribe event trigger from events.

Method Detail

listByFactory

com.azure.core.http.rest.PagedIterable<TriggerResource> listByFactory(String resourceGroupName,
                                                                      String factoryName)

Lists triggers.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

Returns:

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

listByFactory

com.azure.core.http.rest.PagedIterable<TriggerResource> listByFactory(String resourceGroupName,
                                                                      String factoryName,
                                                                      com.azure.core.util.Context context)

Lists triggers.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

context - The context to associate with this operation.

Returns:

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

queryByFactory

TriggerQueryResponse queryByFactory(String resourceGroupName,
                                    String factoryName,
                                    TriggerFilterParameters filterParameters)

Query triggers.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

filterParameters - Parameters to filter the triggers.

Returns:

a query of triggers.

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<TriggerQueryResponse> queryByFactoryWithResponse(String resourceGroupName,
                                                                                   String factoryName,
                                                                                   TriggerFilterParameters filterParameters,
                                                                                   com.azure.core.util.Context context)

Query triggers.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

filterParameters - Parameters to filter the triggers.

context - The context to associate with this operation.

Returns:

a query of triggers 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

TriggerResource get(String resourceGroupName,
                    String factoryName,
                    String triggerName)

Gets a trigger.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

Returns:

a trigger.

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<TriggerResource> getWithResponse(String resourceGroupName,
                                                                   String factoryName,
                                                                   String triggerName,
                                                                   String ifNoneMatch,
                                                                   com.azure.core.util.Context context)

Gets a trigger.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

ifNoneMatch - ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

context - The context to associate with this operation.

Returns:

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

delete

void delete(String resourceGroupName,
            String factoryName,
            String triggerName)

Deletes a trigger.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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

deleteWithResponse

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

Deletes a trigger.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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

subscribeToEvents

TriggerSubscriptionOperationStatus subscribeToEvents(String resourceGroupName,
                                                     String factoryName,
                                                     String triggerName)

Subscribe event trigger to events.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

Returns:

defines the response of a trigger subscription operation.

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.

subscribeToEvents

TriggerSubscriptionOperationStatus subscribeToEvents(String resourceGroupName,
                                                     String factoryName,
                                                     String triggerName,
                                                     com.azure.core.util.Context context)

Subscribe event trigger to events.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

defines the response of a trigger subscription operation.

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.

getEventSubscriptionStatus

TriggerSubscriptionOperationStatus getEventSubscriptionStatus(String resourceGroupName,
                                                              String factoryName,
                                                              String triggerName)

Get a trigger's event subscription status.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

Returns:

a trigger's event subscription status.

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.

getEventSubscriptionStatusWithResponse

com.azure.core.http.rest.Response<TriggerSubscriptionOperationStatus> getEventSubscriptionStatusWithResponse(String resourceGroupName,
                                                                                                             String factoryName,
                                                                                                             String triggerName,
                                                                                                             com.azure.core.util.Context context)

Get a trigger's event subscription status.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

a trigger's event subscription status 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.

unsubscribeFromEvents

TriggerSubscriptionOperationStatus unsubscribeFromEvents(String resourceGroupName,
                                                         String factoryName,
                                                         String triggerName)

Unsubscribe event trigger from events.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

Returns:

defines the response of a trigger subscription operation.

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.

unsubscribeFromEvents

TriggerSubscriptionOperationStatus unsubscribeFromEvents(String resourceGroupName,
                                                         String factoryName,
                                                         String triggerName,
                                                         com.azure.core.util.Context context)

Unsubscribe event trigger from events.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

defines the response of a trigger subscription operation.

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.

start

void start(String resourceGroupName,
           String factoryName,
           String triggerName)

Starts a trigger.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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

start

void start(String resourceGroupName,
           String factoryName,
           String triggerName,
           com.azure.core.util.Context context)

Starts a trigger.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

context - The context to associate with this operation.

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.

stop

void stop(String resourceGroupName,
          String factoryName,
          String triggerName)

Stops a trigger.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

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

stop

void stop(String resourceGroupName,
          String factoryName,
          String triggerName,
          com.azure.core.util.Context context)

Stops a trigger.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

triggerName - The trigger name.

context - The context to associate with this operation.

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.

getById

TriggerResource getById(String id)

Gets a trigger.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

com.azure.core.http.rest.Response<TriggerResource> getByIdWithResponse(String id,
                                                                       String ifNoneMatch,
                                                                       com.azure.core.util.Context context)

Gets a trigger.

Parameters:

id - the resource ID.

ifNoneMatch - ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

context - The context to associate with this operation.

Returns:

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

deleteById

void deleteById(String id)

Deletes a trigger.

Parameters:

id - the resource 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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Deletes a trigger.

Parameters:

id - the resource ID.

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.

define

TriggerResource.DefinitionStages.Blank define(String name)

Begins definition for a new TriggerResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new TriggerResource definition.