com.azure.resourcemanager.cosmos.fluent.models

Class DatabaseAccountGetResultsInner

java.lang.Object

com.azure.core.management.ProxyResource

com.azure.core.management.Resource

com.azure.resourcemanager.cosmos.models.ArmResourceProperties

com.azure.resourcemanager.cosmos.fluent.models.DatabaseAccountGetResultsInner

public class DatabaseAccountGetResultsInner
extends ArmResourceProperties

An Azure Cosmos DB database account.

Constructor Summary

Constructors

Constructor and Description
DatabaseAccountGetResultsInner()

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 database account.
DatabaseAccountOfferType	databaseAccountOfferType() Get the databaseAccountOfferType property: The offer type for the Cosmos DB database account.
Boolean	disableKeyBasedMetadataWriteAccess() Get the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
String	documentEndpoint() Get the documentEndpoint property: The connection endpoint for the Cosmos DB database account.
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.
List<FailoverPolicy>	failoverPolicies() Get the failoverPolicies property: An array that contains the regions ordered by their failover priorities.
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 all of the locations enabled for the Cosmos DB account.
String	provisioningState() Get the provisioningState property: The status of the Cosmos DB account at the time the operation was called.
List<Location>	readLocations() Get the readLocations property: An array that contains of the read 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.
DatabaseAccountGetResultsInner	withCapabilities(List<Capability> capabilities) Set the capabilities property: List of Cosmos DB capabilities for the account.
DatabaseAccountGetResultsInner	withConnectorOffer(ConnectorOffer connectorOffer) Set the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
DatabaseAccountGetResultsInner	withConsistencyPolicy(ConsistencyPolicy consistencyPolicy) Set the consistencyPolicy property: The consistency policy for the Cosmos DB database account.
DatabaseAccountGetResultsInner	withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess) Set the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
DatabaseAccountGetResultsInner	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.
DatabaseAccountGetResultsInner	withEnableCassandraConnector(Boolean enableCassandraConnector) Set the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
DatabaseAccountGetResultsInner	withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations) Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
DatabaseAccountGetResultsInner	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.
DatabaseAccountGetResultsInner	withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled) Set the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountGetResultsInner	withKind(DatabaseAccountKind kind) Set the kind property: Indicates the type of database account.
DatabaseAccountGetResultsInner	withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules) Set the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
List<Location>	writeLocations() Get the writeLocations property: An array that contains the write location 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

DatabaseAccountGetResultsInner

public DatabaseAccountGetResultsInner()

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 DatabaseAccountGetResultsInner 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 DatabaseAccountGetResultsInner object itself.

provisioningState

public String provisioningState()

Get the provisioningState property: The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'Offline' - the Cosmos DB account is not active. 'DeletionFailed' – the Cosmos DB account deletion failed.

Returns:

the provisioningState value.

documentEndpoint

public String documentEndpoint()

Get the documentEndpoint property: The connection endpoint for the Cosmos DB database account.

Returns:

the documentEndpoint value.

databaseAccountOfferType

public DatabaseAccountOfferType databaseAccountOfferType()

Get the databaseAccountOfferType property: The offer type for the Cosmos DB database account. Default value: Standard.

Returns:

the databaseAccountOfferType value.

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 DatabaseAccountGetResultsInner 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 DatabaseAccountGetResultsInner 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 DatabaseAccountGetResultsInner 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 DatabaseAccountGetResultsInner 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 DatabaseAccountGetResultsInner 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 DatabaseAccountGetResultsInner object itself.

consistencyPolicy

public ConsistencyPolicy consistencyPolicy()

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

Returns:

the consistencyPolicy value.

withConsistencyPolicy

public DatabaseAccountGetResultsInner withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)

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

Parameters:

consistencyPolicy - the consistencyPolicy value to set.

Returns:

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

writeLocations

public List<Location> writeLocations()

Get the writeLocations property: An array that contains the write location for the Cosmos DB account.

Returns:

the writeLocations value.

readLocations

public List<Location> readLocations()

Get the readLocations property: An array that contains of the read locations enabled for the Cosmos DB account.

Returns:

the readLocations value.

locations

public List<Location> locations()

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

Returns:

the locations value.

failoverPolicies

public List<FailoverPolicy> failoverPolicies()

Get the failoverPolicies property: An array that contains the regions ordered by their failover priorities.

Returns:

the failoverPolicies value.

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 DatabaseAccountGetResultsInner 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 DatabaseAccountGetResultsInner object itself.

enableMultipleWriteLocations

public Boolean enableMultipleWriteLocations()

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

Returns:

the enableMultipleWriteLocations value.

withEnableMultipleWriteLocations

public DatabaseAccountGetResultsInner withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)

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

Parameters:

enableMultipleWriteLocations - the enableMultipleWriteLocations value to set.

Returns:

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

validate

public void validate()

Validates the instance.

Overrides:

validate in class ArmResourceProperties

Throws:

IllegalArgumentException - thrown if the instance is not valid.