com.azure.resourcemanager.datafactory.fluent.TriggersClient Maven / Gradle / Ivy
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.datafactory.fluent;
import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.management.polling.PollResult;
import com.azure.core.util.Context;
import com.azure.core.util.polling.SyncPoller;
import com.azure.resourcemanager.datafactory.fluent.models.TriggerQueryResponseInner;
import com.azure.resourcemanager.datafactory.fluent.models.TriggerResourceInner;
import com.azure.resourcemanager.datafactory.fluent.models.TriggerSubscriptionOperationStatusInner;
import com.azure.resourcemanager.datafactory.models.TriggerFilterParameters;
/**
* An instance of this class provides access to all the operations defined in TriggersClient.
*/
public interface TriggersClient {
/**
* Lists triggers.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a list of trigger resources as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByFactory(String resourceGroupName, String factoryName);
/**
* Lists triggers.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a list of trigger resources as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByFactory(String resourceGroupName, String factoryName, Context context);
/**
* Query triggers.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param filterParameters Parameters to filter the triggers.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a query of triggers along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response queryByFactoryWithResponse(String resourceGroupName, String factoryName,
TriggerFilterParameters filterParameters, Context context);
/**
* Query triggers.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param filterParameters Parameters to filter the triggers.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a query of triggers.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
TriggerQueryResponseInner queryByFactory(String resourceGroupName, String factoryName,
TriggerFilterParameters filterParameters);
/**
* Creates or updates a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param trigger Trigger resource definition.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return trigger resource type along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response createOrUpdateWithResponse(String resourceGroupName, String factoryName,
String triggerName, TriggerResourceInner trigger, String ifMatch, Context context);
/**
* Creates or updates a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param trigger Trigger resource definition.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return trigger resource type.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
TriggerResourceInner createOrUpdate(String resourceGroupName, String factoryName, String triggerName,
TriggerResourceInner trigger);
/**
* Gets a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a trigger along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getWithResponse(String resourceGroupName, String factoryName, String triggerName,
String ifNoneMatch, Context context);
/**
* Gets a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a trigger.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
TriggerResourceInner get(String resourceGroupName, String factoryName, String triggerName);
/**
* Deletes a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response deleteWithResponse(String resourceGroupName, String factoryName, String triggerName,
Context context);
/**
* Deletes a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void delete(String resourceGroupName, String factoryName, String triggerName);
/**
* Subscribe event trigger to events.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of defines the response of a trigger subscription operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, TriggerSubscriptionOperationStatusInner>
beginSubscribeToEvents(String resourceGroupName, String factoryName, String triggerName);
/**
* Subscribe event trigger to events.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of defines the response of a trigger subscription operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, TriggerSubscriptionOperationStatusInner>
beginSubscribeToEvents(String resourceGroupName, String factoryName, String triggerName, Context context);
/**
* Subscribe event trigger to events.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return defines the response of a trigger subscription operation.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
TriggerSubscriptionOperationStatusInner subscribeToEvents(String resourceGroupName, String factoryName,
String triggerName);
/**
* Subscribe event trigger to events.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return defines the response of a trigger subscription operation.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
TriggerSubscriptionOperationStatusInner subscribeToEvents(String resourceGroupName, String factoryName,
String triggerName, Context context);
/**
* Get a trigger's event subscription status.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a trigger's event subscription status along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getEventSubscriptionStatusWithResponse(String resourceGroupName,
String factoryName, String triggerName, Context context);
/**
* Get a trigger's event subscription status.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a trigger's event subscription status.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
TriggerSubscriptionOperationStatusInner getEventSubscriptionStatus(String resourceGroupName, String factoryName,
String triggerName);
/**
* Unsubscribe event trigger from events.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of defines the response of a trigger subscription operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, TriggerSubscriptionOperationStatusInner>
beginUnsubscribeFromEvents(String resourceGroupName, String factoryName, String triggerName);
/**
* Unsubscribe event trigger from events.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of defines the response of a trigger subscription operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, TriggerSubscriptionOperationStatusInner>
beginUnsubscribeFromEvents(String resourceGroupName, String factoryName, String triggerName, Context context);
/**
* Unsubscribe event trigger from events.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return defines the response of a trigger subscription operation.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
TriggerSubscriptionOperationStatusInner unsubscribeFromEvents(String resourceGroupName, String factoryName,
String triggerName);
/**
* Unsubscribe event trigger from events.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return defines the response of a trigger subscription operation.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
TriggerSubscriptionOperationStatusInner unsubscribeFromEvents(String resourceGroupName, String factoryName,
String triggerName, Context context);
/**
* Starts a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of long-running operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, Void> beginStart(String resourceGroupName, String factoryName, String triggerName);
/**
* Starts a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of long-running operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, Void> beginStart(String resourceGroupName, String factoryName, String triggerName,
Context context);
/**
* Starts a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void start(String resourceGroupName, String factoryName, String triggerName);
/**
* Starts a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void start(String resourceGroupName, String factoryName, String triggerName, Context context);
/**
* Stops a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of long-running operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, Void> beginStop(String resourceGroupName, String factoryName, String triggerName);
/**
* Stops a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of long-running operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, Void> beginStop(String resourceGroupName, String factoryName, String triggerName,
Context context);
/**
* Stops a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void stop(String resourceGroupName, String factoryName, String triggerName);
/**
* Stops a trigger.
*
* @param resourceGroupName The resource group name.
* @param factoryName The factory name.
* @param triggerName The trigger name.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void stop(String resourceGroupName, String factoryName, String triggerName, Context context);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy