Share via

ConsumerGroupsClient Interface

  • Reference
Package:
com.azure.resourcemanager.eventhubs.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-eventhubs:2.44.0

public interface ConsumerGroupsClient

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

Method Summary

Modifier and Type Method and Description
abstract ConsumerGroupInner createOrUpdate(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, ConsumerGroupInner parameters)

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
abstract Mono<ConsumerGroupInner> createOrUpdateAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, ConsumerGroupInner parameters)

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
abstract Response<ConsumerGroupInner> createOrUpdateWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, ConsumerGroupInner parameters, Context context)

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
abstract Mono<Response<ConsumerGroupInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, ConsumerGroupInner parameters)

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
abstract void delete(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Deletes a consumer group from the specified Event Hub and resource group.
abstract Mono<Void> deleteAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Deletes a consumer group from the specified Event Hub and resource group.
abstract Response<Void> deleteWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, Context context)

Deletes a consumer group from the specified Event Hub and resource group.
abstract Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Deletes a consumer group from the specified Event Hub and resource group.
abstract ConsumerGroupInner get(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Gets a description for the specified consumer group.
abstract Mono<ConsumerGroupInner> getAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Gets a description for the specified consumer group.
abstract Response<ConsumerGroupInner> getWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, Context context)

Gets a description for the specified consumer group.
abstract Mono<Response<ConsumerGroupInner>> getWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Gets a description for the specified consumer group.
abstract PagedIterable<ConsumerGroupInner> listByEventHub(String resourceGroupName, String namespaceName, String eventHubName)

Gets all the consumer groups in a Namespace.
abstract PagedIterable<ConsumerGroupInner> listByEventHub(String resourceGroupName, String namespaceName, String eventHubName, Integer skip, Integer top, Context context)

Gets all the consumer groups in a Namespace.
abstract PagedFlux<ConsumerGroupInner> listByEventHubAsync(String resourceGroupName, String namespaceName, String eventHubName)

Gets all the consumer groups in a Namespace.
abstract PagedFlux<ConsumerGroupInner> listByEventHubAsync(String resourceGroupName, String namespaceName, String eventHubName, Integer skip, Integer top)

Gets all the consumer groups in a Namespace.

Method Details

createOrUpdate

public abstract ConsumerGroupInner createOrUpdate(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, ConsumerGroupInner parameters)

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.
parameters - Parameters supplied to create or update a consumer group resource.

Returns:

single item in List or Get Consumer group operation.

createOrUpdateAsync

public abstract Mono createOrUpdateAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, ConsumerGroupInner parameters)

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.
parameters - Parameters supplied to create or update a consumer group resource.

Returns:

single item in List or Get Consumer group operation on successful completion of Mono.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, ConsumerGroupInner parameters, Context context)

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.
parameters - Parameters supplied to create or update a consumer group resource.
context - The context to associate with this operation.

Returns:

single item in List or Get Consumer group operation along with Response<T>.

createOrUpdateWithResponseAsync

public abstract Mono> createOrUpdateWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, ConsumerGroupInner parameters)

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.
parameters - Parameters supplied to create or update a consumer group resource.

Returns:

single item in List or Get Consumer group operation along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Deletes a consumer group from the specified Event Hub and resource group.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Deletes a consumer group from the specified Event Hub and resource group.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, Context context)

Deletes a consumer group from the specified Event Hub and resource group.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.
context - The context to associate with this operation.

Returns:

deleteWithResponseAsync

public abstract Mono> deleteWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Deletes a consumer group from the specified Event Hub and resource group.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.

Returns:

the Response<T> on successful completion of Mono.

get

public abstract ConsumerGroupInner get(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Gets a description for the specified consumer group.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.

Returns:

a description for the specified consumer group.

getAsync

public abstract Mono getAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Gets a description for the specified consumer group.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.

Returns:

a description for the specified consumer group on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, Context context)

Gets a description for the specified consumer group.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.
context - The context to associate with this operation.

Returns:

a description for the specified consumer group along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName)

Gets a description for the specified consumer group.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
consumerGroupName - The consumer group name.

Returns:

a description for the specified consumer group along with Response<T> on successful completion of Mono.

listByEventHub

public abstract PagedIterable listByEventHub(String resourceGroupName, String namespaceName, String eventHubName)

Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.

Returns:

all the consumer groups in a Namespace as paginated response with PagedIterable<T>.

listByEventHub

public abstract PagedIterable listByEventHub(String resourceGroupName, String namespaceName, String eventHubName, Integer skip, Integer top, Context context)

Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
skip - Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
top - May be used to limit the number of results to the most recent N usageDetails.
context - The context to associate with this operation.

Returns:

all the consumer groups in a Namespace as paginated response with PagedIterable<T>.

listByEventHubAsync

public abstract PagedFlux listByEventHubAsync(String resourceGroupName, String namespaceName, String eventHubName)

Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.

Returns:

all the consumer groups in a Namespace as paginated response with PagedFlux<T>.

listByEventHubAsync

public abstract PagedFlux listByEventHubAsync(String resourceGroupName, String namespaceName, String eventHubName, Integer skip, Integer top)

Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.

Parameters:

resourceGroupName - Name of the resource group within the azure subscription.
namespaceName - The Namespace name.
eventHubName - The Event Hub name.
skip - Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
top - May be used to limit the number of results to the most recent N usageDetails.

Returns:

all the consumer groups in a Namespace as paginated response with PagedFlux<T>.

Applies to