Share via


Topics Interface

public interface Topics

Resource collection API of Topics.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new TopicRecord resource.

abstract void delete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName)

Delete confluent topic by name.

abstract void delete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName, Context context)

Delete confluent topic by name.

abstract void deleteById(String id)

Delete confluent topic by name.

abstract void deleteByIdWithResponse(String id, Context context)

Delete confluent topic by name.

abstract TopicRecord get(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName)

Get confluent topic by Name.

abstract TopicRecord getById(String id)

Get confluent topic by Name.

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

Get confluent topic by Name.

abstract Response<TopicRecord> getWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName, Context context)

Get confluent topic by Name.

abstract PagedIterable<TopicRecord> list(String resourceGroupName, String organizationName, String environmentId, String clusterId)

Lists of all the topics in a clusters.

abstract PagedIterable<TopicRecord> list(String resourceGroupName, String organizationName, String environmentId, String clusterId, Integer pageSize, String pageToken, Context context)

Lists of all the topics in a clusters.

Method Details

define

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

Begins definition for a new TopicRecord resource.

Parameters:

name - resource name.

Returns:

the first stage of the new TopicRecord definition.

delete

public abstract void delete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName)

Delete confluent topic by name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
topicName - Confluent kafka or schema registry topic name.

delete

public abstract void delete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName, Context context)

Delete confluent topic by name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
topicName - Confluent kafka or schema registry topic name.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete confluent topic by name.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete confluent topic by name.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

public abstract TopicRecord get(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName)

Get confluent topic by Name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
topicName - Confluent kafka or schema registry topic name.

Returns:

confluent topic by Name.

getById

public abstract TopicRecord getById(String id)

Get confluent topic by Name.

Parameters:

id - the resource ID.

Returns:

confluent topic by Name along with Response<T>.

getByIdWithResponse

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

Get confluent topic by Name.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

confluent topic by Name along with Response<T>.

getWithResponse

public abstract Response<TopicRecord> getWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName, Context context)

Get confluent topic by Name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
topicName - Confluent kafka or schema registry topic name.
context - The context to associate with this operation.

Returns:

confluent topic by Name along with Response<T>.

list

public abstract PagedIterable<TopicRecord> list(String resourceGroupName, String organizationName, String environmentId, String clusterId)

Lists of all the topics in a clusters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.

Returns:

result of GET request to list topics in the cluster of a confluent organization as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<TopicRecord> list(String resourceGroupName, String organizationName, String environmentId, String clusterId, Integer pageSize, String pageToken, Context context)

Lists of all the topics in a clusters.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
pageSize - Pagination size.
pageToken - An opaque pagination token to fetch the next set of records.
context - The context to associate with this operation.

Returns:

result of GET request to list topics in the cluster of a confluent organization as paginated response with PagedIterable<T>.

Applies to