/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*/
package com.microsoft.azure.management.documentdb;
import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.documentdb.implementation.DocumentDBManager;
import com.microsoft.azure.management.documentdb.implementation.DatabaseAccountInner;
import com.microsoft.azure.management.documentdb.implementation.FailoverPolicyInner;
import com.microsoft.azure.management.documentdb.implementation.DatabaseAccountListConnectionStringsResultInner;
import com.microsoft.azure.management.documentdb.implementation.DatabaseAccountListKeysResultInner;
import com.microsoft.azure.management.resources.fluentcore.arm.Region;
import com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.Resource;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import rx.Observable;
import java.util.Map;
/**
* An immutable client-side representation of an Azure document db.
*/
@Fluent
@Beta
public interface DatabaseAccount extends
GroupableResource<DocumentDBManager, DatabaseAccountInner>,
Refreshable<DatabaseAccount>,
Updatable<DatabaseAccount.Update> {
/**
* @return indicates the type of database account
*/
DatabaseAccountKind kind();
/**
* @return the connection endpoint for the DocumentDB database account
*/
String documentEndpoint();
/**
* @return the offer type for the DocumentDB database account
*/
DatabaseAccountOfferType databaseAccountOfferType();
/**
* @return specifies the set of IP addresses or IP address ranges in CIDR form.
*/
String ipRangeFilter();
/**
* @return the consistency policy for the DocumentDB database account
*/
ConsistencyPolicy consistencyPolicy();
/**
* @return an array that contains the regions ordered by their failover priorities
*/
Map<String, FailoverPolicyInner> failoverPolicies();
/**
* @return an array that contains the georeplication locations enabled for the DocumentDB account
*/
Map<String, Location> locations();
/**
* @param failoverPolicies the failover policies
*/
void failoverPriorityChange(FailoverPolicies failoverPolicies);
/**
* @param failoverPolicies the failover policies
* @return the ServiceResponse object if successful.
*/
Observable<Void> failoverPriorityChangeAsync(FailoverPolicies failoverPolicies);
/**
* @return the access keys for the specified Azure DocumentDB database account
*/
DatabaseAccountListKeysResultInner listKeys();
/**
* @return the access keys for the specified Azure DocumentDB database account
*/
Observable<DatabaseAccountListKeysResultInner> listKeysAsync();
/**
* @return the connection strings for the specified Azure DocumentDB database account
*/
DatabaseAccountListConnectionStringsResultInner listConnectionStrings();
/**
* @return the connection strings for the specified Azure DocumentDB database account
*/
Observable<DatabaseAccountListConnectionStringsResultInner> listConnectionStringsAsync();
/**
* @param keyKind the key kind
*/
void regenerateKey(KeyKind keyKind);
/**
* @param keyKind the key kind
* @return the ServiceResponse object if successful.
*/
Observable<Void> regenerateKeyAsync(KeyKind keyKind);
/**
* Grouping of document db definition stages.
*/
interface Definition extends
DefinitionStages.Blank,
DefinitionStages.WithGroup,
DefinitionStages.WithKind,
DefinitionStages.DefineLocations,
DefinitionStages.WithCreate {
}
/**
* Grouping of document db definition stages.
*/
interface DefinitionStages {
/**
* The first stage of a document db definition.
*/
interface Blank extends
DefinitionWithRegion<WithGroup> {
}
/**
* The stage of the document db definition allowing to specify the resource group.
*/
interface WithGroup extends
GroupableResource.DefinitionStages.WithGroup<WithKind> {
}
/**
* The stage of the document db definition allowing to set the database account kind.
*/
interface WithKind {
/**
* The database account kind for the DocumentDB account.
* @return the next stage of the definition
*/
DefineLocations withKind(DatabaseAccountKind kind);
}
/**
* The stage of the document db definition allowing to set the consistency policy.
*/
interface WithConsistencyPolicy {
/**
* The consistency policy for the DocumentDB account.
* @param defaultConsistencyLevel the default consistency level
* @param maxStalenessPrefix the max staleness prefix
* @param maxIntervalInSeconds the max interval in seconds
* @return the next stage of the definition
*/
WithCreate withConsistencyPolicy(DefaultConsistencyLevel defaultConsistencyLevel, int maxStalenessPrefix, int maxIntervalInSeconds);
}
/**
* The stage of the document db definition allowing to set the IP range filter.
*/
interface WithIpRangeFilter {
/**
* DocumentDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR
* form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges
* must be comma separated and must not contain any spaces.
* @param ipRangeFilter specifies the set of IP addresses or IP address ranges
* @return the next stage of the definition
*/
WithCreate withIpRangeFilter(String ipRangeFilter);
}
/**
* The stage of the document db definition allowing the definition of a location.
*/
interface DefineLocations {
/**
* A georeplication location for the DocumentDB account.
* @param region the region for the location
* @return the next stage
*/
DBLocation.DefinitionStages.Blank<WithCreate> defineLocation(Region region);
}
/**
* The stage of the definition which contains all the minimum required inputs for
* the resource to be created, but also allows
* for any other optional settings to be specified.
*/
interface WithCreate extends
Creatable<DatabaseAccount>,
WithConsistencyPolicy,
DefineLocations,
WithIpRangeFilter {
}
}
/**
* Grouping of document db update stages.
*/
interface Update extends
Resource.UpdateWithTags<Update>,
Appliable<DatabaseAccount>,
UpdateStages.WithConsistencyPolicy,
UpdateStages.DefineLocations,
UpdateStages.WithIpRangeFilter {
}
/**
* Grouping of document db update stages.
*/
interface UpdateStages {
/**
* The stage of the document db update allowing to set the consistency policy.
*/
interface WithConsistencyPolicy {
/**
* The consistency policy for the DocumentDB account.
* @param defaultConsistencyLevel the default consistency level
* @param maxStalenessPrefix the max staleness prefix
* @param maxIntervalInSeconds the max interval in seconds
* @return the next stage of the definition
*/
Update withConsistencyPolicy(DefaultConsistencyLevel defaultConsistencyLevel, int maxStalenessPrefix, int maxIntervalInSeconds);
}
/**
* The stage of the document db update allowing the definition of a location.
*/
interface DefineLocations {
/**
* Remove a georeplication location from the DocumentDB account.
* @param region the region for the location
* @return the next stage
*/
Update removeLocation(Region region);
}
/**
* The stage of the document db definition allowing to set the IP range filter.
*/
interface WithIpRangeFilter {
/**
* DocumentDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR
* form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges
* must be comma separated and must not contain any spaces.
* @param ipRangeFilter specifies the set of IP addresses or IP address ranges
* @return the next stage of the definition
*/
Update withIpRangeFilter(String ipRangeFilter);
}
}
}