Share via

PartitionKeyRangeIdRegionsClient Interface

  • Reference
Package:
com.azure.resourcemanager.cosmos.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1

public interface PartitionKeyRangeIdRegionsClient

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

Method Summary

Modifier and Type Method and Description
abstract PagedIterable<PartitionMetricInner> listMetrics(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String partitionKeyRangeId, String filter)

Retrieves the metrics determined by the given filter for the given partition key range id and region.
abstract PagedIterable<PartitionMetricInner> listMetrics(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String partitionKeyRangeId, String filter, Context context)

Retrieves the metrics determined by the given filter for the given partition key range id and region.
abstract PagedFlux<PartitionMetricInner> listMetricsAsync(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String partitionKeyRangeId, String filter)

Retrieves the metrics determined by the given filter for the given partition key range id and region.

Method Details

listMetrics

public abstract PagedIterable listMetrics(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String partitionKeyRangeId, String filter)

Retrieves the metrics determined by the given filter for the given partition key range id and region.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
accountName - Cosmos DB database account name.
region - Cosmos DB region, with spaces between words and each word capitalized.
databaseRid - Cosmos DB database rid.
collectionRid - Cosmos DB collection rid.
partitionKeyRangeId - Partition Key Range Id for which to get data.
filter - An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Returns:

the response to a list partition metrics request as paginated response with PagedIterable<T>.

listMetrics

public abstract PagedIterable listMetrics(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String partitionKeyRangeId, String filter, Context context)

Retrieves the metrics determined by the given filter for the given partition key range id and region.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
accountName - Cosmos DB database account name.
region - Cosmos DB region, with spaces between words and each word capitalized.
databaseRid - Cosmos DB database rid.
collectionRid - Cosmos DB collection rid.
partitionKeyRangeId - Partition Key Range Id for which to get data.
filter - An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
context - The context to associate with this operation.

Returns:

the response to a list partition metrics request as paginated response with PagedIterable<T>.

listMetricsAsync

public abstract PagedFlux listMetricsAsync(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String partitionKeyRangeId, String filter)

Retrieves the metrics determined by the given filter for the given partition key range id and region.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
accountName - Cosmos DB database account name.
region - Cosmos DB region, with spaces between words and each word capitalized.
databaseRid - Cosmos DB database rid.
collectionRid - Cosmos DB collection rid.
partitionKeyRangeId - Partition Key Range Id for which to get data.
filter - An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Returns:

the response to a list partition metrics request as paginated response with PagedFlux<T>.

Applies to