Package com.azure.resourcemanager.cosmos.fluent

Interface CollectionPartitionRegionsClient

public interface CollectionPartitionRegionsClient
An instance of this class provides access to all the operations defined in CollectionPartitionRegionsClient.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.azure.core.http.rest.PagedIterable<PartitionMetricInner>
    listMetrics(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String filter)
    Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
    com.azure.core.http.rest.PagedIterable<PartitionMetricInner>
    listMetrics(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String filter, com.azure.core.util.Context context)
    Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
    com.azure.core.http.rest.PagedFlux<PartitionMetricInner>
    listMetricsAsync(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String filter)
    Retrieves the metrics determined by the given filter for the given collection and region, split by partition.

  • Method Details

    • listMetricsAsync

      com.azure.core.http.rest.PagedFlux<PartitionMetricInner> listMetricsAsync(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String filter)
      Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
      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.
      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.
      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.

    • listMetrics

      com.azure.core.http.rest.PagedIterable<PartitionMetricInner> listMetrics(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String filter)
      Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
      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.
      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.
      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.

    • listMetrics

      com.azure.core.http.rest.PagedIterable<PartitionMetricInner> listMetrics(String resourceGroupName, String accountName, String region, String databaseRid, String collectionRid, String filter, com.azure.core.util.Context context)
      Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
      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.
      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.
      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.