Interface TopicEventSubscriptions
public interface TopicEventSubscriptions
Resource collection API of TopicEventSubscriptions.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new EventSubscription resource.void
Delete an existing event subscription for a topic.void
delete
(String resourceGroupName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context) Delete an existing event subscription for a topic.void
deleteById
(String id) Delete an existing event subscription for a topic.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete an existing event subscription for a topic.Get properties of an event subscription of a topic.Get properties of an event subscription of a topic.com.azure.core.http.rest.Response<EventSubscription>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Get properties of an event subscription of a topic.getDeliveryAttributes
(String resourceGroupName, String topicName, String eventSubscriptionName) Get all delivery attributes for an event subscription for topic.com.azure.core.http.rest.Response<DeliveryAttributeListResult>
getDeliveryAttributesWithResponse
(String resourceGroupName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context) Get all delivery attributes for an event subscription for topic.getFullUrl
(String resourceGroupName, String topicName, String eventSubscriptionName) Get the full endpoint URL for an event subscription for topic.com.azure.core.http.rest.Response<EventSubscriptionFullUrl>
getFullUrlWithResponse
(String resourceGroupName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context) Get the full endpoint URL for an event subscription for topic.com.azure.core.http.rest.Response<EventSubscription>
getWithResponse
(String resourceGroupName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context) Get properties of an event subscription of a topic.com.azure.core.http.rest.PagedIterable<EventSubscription>
List all event subscriptions that have been created for a specific topic.com.azure.core.http.rest.PagedIterable<EventSubscription>
list
(String resourceGroupName, String topicName, String filter, Integer top, com.azure.core.util.Context context) List all event subscriptions that have been created for a specific topic.
-
Method Details
-
getDeliveryAttributes
DeliveryAttributeListResult getDeliveryAttributes(String resourceGroupName, String topicName, String eventSubscriptionName) Get all delivery attributes for an event subscription for topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the domain topic.eventSubscriptionName
- Name of the event subscription.- Returns:
- all delivery attributes for an event subscription for topic.
- 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.
-
getDeliveryAttributesWithResponse
com.azure.core.http.rest.Response<DeliveryAttributeListResult> getDeliveryAttributesWithResponse(String resourceGroupName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context) Get all delivery attributes for an event subscription for topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the domain topic.eventSubscriptionName
- Name of the event subscription.context
- The context to associate with this operation.- Returns:
- all delivery attributes for an event subscription for topic 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
Get properties of an event subscription of a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the partner topic.eventSubscriptionName
- Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.- Returns:
- properties of an event subscription of a topic.
- 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<EventSubscription> getWithResponse(String resourceGroupName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context) Get properties of an event subscription of a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the partner topic.eventSubscriptionName
- Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.context
- The context to associate with this operation.- Returns:
- properties of an event subscription of a topic 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
Delete an existing event subscription for a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.eventSubscriptionName
- Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.- 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 topicName, String eventSubscriptionName, com.azure.core.util.Context context) Delete an existing event subscription for a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.eventSubscriptionName
- Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.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.
-
getFullUrl
EventSubscriptionFullUrl getFullUrl(String resourceGroupName, String topicName, String eventSubscriptionName) Get the full endpoint URL for an event subscription for topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the domain topic.eventSubscriptionName
- Name of the event subscription.- Returns:
- the full endpoint URL for an event subscription for topic.
- 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.
-
getFullUrlWithResponse
com.azure.core.http.rest.Response<EventSubscriptionFullUrl> getFullUrlWithResponse(String resourceGroupName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context) Get the full endpoint URL for an event subscription for topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the domain topic.eventSubscriptionName
- Name of the event subscription.context
- The context to associate with this operation.- Returns:
- the full endpoint URL for an event subscription for topic 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.
-
list
com.azure.core.http.rest.PagedIterable<EventSubscription> list(String resourceGroupName, String topicName) List all event subscriptions that have been created for a specific topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.- Returns:
- result of the List EventSubscriptions operation 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.
-
list
com.azure.core.http.rest.PagedIterable<EventSubscription> list(String resourceGroupName, String topicName, String filter, Integer top, com.azure.core.util.Context context) List all event subscriptions that have been created for a specific topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.filter
- The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.top
- The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.context
- The context to associate with this operation.- Returns:
- result of the List EventSubscriptions operation 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.
-
getById
Get properties of an event subscription of a topic.- Parameters:
id
- the resource ID.- Returns:
- properties of an event subscription of a topic 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<EventSubscription> getByIdWithResponse(String id, com.azure.core.util.Context context) Get properties of an event subscription of a topic.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- properties of an event subscription of a topic 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
Delete an existing event subscription for a topic.- 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
Delete an existing event subscription for a topic.- Parameters:
id
- the resource ID.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.
-
define
Begins definition for a new EventSubscription resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new EventSubscription definition.
-