Share via

RestorableMongodbResourcesClient Interface

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

public interface RestorableMongodbResourcesClient

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

Method Summary

Modifier and Type Method and Description
abstract PagedIterable<RestorableMongodbResourcesGetResultInner> list(String location, String instanceId)

Return a list of database and collection combo that exist on the account at the given timestamp and location.
abstract PagedIterable<RestorableMongodbResourcesGetResultInner> list(String location, String instanceId, String restoreLocation, String restoreTimestampInUtc, Context context)

Return a list of database and collection combo that exist on the account at the given timestamp and location.
abstract PagedFlux<RestorableMongodbResourcesGetResultInner> listAsync(String location, String instanceId)

Return a list of database and collection combo that exist on the account at the given timestamp and location.
abstract PagedFlux<RestorableMongodbResourcesGetResultInner> listAsync(String location, String instanceId, String restoreLocation, String restoreTimestampInUtc)

Return a list of database and collection combo that exist on the account at the given timestamp and location.

Method Details

list

public abstract PagedIterable list(String location, String instanceId)

Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.

Parameters:

location - Cosmos DB region, with spaces between words and each word capitalized.
instanceId - The instanceId GUID of a restorable database account.

Returns:

the List operation response, that contains the restorable MongoDB resources as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String location, String instanceId, String restoreLocation, String restoreTimestampInUtc, Context context)

Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.

Parameters:

location - Cosmos DB region, with spaces between words and each word capitalized.
instanceId - The instanceId GUID of a restorable database account.
restoreLocation - The location where the restorable resources are located.
restoreTimestampInUtc - The timestamp when the restorable resources existed.
context - The context to associate with this operation.

Returns:

the List operation response, that contains the restorable MongoDB resources as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync(String location, String instanceId)

Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.

Parameters:

location - Cosmos DB region, with spaces between words and each word capitalized.
instanceId - The instanceId GUID of a restorable database account.

Returns:

the List operation response, that contains the restorable MongoDB resources as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux listAsync(String location, String instanceId, String restoreLocation, String restoreTimestampInUtc)

Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.

Parameters:

location - Cosmos DB region, with spaces between words and each word capitalized.
instanceId - The instanceId GUID of a restorable database account.
restoreLocation - The location where the restorable resources are located.
restoreTimestampInUtc - The timestamp when the restorable resources existed.

Returns:

the List operation response, that contains the restorable MongoDB resources as paginated response with PagedFlux<T>.

Applies to