TriggerClient Class

Package:

com.azure.analytics.synapse.artifacts

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.TriggerClient

public final class TriggerClient

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method and Description
TriggerResource	createOrUpdateTrigger(String triggerName, TriggerResource trigger) Creates or updates a trigger.
TriggerResource	createOrUpdateTrigger(String triggerName, TriggerResource trigger, String ifMatch) Creates or updates a trigger.
Response<TriggerResource>	createOrUpdateTriggerWithResponse(String triggerName, TriggerResource trigger, String ifMatch, Context context) Creates or updates a trigger.
void	deleteTrigger(String triggerName) Deletes a trigger.
Response<Void>	deleteTriggerWithResponse(String triggerName, Context context) Deletes a trigger.
TriggerSubscriptionOperationStatus	getEventSubscriptionStatus(String triggerName) Get a trigger's event subscription status.
Response<TriggerSubscriptionOperationStatus>	getEventSubscriptionStatusWithResponse(String triggerName, Context context) Get a trigger's event subscription status.
TriggerResource	getTrigger(String triggerName) Gets a trigger.
TriggerResource	getTrigger(String triggerName, String ifNoneMatch) Gets a trigger.
Response<TriggerResource>	getTriggerWithResponse(String triggerName, String ifNoneMatch, Context context) Gets a trigger.
PagedIterable<TriggerResource>	getTriggersByWorkspace() Lists triggers.
PagedIterable<TriggerResource>	getTriggersByWorkspace(Context context) Lists triggers.
void	startTrigger(String triggerName) Starts a trigger.
Response<Void>	startTriggerWithResponse(String triggerName, Context context) Starts a trigger.
void	stopTrigger(String triggerName) Stops a trigger.
Response<Void>	stopTriggerWithResponse(String triggerName, Context context) Stops a trigger.
TriggerSubscriptionOperationStatus	subscribeTriggerToEvents(String triggerName) Subscribe event trigger to events.
Response<TriggerSubscriptionOperationStatus>	subscribeTriggerToEventsWithResponse(String triggerName, Context context) Subscribe event trigger to events.
TriggerSubscriptionOperationStatus	unsubscribeTriggerFromEvents(String triggerName) Unsubscribe event trigger from events.
Response<TriggerSubscriptionOperationStatus>	unsubscribeTriggerFromEventsWithResponse(String triggerName, Context context) Unsubscribe event trigger from events.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createOrUpdateTrigger

public TriggerResource createOrUpdateTrigger(String triggerName, TriggerResource trigger)

Creates or updates a trigger.

Parameters:

triggerName - The trigger name.

trigger - Trigger resource definition.

Returns:

trigger resource type.

createOrUpdateTrigger

public TriggerResource createOrUpdateTrigger(String triggerName, TriggerResource trigger, String ifMatch)

Creates or updates a trigger.

Parameters:

triggerName - The trigger name.

trigger - Trigger resource definition.

ifMatch - ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Returns:

trigger resource type.

createOrUpdateTriggerWithResponse

public Response createOrUpdateTriggerWithResponse(String triggerName, TriggerResource trigger, String ifMatch, Context context)

Creates or updates a trigger.

Parameters:

triggerName - The trigger name.

trigger - Trigger resource definition.

ifMatch - ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

context - The context to associate with this operation.

Returns:

trigger resource type along with Response<T>.

deleteTrigger

public void deleteTrigger(String triggerName)

Deletes a trigger.

Parameters:

triggerName - The trigger name.

deleteTriggerWithResponse

public Response deleteTriggerWithResponse(String triggerName, Context context)

Deletes a trigger.

Parameters:

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

the Response<T>.

getEventSubscriptionStatus

public TriggerSubscriptionOperationStatus getEventSubscriptionStatus(String triggerName)

Get a trigger's event subscription status.

Parameters:

triggerName - The trigger name.

Returns:

a trigger's event subscription status.

getEventSubscriptionStatusWithResponse

public Response getEventSubscriptionStatusWithResponse(String triggerName, Context context)

Get a trigger's event subscription status.

Parameters:

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

a trigger's event subscription status along with Response<T>.

getTrigger

public TriggerResource getTrigger(String triggerName)

Gets a trigger.

Parameters:

triggerName - The trigger name.

Returns:

a trigger.

getTrigger

public TriggerResource getTrigger(String triggerName, String ifNoneMatch)

Gets a trigger.

Parameters:

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.

Returns:

a trigger.

getTriggerWithResponse

public Response getTriggerWithResponse(String triggerName, String ifNoneMatch, Context context)

Gets a trigger.

Parameters:

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<T>.

getTriggersByWorkspace

public PagedIterable getTriggersByWorkspace()

Lists triggers.

Returns:

a list of trigger resources as paginated response with PagedIterable<T>.

getTriggersByWorkspace

public PagedIterable getTriggersByWorkspace(Context context)

Lists triggers.

Parameters:

context - The context to associate with this operation.

Returns:

a list of trigger resources as paginated response with PagedIterable<T>.

startTrigger

public void startTrigger(String triggerName)

Starts a trigger.

Parameters:

triggerName - The trigger name.

startTriggerWithResponse

public Response startTriggerWithResponse(String triggerName, Context context)

Starts a trigger.

Parameters:

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

the Response<T>.

stopTrigger

public void stopTrigger(String triggerName)

Stops a trigger.

Parameters:

triggerName - The trigger name.

stopTriggerWithResponse

public Response stopTriggerWithResponse(String triggerName, Context context)

Stops a trigger.

Parameters:

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

the Response<T>.

subscribeTriggerToEvents

public TriggerSubscriptionOperationStatus subscribeTriggerToEvents(String triggerName)

Subscribe event trigger to events.

Parameters:

triggerName - The trigger name.

Returns:

defines the response of a trigger subscription operation.

subscribeTriggerToEventsWithResponse

public Response subscribeTriggerToEventsWithResponse(String triggerName, Context context)

Subscribe event trigger to events.

Parameters:

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

defines the response of a trigger subscription operation along with Response<T>.

unsubscribeTriggerFromEvents

public TriggerSubscriptionOperationStatus unsubscribeTriggerFromEvents(String triggerName)

Unsubscribe event trigger from events.

Parameters:

triggerName - The trigger name.

Returns:

defines the response of a trigger subscription operation.

unsubscribeTriggerFromEventsWithResponse

public Response unsubscribeTriggerFromEventsWithResponse(String triggerName, Context context)

Unsubscribe event trigger from events.

Parameters:

triggerName - The trigger name.

context - The context to associate with this operation.

Returns:

defines the response of a trigger subscription operation along with Response<T>.