com.azure.resourcemanager.eventhubs.fluent

Interface ConsumerGroupsClient

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
ConsumerGroupInner	createOrUpdate(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName) Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
Mono<ConsumerGroupInner>	createOrUpdateAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName) Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
Mono<ConsumerGroupInner>	createOrUpdateAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, String userMetadata) Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
com.azure.core.http.rest.Response<ConsumerGroupInner>	createOrUpdateWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, String userMetadata, com.azure.core.util.Context context) Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
Mono<com.azure.core.http.rest.Response<ConsumerGroupInner>>	createOrUpdateWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, String userMetadata) Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
void	delete(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName) Deletes a consumer group from the specified Event Hub and resource group.
Mono<Void>	deleteAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName) Deletes a consumer group from the specified Event Hub and resource group.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, com.azure.core.util.Context context) Deletes a consumer group from the specified Event Hub and resource group.
Mono<com.azure.core.http.rest.Response<Void>>	deleteWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName) Deletes a consumer group from the specified Event Hub and resource group.
ConsumerGroupInner	get(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName) Gets a description for the specified consumer group.
Mono<ConsumerGroupInner>	getAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName) Gets a description for the specified consumer group.
com.azure.core.http.rest.Response<ConsumerGroupInner>	getWithResponse(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName, com.azure.core.util.Context context) Gets a description for the specified consumer group.
Mono<com.azure.core.http.rest.Response<ConsumerGroupInner>>	getWithResponseAsync(String resourceGroupName, String namespaceName, String eventHubName, String consumerGroupName) Gets a description for the specified consumer group.
com.azure.core.http.rest.PagedIterable<ConsumerGroupInner>	listByEventHub(String resourceGroupName, String namespaceName, String eventHubName) Gets all the consumer groups in a Namespace.
com.azure.core.http.rest.PagedIterable<ConsumerGroupInner>	listByEventHub(String resourceGroupName, String namespaceName, String eventHubName, Integer skip, Integer top, com.azure.core.util.Context context) Gets all the consumer groups in a Namespace.
com.azure.core.http.rest.PagedFlux<ConsumerGroupInner>	listByEventHubAsync(String resourceGroupName, String namespaceName, String eventHubName) Gets all the consumer groups in a Namespace.
com.azure.core.http.rest.PagedFlux<ConsumerGroupInner>	listByEventHubAsync(String resourceGroupName, String namespaceName, String eventHubName, Integer skip, Integer top) Gets all the consumer groups in a Namespace.

Method Detail

createOrUpdateWithResponseAsync

Mono<com.azure.core.http.rest.Response<ConsumerGroupInner>> createOrUpdateWithResponseAsync(String resourceGroupName,
                                                                                            String namespaceName,
                                                                                            String eventHubName,
                                                                                            String consumerGroupName,
                                                                                            String userMetadata)

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.

userMetadata - User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

Returns:

single item in List or Get Consumer group 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.

createOrUpdateAsync

Mono<ConsumerGroupInner> createOrUpdateAsync(String resourceGroupName,
                                             String namespaceName,
                                             String eventHubName,
                                             String consumerGroupName,
                                             String userMetadata)

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.

userMetadata - User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

Returns:

single item in List or Get Consumer group 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.

createOrUpdateAsync

Mono<ConsumerGroupInner> createOrUpdateAsync(String resourceGroupName,
                                             String namespaceName,
                                             String eventHubName,
                                             String consumerGroupName)

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.

Returns:

single item in List or Get Consumer group 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.

createOrUpdate

ConsumerGroupInner createOrUpdate(String resourceGroupName,
                                  String namespaceName,
                                  String eventHubName,
                                  String consumerGroupName)

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.

Returns:

single item in List or Get Consumer group 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.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<ConsumerGroupInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                 String namespaceName,
                                                                                 String eventHubName,
                                                                                 String consumerGroupName,
                                                                                 String userMetadata,
                                                                                 com.azure.core.util.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.

userMetadata - User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

context - The context to associate with this operation.

Returns:

single item in List or Get Consumer group 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.

deleteWithResponseAsync

Mono<com.azure.core.http.rest.Response<Void>> 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 completion.

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.

deleteAsync

Mono<Void> 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:

the completion.

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

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.

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.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String namespaceName,
                                                           String eventHubName,
                                                           String consumerGroupName,
                                                           com.azure.core.util.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:

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.

getWithResponseAsync

Mono<com.azure.core.http.rest.Response<ConsumerGroupInner>> 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.

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.

getAsync

Mono<ConsumerGroupInner> 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.

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.

get

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.

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.

getWithResponse

com.azure.core.http.rest.Response<ConsumerGroupInner> getWithResponse(String resourceGroupName,
                                                                      String namespaceName,
                                                                      String eventHubName,
                                                                      String consumerGroupName,
                                                                      com.azure.core.util.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.

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.

listByEventHubAsync

com.azure.core.http.rest.PagedFlux<ConsumerGroupInner> 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.

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.

listByEventHubAsync

com.azure.core.http.rest.PagedFlux<ConsumerGroupInner> 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.

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.

listByEventHub

com.azure.core.http.rest.PagedIterable<ConsumerGroupInner> listByEventHub(String resourceGroupName,
                                                                          String namespaceName,
                                                                          String eventHubName,
                                                                          Integer skip,
                                                                          Integer top,
                                                                          com.azure.core.util.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.

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.

listByEventHub

com.azure.core.http.rest.PagedIterable<ConsumerGroupInner> 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.

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.