com.azure.resourcemanager.cosmos.models

Class DatabaseAccountUpdateParameters

java.lang.Object

com.azure.resourcemanager.cosmos.models.DatabaseAccountUpdateParameters

public class DatabaseAccountUpdateParameters
extends Object

Parameters for patching Azure Cosmos DB database account properties.

Constructor Summary

Constructors

Constructor and Description
DatabaseAccountUpdateParameters()

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.
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.
String	location() Get the location property: The location of the resource group to which the resource belongs.
List<Location>	locations() Get the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account.
Map<String,String>	tags() Get the tags property: Tags are a list of key-value pairs that describe the resource.
void	validate() Validates the instance.
List<VirtualNetworkRule>	virtualNetworkRules() Get the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
DatabaseAccountUpdateParameters	withCapabilities(List<Capability> capabilities) Set the capabilities property: List of Cosmos DB capabilities for the account.
DatabaseAccountUpdateParameters	withConnectorOffer(ConnectorOffer connectorOffer) Set the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
DatabaseAccountUpdateParameters	withConsistencyPolicy(ConsistencyPolicy consistencyPolicy) Set the consistencyPolicy property: The consistency policy for the Cosmos DB account.
DatabaseAccountUpdateParameters	withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess) Set the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
DatabaseAccountUpdateParameters	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.
DatabaseAccountUpdateParameters	withEnableCassandraConnector(Boolean enableCassandraConnector) Set the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
DatabaseAccountUpdateParameters	withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations) Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
DatabaseAccountUpdateParameters	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.
DatabaseAccountUpdateParameters	withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled) Set the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountUpdateParameters	withLocation(String location) Set the location property: The location of the resource group to which the resource belongs.
DatabaseAccountUpdateParameters	withLocations(List<Location> locations) Set the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account.
DatabaseAccountUpdateParameters	withTags(Map<String,String> tags) Set the tags property: Tags are a list of key-value pairs that describe the resource.
DatabaseAccountUpdateParameters	withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules) Set the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseAccountUpdateParameters

public DatabaseAccountUpdateParameters()

Method Detail

tags

public Map<String,String> tags()

Get the tags property: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

Returns:

the tags value.

withTags

public DatabaseAccountUpdateParameters withTags(Map<String,String> tags)

Set the tags property: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

Parameters:

tags - the tags value to set.

Returns:

the DatabaseAccountUpdateParameters object itself.

location

public String location()

Get the location property: The location of the resource group to which the resource belongs.

Returns:

the location value.

withLocation

public DatabaseAccountUpdateParameters withLocation(String location)

Set the location property: The location of the resource group to which the resource belongs.

Parameters:

location - the location value to set.

Returns:

the DatabaseAccountUpdateParameters object itself.

consistencyPolicy

public ConsistencyPolicy consistencyPolicy()

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

Returns:

the consistencyPolicy value.

withConsistencyPolicy

public DatabaseAccountUpdateParameters withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)

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

Parameters:

consistencyPolicy - the consistencyPolicy value to set.

Returns:

the DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters object itself.

enableMultipleWriteLocations

public Boolean enableMultipleWriteLocations()

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

Returns:

the enableMultipleWriteLocations value.

withEnableMultipleWriteLocations

public DatabaseAccountUpdateParameters withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)

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

Parameters:

enableMultipleWriteLocations - the enableMultipleWriteLocations value to set.

Returns:

the DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.