Share via


TopicsClient Interface

public interface TopicsClient

An instance of this class provides access to all the operations defined in TopicsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName)

Delete confluent topic by name.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName, Context context)

Delete confluent topic by name.

abstract TopicRecordInner create(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName)

Create confluent topics by Name.

abstract Response<TopicRecordInner> createWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName, TopicRecordInner body, Context context)

Create confluent topics by Name.

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 TopicRecordInner get(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName)

Get confluent topic by Name.

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

Get confluent topic by Name.

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

Lists of all the topics in a clusters.

abstract PagedIterable<TopicRecordInner> 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

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

create

public abstract TopicRecordInner create(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName)

Create confluent topics 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:

details of topic record.

createWithResponse

public abstract Response<TopicRecordInner> createWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, String topicName, TopicRecordInner body, Context context)

Create confluent topics 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.
body - Confluent Topics resource model.
context - The context to associate with this operation.

Returns:

details of topic record along with Response<T>.

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.

get

public abstract TopicRecordInner 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.

getWithResponse

public abstract Response<TopicRecordInner> 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<TopicRecordInner> 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<TopicRecordInner> 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