Interface TopicsClient
public interface TopicsClient
An instance of this class provides access to all the operations defined in TopicsClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicInner>,
TopicInner> beginCreateOrUpdate
(String resourceGroupName, String topicName, TopicInner topicInfo) Asynchronously creates a new topic with the specified parameters.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicInner>,
TopicInner> beginCreateOrUpdate
(String resourceGroupName, String topicName, TopicInner topicInfo, com.azure.core.util.Context context) Asynchronously creates a new topic with the specified parameters.beginDelete
(String resourceGroupName, String topicName) Delete existing topic.beginDelete
(String resourceGroupName, String topicName, com.azure.core.util.Context context) Delete existing topic.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicSharedAccessKeysInner>,
TopicSharedAccessKeysInner> beginRegenerateKey
(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest) Regenerate a shared access key for a topic.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicSharedAccessKeysInner>,
TopicSharedAccessKeysInner> beginRegenerateKey
(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest, com.azure.core.util.Context context) Regenerate a shared access key for a topic.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicInner>,
TopicInner> beginUpdate
(String resourceGroupName, String topicName, TopicUpdateParameters topicUpdateParameters) Asynchronously updates a topic with the specified parameters.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicInner>,
TopicInner> beginUpdate
(String resourceGroupName, String topicName, TopicUpdateParameters topicUpdateParameters, com.azure.core.util.Context context) Asynchronously updates a topic with the specified parameters.createOrUpdate
(String resourceGroupName, String topicName, TopicInner topicInfo) Asynchronously creates a new topic with the specified parameters.createOrUpdate
(String resourceGroupName, String topicName, TopicInner topicInfo, com.azure.core.util.Context context) Asynchronously creates a new topic with the specified parameters.void
Delete existing topic.void
Delete existing topic.getByResourceGroup
(String resourceGroupName, String topicName) Get properties of a topic.com.azure.core.http.rest.Response<TopicInner>
getByResourceGroupWithResponse
(String resourceGroupName, String topicName, com.azure.core.util.Context context) Get properties of a topic.com.azure.core.http.rest.PagedIterable<TopicInner>
list()
List all the topics under an Azure subscription.com.azure.core.http.rest.PagedIterable<TopicInner>
List all the topics under an Azure subscription.com.azure.core.http.rest.PagedIterable<TopicInner>
listByResourceGroup
(String resourceGroupName) List all the topics under a resource group.com.azure.core.http.rest.PagedIterable<TopicInner>
listByResourceGroup
(String resourceGroupName, String filter, Integer top, com.azure.core.util.Context context) List all the topics under a resource group.com.azure.core.http.rest.PagedIterable<EventTypeInner>
listEventTypes
(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName) List event types for a topic.com.azure.core.http.rest.PagedIterable<EventTypeInner>
listEventTypes
(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName, com.azure.core.util.Context context) List event types for a topic.listSharedAccessKeys
(String resourceGroupName, String topicName) List the two keys used to publish to a topic.com.azure.core.http.rest.Response<TopicSharedAccessKeysInner>
listSharedAccessKeysWithResponse
(String resourceGroupName, String topicName, com.azure.core.util.Context context) List the two keys used to publish to a topic.regenerateKey
(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest) Regenerate a shared access key for a topic.regenerateKey
(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest, com.azure.core.util.Context context) Regenerate a shared access key for a topic.update
(String resourceGroupName, String topicName, TopicUpdateParameters topicUpdateParameters) Asynchronously updates a topic with the specified parameters.update
(String resourceGroupName, String topicName, TopicUpdateParameters topicUpdateParameters, com.azure.core.util.Context context) Asynchronously updates a topic with the specified parameters.
-
Method Details
-
getByResourceGroup
Get properties of a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.- Returns:
- properties 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<TopicInner> getByResourceGroupWithResponse(String resourceGroupName, String topicName, com.azure.core.util.Context context) Get properties of a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.context
- The context to associate with this operation.- Returns:
- properties 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicInner>,TopicInner> beginCreateOrUpdate(String resourceGroupName, String topicName, TopicInner topicInfo) Asynchronously creates a new topic with the specified parameters.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.topicInfo
- Topic information.- Returns:
- the
SyncPoller
for polling of eventGrid 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicInner>,TopicInner> beginCreateOrUpdate(String resourceGroupName, String topicName, TopicInner topicInfo, com.azure.core.util.Context context) Asynchronously creates a new topic with the specified parameters.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.topicInfo
- Topic information.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of eventGrid 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.
-
createOrUpdate
Asynchronously creates a new topic with the specified parameters.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.topicInfo
- Topic information.- Returns:
- eventGrid 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.
-
createOrUpdate
TopicInner createOrUpdate(String resourceGroupName, String topicName, TopicInner topicInfo, com.azure.core.util.Context context) Asynchronously creates a new topic with the specified parameters.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.topicInfo
- Topic information.context
- The context to associate with this operation.- Returns:
- eventGrid 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String topicName) Delete existing topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String topicName, com.azure.core.util.Context context) Delete existing topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
delete
Delete existing topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the 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.
-
delete
Delete existing topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.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.
-
beginUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicInner>,TopicInner> beginUpdate(String resourceGroupName, String topicName, TopicUpdateParameters topicUpdateParameters) Asynchronously updates a topic with the specified parameters.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.topicUpdateParameters
- Topic update information.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicInner>,TopicInner> beginUpdate(String resourceGroupName, String topicName, TopicUpdateParameters topicUpdateParameters, com.azure.core.util.Context context) Asynchronously updates a topic with the specified parameters.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.topicUpdateParameters
- Topic update information.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
update
TopicInner update(String resourceGroupName, String topicName, TopicUpdateParameters topicUpdateParameters) Asynchronously updates a topic with the specified parameters.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.topicUpdateParameters
- Topic update information.- 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.
-
update
TopicInner update(String resourceGroupName, String topicName, TopicUpdateParameters topicUpdateParameters, com.azure.core.util.Context context) Asynchronously updates a topic with the specified parameters.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.topicUpdateParameters
- Topic update information.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.
-
list
com.azure.core.http.rest.PagedIterable<TopicInner> list()List all the topics under an Azure subscription.- Returns:
- result of the List Topics operation as paginated response with
PagedIterable
. - Throws:
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<TopicInner> list(String filter, Integer top, com.azure.core.util.Context context) List all the topics under an Azure subscription.- Parameters:
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 Topics 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.
-
listByResourceGroup
List all the topics under a resource group.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.- Returns:
- result of the List Topics 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<TopicInner> listByResourceGroup(String resourceGroupName, String filter, Integer top, com.azure.core.util.Context context) List all the topics under a resource group.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.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 Topics 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.
-
beginRegenerateKey
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicSharedAccessKeysInner>,TopicSharedAccessKeysInner> beginRegenerateKey(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest) Regenerate a shared access key for a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.regenerateKeyRequest
- Request body to regenerate key.- Returns:
- the
SyncPoller
for polling of shared access keys of the 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.
-
beginRegenerateKey
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<TopicSharedAccessKeysInner>,TopicSharedAccessKeysInner> beginRegenerateKey(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest, com.azure.core.util.Context context) Regenerate a shared access key for a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.regenerateKeyRequest
- Request body to regenerate key.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of shared access keys of the 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.
-
regenerateKey
TopicSharedAccessKeysInner regenerateKey(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest) Regenerate a shared access key for a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.regenerateKeyRequest
- Request body to regenerate key.- Returns:
- shared access keys of the 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.
-
regenerateKey
TopicSharedAccessKeysInner regenerateKey(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest, com.azure.core.util.Context context) Regenerate a shared access key for a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.topicName
- Name of the topic.regenerateKeyRequest
- Request body to regenerate key.context
- The context to associate with this operation.- Returns:
- shared access keys of the 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.
-
listEventTypes
com.azure.core.http.rest.PagedIterable<EventTypeInner> listEventTypes(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName) List event types for a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.providerNamespace
- Namespace of the provider of the topic.resourceTypeName
- Name of the topic type.resourceName
- Name of the topic.- Returns:
- result of the List Event Types 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.
-
listEventTypes
com.azure.core.http.rest.PagedIterable<EventTypeInner> listEventTypes(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName, com.azure.core.util.Context context) List event types for a topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.providerNamespace
- Namespace of the provider of the topic.resourceTypeName
- Name of the topic type.resourceName
- Name of the topic.context
- The context to associate with this operation.- Returns:
- result of the List Event Types 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.
-