com.azure.resourcemanager.cosmos.models

Class DatabaseAccountCreateUpdateParameters

java.lang.Object

com.azure.core.management.ProxyResource

com.azure.core.management.Resource

com.azure.resourcemanager.cosmos.models.ArmResourceProperties

com.azure.resourcemanager.cosmos.models.DatabaseAccountCreateUpdateParameters

public class DatabaseAccountCreateUpdateParameters
extends ArmResourceProperties

Parameters to create and update Cosmos DB database accounts.

Constructor Summary

Constructors

Constructor and Description
DatabaseAccountCreateUpdateParameters() Creates an instance of DatabaseAccountCreateUpdateParameters class.

Method Summary

Modifier and Type	Method and Description
List<Capability>	capabilities() Get the capabilities property: List of Cosmos DB capabilities for the account.
ConnectorOffer	connectorOffer() Get the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
ConsistencyPolicy	consistencyPolicy() Get the consistencyPolicy property: The consistency policy for the Cosmos DB account.
String	databaseAccountOfferType() Get the databaseAccountOfferType property: The offer type for the database.
Boolean	disableKeyBasedMetadataWriteAccess() Get the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
Boolean	enableAutomaticFailover() Get the enableAutomaticFailover property: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage.
Boolean	enableCassandraConnector() Get the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
Boolean	enableMultipleWriteLocations() Get the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
String	ipRangeFilter() Get the ipRangeFilter property: Cosmos DB 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.
Boolean	isVirtualNetworkFilterEnabled() Get the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountKind	kind() Get the kind property: Indicates the type of database account.
List<Location>	locations() Get the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account.
void	validate() Validates the instance.
List<VirtualNetworkRule>	virtualNetworkRules() Get the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
DatabaseAccountCreateUpdateParameters	withCapabilities(List<Capability> capabilities) Set the capabilities property: List of Cosmos DB capabilities for the account.
DatabaseAccountCreateUpdateParameters	withConnectorOffer(ConnectorOffer connectorOffer) Set the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
DatabaseAccountCreateUpdateParameters	withConsistencyPolicy(ConsistencyPolicy consistencyPolicy) Set the consistencyPolicy property: The consistency policy for the Cosmos DB account.
DatabaseAccountCreateUpdateParameters	withDatabaseAccountOfferType(String databaseAccountOfferType) Set the databaseAccountOfferType property: The offer type for the database.
DatabaseAccountCreateUpdateParameters	withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess) Set the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
DatabaseAccountCreateUpdateParameters	withEnableAutomaticFailover(Boolean enableAutomaticFailover) Set the enableAutomaticFailover property: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage.
DatabaseAccountCreateUpdateParameters	withEnableCassandraConnector(Boolean enableCassandraConnector) Set the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
DatabaseAccountCreateUpdateParameters	withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations) Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
DatabaseAccountCreateUpdateParameters	withIpRangeFilter(String ipRangeFilter) Set the ipRangeFilter property: Cosmos DB 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.
DatabaseAccountCreateUpdateParameters	withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled) Set the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountCreateUpdateParameters	withKind(DatabaseAccountKind kind) Set the kind property: Indicates the type of database account.
DatabaseAccountCreateUpdateParameters	withLocations(List<Location> locations) Set the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account.
DatabaseAccountCreateUpdateParameters	withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules) Set the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.

Methods inherited from class com.azure.core.management.Resource

location, tags, withLocation, withTags

Methods inherited from class com.azure.core.management.ProxyResource

id, name, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseAccountCreateUpdateParameters

public DatabaseAccountCreateUpdateParameters()

Creates an instance of DatabaseAccountCreateUpdateParameters class.

Method Detail

kind

public DatabaseAccountKind kind()

Get the kind property: Indicates the type of database account. This can only be set at database account creation.

Returns:

the kind value.

withKind

public DatabaseAccountCreateUpdateParameters withKind(DatabaseAccountKind kind)

Set the kind property: Indicates the type of database account. This can only be set at database account creation.

Parameters:

kind - the kind value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

consistencyPolicy

public ConsistencyPolicy consistencyPolicy()

Get the consistencyPolicy property: The consistency policy for the Cosmos DB account.

Returns:

the consistencyPolicy value.

withConsistencyPolicy

public DatabaseAccountCreateUpdateParameters withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)

Set the consistencyPolicy property: The consistency policy for the Cosmos DB account.

Parameters:

consistencyPolicy - the consistencyPolicy value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

locations

public List<Location> locations()

Get the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account.

Returns:

the locations value.

withLocations

public DatabaseAccountCreateUpdateParameters withLocations(List<Location> locations)

Set the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account.

Parameters:

locations - the locations value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

databaseAccountOfferType

public String databaseAccountOfferType()

Get the databaseAccountOfferType property: The offer type for the database.

Returns:

the databaseAccountOfferType value.

withDatabaseAccountOfferType

public DatabaseAccountCreateUpdateParameters withDatabaseAccountOfferType(String databaseAccountOfferType)

Set the databaseAccountOfferType property: The offer type for the database.

Parameters:

databaseAccountOfferType - the databaseAccountOfferType value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

ipRangeFilter

public String ipRangeFilter()

Get the ipRangeFilter property: Cosmos DB 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.

Returns:

the ipRangeFilter value.

withIpRangeFilter

public DatabaseAccountCreateUpdateParameters withIpRangeFilter(String ipRangeFilter)

Set the ipRangeFilter property: Cosmos DB 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.

Parameters:

ipRangeFilter - the ipRangeFilter value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

isVirtualNetworkFilterEnabled

public Boolean isVirtualNetworkFilterEnabled()

Get the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.

Returns:

the isVirtualNetworkFilterEnabled value.

withIsVirtualNetworkFilterEnabled

public DatabaseAccountCreateUpdateParameters withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)

Set the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.

Parameters:

isVirtualNetworkFilterEnabled - the isVirtualNetworkFilterEnabled value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

enableAutomaticFailover

public Boolean enableAutomaticFailover()

Get the enableAutomaticFailover property: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

Returns:

the enableAutomaticFailover value.

withEnableAutomaticFailover

public DatabaseAccountCreateUpdateParameters withEnableAutomaticFailover(Boolean enableAutomaticFailover)

Set the enableAutomaticFailover property: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

Parameters:

enableAutomaticFailover - the enableAutomaticFailover value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

capabilities

public List<Capability> capabilities()

Get the capabilities property: List of Cosmos DB capabilities for the account.

Returns:

the capabilities value.

withCapabilities

public DatabaseAccountCreateUpdateParameters withCapabilities(List<Capability> capabilities)

Set the capabilities property: List of Cosmos DB capabilities for the account.

Parameters:

capabilities - the capabilities value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

virtualNetworkRules

public List<VirtualNetworkRule> virtualNetworkRules()

Get the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.

Returns:

the virtualNetworkRules value.

withVirtualNetworkRules

public DatabaseAccountCreateUpdateParameters withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)

Set the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.

Parameters:

virtualNetworkRules - the virtualNetworkRules value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

enableMultipleWriteLocations

public Boolean enableMultipleWriteLocations()

Get the enableMultipleWriteLocations property: Enables the account to write in multiple locations.

Returns:

the enableMultipleWriteLocations value.

withEnableMultipleWriteLocations

public DatabaseAccountCreateUpdateParameters withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)

Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.

Parameters:

enableMultipleWriteLocations - the enableMultipleWriteLocations value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

enableCassandraConnector

public Boolean enableCassandraConnector()

Get the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.

Returns:

the enableCassandraConnector value.

withEnableCassandraConnector

public DatabaseAccountCreateUpdateParameters withEnableCassandraConnector(Boolean enableCassandraConnector)

Set the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.

Parameters:

enableCassandraConnector - the enableCassandraConnector value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

connectorOffer

public ConnectorOffer connectorOffer()

Get the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.

Returns:

the connectorOffer value.

withConnectorOffer

public DatabaseAccountCreateUpdateParameters withConnectorOffer(ConnectorOffer connectorOffer)

Set the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.

Parameters:

connectorOffer - the connectorOffer value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

disableKeyBasedMetadataWriteAccess

public Boolean disableKeyBasedMetadataWriteAccess()

Get the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.

Returns:

the disableKeyBasedMetadataWriteAccess value.

withDisableKeyBasedMetadataWriteAccess

public DatabaseAccountCreateUpdateParameters withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)

Set the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.

Parameters:

disableKeyBasedMetadataWriteAccess - the disableKeyBasedMetadataWriteAccess value to set.

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class ArmResourceProperties

Throws:

IllegalArgumentException - thrown if the instance is not valid.