Share via

CollectionsClient Interface

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

public interface CollectionsClient

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

Method Summary

Modifier and Type Method and Description
abstract PagedIterable<MetricDefinitionInner> listMetricDefinitions(String resourceGroupName, String accountName, String databaseRid, String collectionRid)

Retrieves metric definitions for the given collection.
abstract PagedIterable<MetricDefinitionInner> listMetricDefinitions(String resourceGroupName, String accountName, String databaseRid, String collectionRid, Context context)

Retrieves metric definitions for the given collection.
abstract PagedFlux<MetricDefinitionInner> listMetricDefinitionsAsync(String resourceGroupName, String accountName, String databaseRid, String collectionRid)

Retrieves metric definitions for the given collection.
abstract 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.
abstract PagedIterable<MetricInner> listMetrics(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter, Context context)

Retrieves the metrics determined by the given filter for the given database account and collection.
abstract 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.
abstract PagedIterable<UsageInner> listUsages(String resourceGroupName, String accountName, String databaseRid, String collectionRid)

Retrieves the usages (most recent storage data) for the given collection.
abstract PagedIterable<UsageInner> listUsages(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter, Context context)

Retrieves the usages (most recent storage data) for the given collection.
abstract PagedFlux<UsageInner> listUsagesAsync(String resourceGroupName, String accountName, String databaseRid, String collectionRid)

Retrieves the usages (most recent storage data) for the given collection.
abstract PagedFlux<UsageInner> listUsagesAsync(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter)

Retrieves the usages (most recent storage data) for the given collection.

Method Details

listMetricDefinitions

public abstract PagedIterable 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<T>.

listMetricDefinitions

public abstract PagedIterable listMetricDefinitions(String resourceGroupName, String accountName, String databaseRid, String collectionRid, 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<T>.

listMetricDefinitionsAsync

public abstract PagedFlux 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<T>.

listMetrics

public abstract PagedIterable 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<T>.

listMetrics

public abstract PagedIterable listMetrics(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter, 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<T>.

listMetricsAsync

public abstract PagedFlux 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<T>.

listUsages

public abstract PagedIterable 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<T>.

listUsages

public abstract PagedIterable listUsages(String resourceGroupName, String accountName, String databaseRid, String collectionRid, String filter, 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<T>.

listUsagesAsync

public abstract PagedFlux 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<T>.

listUsagesAsync

public abstract PagedFlux 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<T>.

Applies to