TopicSpaces Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

public interface TopicSpaces

Resource collection API of TopicSpaces.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new TopicSpace resource.
abstract void	delete(String resourceGroupName, String namespaceName, String topicSpaceName) Delete a topic space.
abstract void	delete(String resourceGroupName, String namespaceName, String topicSpaceName, Context context) Delete a topic space.
abstract void	deleteById(String id) Delete a topic space.
abstract void	deleteByIdWithResponse(String id, Context context) Delete a topic space.
abstract TopicSpace	get(String resourceGroupName, String namespaceName, String topicSpaceName) Get a topic space.
abstract TopicSpace	getById(String id) Get a topic space.
abstract Response<TopicSpace>	getByIdWithResponse(String id, Context context) Get a topic space.
abstract Response<TopicSpace>	getWithResponse(String resourceGroupName, String namespaceName, String topicSpaceName, Context context) Get a topic space.
abstract PagedIterable<TopicSpace>	listByNamespace(String resourceGroupName, String namespaceName) List all topic spaces under a namespace.
abstract PagedIterable<TopicSpace>	listByNamespace(String resourceGroupName, String namespaceName, String filter, Integer top, Context context) List all topic spaces under a namespace.

Method Details

define

public abstract TopicSpace.DefinitionStages.Blank define(String name)

Begins definition for a new TopicSpace resource.

Parameters:

name - resource name.

Returns:

the first stage of the new TopicSpace definition.

delete

public abstract void delete(String resourceGroupName, String namespaceName, String topicSpaceName)

Delete a topic space. Delete an existing topic space.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

topicSpaceName - Name of the Topic space.

delete

public abstract void delete(String resourceGroupName, String namespaceName, String topicSpaceName, Context context)

Delete a topic space. Delete an existing topic space.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

topicSpaceName - Name of the Topic space.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete a topic space. Delete an existing topic space.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a topic space. Delete an existing topic space.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

get

public abstract TopicSpace get(String resourceGroupName, String namespaceName, String topicSpaceName)

Get a topic space. Get properties of a topic space.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

topicSpaceName - Name of the Topic space.

Returns:

properties of a topic space.

getById

public abstract TopicSpace getById(String id)

Get a topic space. Get properties of a topic space.

Parameters:

id - the resource ID.

Returns:

properties of a topic space along with Response<T>.

getByIdWithResponse

public abstract Response<TopicSpace> getByIdWithResponse(String id, Context context)

Get a topic space. Get properties of a topic space.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a topic space along with Response<T>.

getWithResponse

public abstract Response<TopicSpace> getWithResponse(String resourceGroupName, String namespaceName, String topicSpaceName, Context context)

Get a topic space. Get properties of a topic space.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

topicSpaceName - Name of the Topic space.

context - The context to associate with this operation.

Returns:

properties of a topic space along with Response<T>.

listByNamespace

public abstract PagedIterable<TopicSpace> listByNamespace(String resourceGroupName, String namespaceName)

List all topic spaces under a namespace. Get all the topic spaces under a namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

Returns:

all the topic spaces under a namespace as paginated response with PagedIterable<T>.

listByNamespace

public abstract PagedIterable<TopicSpace> listByNamespace(String resourceGroupName, String namespaceName, String filter, Integer top, Context context)

List all topic spaces under a namespace. Get all the topic spaces under a namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

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:

all the topic spaces under a namespace as paginated response with PagedIterable<T>.