Package com.azure.resourcemanager.cosmos.fluent.models

Class DatabaseAccountGetProperties

java.lang.Object
com.azure.resourcemanager.cosmos.fluent.models.DatabaseAccountGetProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<DatabaseAccountGetProperties>
public final class DatabaseAccountGetProperties extends Object implements com.azure.json.JsonSerializable<DatabaseAccountGetProperties>
Properties for the database account.

  • Constructor Details

    • DatabaseAccountGetProperties

      public DatabaseAccountGetProperties()
      Creates an instance of DatabaseAccountGetProperties class.

  • Method Details

    • 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. '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.

    • ipRules

      public List<IpAddressOrRange> ipRules()
      Get the ipRules property: List of IpRules.
      Returns:
      the ipRules value.

    • withIpRules

      public DatabaseAccountGetProperties withIpRules(List<IpAddressOrRange> ipRules)
      Set the ipRules property: List of IpRules.
      Parameters:
      ipRules - the ipRules value to set.
      Returns:
      the DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties object itself.

    • privateEndpointConnections

      public List<PrivateEndpointConnectionInner> privateEndpointConnections()
      Get the privateEndpointConnections property: List of Private Endpoint Connections configured for the Cosmos DB account.
      Returns:
      the privateEndpointConnections value.

    • enableMultipleWriteLocations

      public Boolean enableMultipleWriteLocations()
      Get the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
      Returns:
      the enableMultipleWriteLocations value.

    • withEnableMultipleWriteLocations

      public DatabaseAccountGetProperties withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)
      Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
      Parameters:
      enableMultipleWriteLocations - the enableMultipleWriteLocations value to set.
      Returns:
      the DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties 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 DatabaseAccountGetProperties object itself.

    • keyVaultKeyUri

      public String keyVaultKeyUri()
      Get the keyVaultKeyUri property: The URI of the key vault.
      Returns:
      the keyVaultKeyUri value.

    • withKeyVaultKeyUri

      public DatabaseAccountGetProperties withKeyVaultKeyUri(String keyVaultKeyUri)
      Set the keyVaultKeyUri property: The URI of the key vault.
      Parameters:
      keyVaultKeyUri - the keyVaultKeyUri value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • defaultIdentity

      public String defaultIdentity()
      Get the defaultIdentity property: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
      Returns:
      the defaultIdentity value.

    • withDefaultIdentity

      public DatabaseAccountGetProperties withDefaultIdentity(String defaultIdentity)
      Set the defaultIdentity property: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
      Parameters:
      defaultIdentity - the defaultIdentity value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • publicNetworkAccess

      public PublicNetworkAccess publicNetworkAccess()
      Get the publicNetworkAccess property: Whether requests from Public Network are allowed.
      Returns:
      the publicNetworkAccess value.

    • withPublicNetworkAccess

      public DatabaseAccountGetProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
      Set the publicNetworkAccess property: Whether requests from Public Network are allowed.
      Parameters:
      publicNetworkAccess - the publicNetworkAccess value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • enableFreeTier

      public Boolean enableFreeTier()
      Get the enableFreeTier property: Flag to indicate whether Free Tier is enabled.
      Returns:
      the enableFreeTier value.

    • withEnableFreeTier

      public DatabaseAccountGetProperties withEnableFreeTier(Boolean enableFreeTier)
      Set the enableFreeTier property: Flag to indicate whether Free Tier is enabled.
      Parameters:
      enableFreeTier - the enableFreeTier value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • apiProperties

      public ApiProperties apiProperties()
      Get the apiProperties property: API specific properties.
      Returns:
      the apiProperties value.

    • withApiProperties

      public DatabaseAccountGetProperties withApiProperties(ApiProperties apiProperties)
      Set the apiProperties property: API specific properties.
      Parameters:
      apiProperties - the apiProperties value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • enableAnalyticalStorage

      public Boolean enableAnalyticalStorage()
      Get the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.
      Returns:
      the enableAnalyticalStorage value.

    • withEnableAnalyticalStorage

      public DatabaseAccountGetProperties withEnableAnalyticalStorage(Boolean enableAnalyticalStorage)
      Set the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.
      Parameters:
      enableAnalyticalStorage - the enableAnalyticalStorage value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • analyticalStorageConfiguration

      public AnalyticalStorageConfiguration analyticalStorageConfiguration()
      Get the analyticalStorageConfiguration property: Analytical storage specific properties.
      Returns:
      the analyticalStorageConfiguration value.

    • withAnalyticalStorageConfiguration

      public DatabaseAccountGetProperties withAnalyticalStorageConfiguration(AnalyticalStorageConfiguration analyticalStorageConfiguration)
      Set the analyticalStorageConfiguration property: Analytical storage specific properties.
      Parameters:
      analyticalStorageConfiguration - the analyticalStorageConfiguration value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • instanceId

      public String instanceId()
      Get the instanceId property: A unique identifier assigned to the database account.
      Returns:
      the instanceId value.

    • createMode

      public CreateMode createMode()
      Get the createMode property: Enum to indicate the mode of account creation.
      Returns:
      the createMode value.

    • withCreateMode

      public DatabaseAccountGetProperties withCreateMode(CreateMode createMode)
      Set the createMode property: Enum to indicate the mode of account creation.
      Parameters:
      createMode - the createMode value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • restoreParameters

      public RestoreParameters restoreParameters()
      Get the restoreParameters property: Parameters to indicate the information about the restore.
      Returns:
      the restoreParameters value.

    • withRestoreParameters

      public DatabaseAccountGetProperties withRestoreParameters(RestoreParameters restoreParameters)
      Set the restoreParameters property: Parameters to indicate the information about the restore.
      Parameters:
      restoreParameters - the restoreParameters value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • backupPolicy

      public BackupPolicy backupPolicy()
      Get the backupPolicy property: The object representing the policy for taking backups on an account.
      Returns:
      the backupPolicy value.

    • withBackupPolicy

      public DatabaseAccountGetProperties withBackupPolicy(BackupPolicy backupPolicy)
      Set the backupPolicy property: The object representing the policy for taking backups on an account.
      Parameters:
      backupPolicy - the backupPolicy value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • cors

      public List<CorsPolicy> cors()
      Get the cors property: The CORS policy for the Cosmos DB database account.
      Returns:
      the cors value.

    • withCors

      public DatabaseAccountGetProperties withCors(List<CorsPolicy> cors)
      Set the cors property: The CORS policy for the Cosmos DB database account.
      Parameters:
      cors - the cors value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • networkAclBypass

      public NetworkAclBypass networkAclBypass()
      Get the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.
      Returns:
      the networkAclBypass value.

    • withNetworkAclBypass

      public DatabaseAccountGetProperties withNetworkAclBypass(NetworkAclBypass networkAclBypass)
      Set the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.
      Parameters:
      networkAclBypass - the networkAclBypass value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • networkAclBypassResourceIds

      public List<String> networkAclBypassResourceIds()
      Get the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
      Returns:
      the networkAclBypassResourceIds value.

    • withNetworkAclBypassResourceIds

      public DatabaseAccountGetProperties withNetworkAclBypassResourceIds(List<String> networkAclBypassResourceIds)
      Set the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
      Parameters:
      networkAclBypassResourceIds - the networkAclBypassResourceIds value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • disableLocalAuth

      public Boolean disableLocalAuth()
      Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
      Returns:
      the disableLocalAuth value.

    • withDisableLocalAuth

      public DatabaseAccountGetProperties withDisableLocalAuth(Boolean disableLocalAuth)
      Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
      Parameters:
      disableLocalAuth - the disableLocalAuth value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • capacity

      public Capacity capacity()
      Get the capacity property: The object that represents all properties related to capacity enforcement on an account.
      Returns:
      the capacity value.

    • withCapacity

      public DatabaseAccountGetProperties withCapacity(Capacity capacity)
      Set the capacity property: The object that represents all properties related to capacity enforcement on an account.
      Parameters:
      capacity - the capacity value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • keysMetadata

      public DatabaseAccountKeysMetadata keysMetadata()
      Get the keysMetadata property: The object that represents the metadata for the Account Keys of the Cosmos DB account.
      Returns:
      the keysMetadata value.

    • enablePartitionMerge

      public Boolean enablePartitionMerge()
      Get the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.
      Returns:
      the enablePartitionMerge value.

    • withEnablePartitionMerge

      public DatabaseAccountGetProperties withEnablePartitionMerge(Boolean enablePartitionMerge)
      Set the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.
      Parameters:
      enablePartitionMerge - the enablePartitionMerge value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • minimalTlsVersion

      public MinimalTlsVersion minimalTlsVersion()
      Get the minimalTlsVersion property: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
      Returns:
      the minimalTlsVersion value.

    • withMinimalTlsVersion

      public DatabaseAccountGetProperties withMinimalTlsVersion(MinimalTlsVersion minimalTlsVersion)
      Set the minimalTlsVersion property: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
      Parameters:
      minimalTlsVersion - the minimalTlsVersion value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • enableBurstCapacity

      public Boolean enableBurstCapacity()
      Get the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.
      Returns:
      the enableBurstCapacity value.

    • withEnableBurstCapacity

      public DatabaseAccountGetProperties withEnableBurstCapacity(Boolean enableBurstCapacity)
      Set the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.
      Parameters:
      enableBurstCapacity - the enableBurstCapacity value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • customerManagedKeyStatus

      public String customerManagedKeyStatus()
      Get the customerManagedKeyStatus property: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
      Returns:
      the customerManagedKeyStatus value.

    • withCustomerManagedKeyStatus

      public DatabaseAccountGetProperties withCustomerManagedKeyStatus(String customerManagedKeyStatus)
      Set the customerManagedKeyStatus property: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
      Parameters:
      customerManagedKeyStatus - the customerManagedKeyStatus value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • enablePerRegionPerPartitionAutoscale

      public Boolean enablePerRegionPerPartitionAutoscale()
      Get the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.
      Returns:
      the enablePerRegionPerPartitionAutoscale value.

    • withEnablePerRegionPerPartitionAutoscale

      public DatabaseAccountGetProperties withEnablePerRegionPerPartitionAutoscale(Boolean enablePerRegionPerPartitionAutoscale)
      Set the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.
      Parameters:
      enablePerRegionPerPartitionAutoscale - the enablePerRegionPerPartitionAutoscale value to set.
      Returns:
      the DatabaseAccountGetProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DatabaseAccountGetProperties>
      Throws:
      IOException

    • fromJson

      public static DatabaseAccountGetProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DatabaseAccountGetProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DatabaseAccountGetProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the DatabaseAccountGetProperties.