Package com.azure.resourcemanager.cosmos.fluent

Interface CollectionsClient

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

  • Method Details

    • listMetricsAsync

      com.azure.core.http.rest.PagedFlux<MetricInner> listMetricsAsync(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter)
      Retrieves the metrics determined by the given filter for the given database account and collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      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 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<MetricInner> listMetrics(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter)
      Retrieves the metrics determined by the given filter for the given database account and collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      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 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<MetricInner> listMetrics(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter, com.azure.core.util.Context context)
      Retrieves the metrics determined by the given filter for the given database account and collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      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 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.

    • listUsagesAsync

      com.azure.core.http.rest.PagedFlux<UsageInner> listUsagesAsync(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter)
      Retrieves the usages (most recent storage data) for the given collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      databaseRid - Cosmos DB database rid.
      collectionRid - Cosmos DB collection rid.
      filter - An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
      Returns:
      the response to a list usage 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.

    • listUsagesAsync

      com.azure.core.http.rest.PagedFlux<UsageInner> listUsagesAsync(String resourceGroupName, String accountName, String databaseRid, String collectionRid)
      Retrieves the usages (most recent storage data) for the given collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      databaseRid - Cosmos DB database rid.
      collectionRid - Cosmos DB collection rid.
      Returns:
      the response to a list usage 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.

    • listUsages

      com.azure.core.http.rest.PagedIterable<UsageInner> listUsages(String resourceGroupName, String accountName, String databaseRid, String collectionRid)
      Retrieves the usages (most recent storage data) for the given collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      databaseRid - Cosmos DB database rid.
      collectionRid - Cosmos DB collection rid.
      Returns:
      the response to a list usage 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.

    • listUsages

      com.azure.core.http.rest.PagedIterable<UsageInner> listUsages(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter, com.azure.core.util.Context context)
      Retrieves the usages (most recent storage data) for the given collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      databaseRid - Cosmos DB database rid.
      collectionRid - Cosmos DB collection rid.
      filter - An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
      context - The context to associate with this operation.
      Returns:
      the response to a list usage 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.

    • listMetricDefinitionsAsync

      com.azure.core.http.rest.PagedFlux<MetricDefinitionInner> listMetricDefinitionsAsync(String resourceGroupName, String accountName, String databaseRid, String collectionRid)
      Retrieves metric definitions for the given collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      databaseRid - Cosmos DB database rid.
      collectionRid - Cosmos DB collection rid.
      Returns:
      the response to a list metric definitions 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.

    • listMetricDefinitions

      com.azure.core.http.rest.PagedIterable<MetricDefinitionInner> listMetricDefinitions(String resourceGroupName, String accountName, String databaseRid, String collectionRid)
      Retrieves metric definitions for the given collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      databaseRid - Cosmos DB database rid.
      collectionRid - Cosmos DB collection rid.
      Returns:
      the response to a list metric definitions 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.

    • listMetricDefinitions

      com.azure.core.http.rest.PagedIterable<MetricDefinitionInner> listMetricDefinitions(String resourceGroupName, String accountName, String databaseRid, String collectionRid, com.azure.core.util.Context context)
      Retrieves metric definitions for the given collection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - Cosmos DB database account name.
      databaseRid - Cosmos DB database rid.
      collectionRid - Cosmos DB collection rid.
      context - The context to associate with this operation.
      Returns:
      the response to a list metric definitions 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.