DatabaseInstance (Cloud SQL Admin API v1beta4-rev20191005-1.30.3)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sql.model.DatabaseInstance

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class DatabaseInstance
extends GenericJson
```
A Cloud SQL instance resource. If you change this, also change SqlDatabaseInstance
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud SQL Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DatabaseInstance.FailoverReplica
The name and status of the failover replica.
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`DatabaseInstance.FailoverReplica` The name and status of the failover replica.

Constructor Summary

Constructors
Constructor and Description

DatabaseInstance()

Constructors
Constructor and Description
`DatabaseInstance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DatabaseInstance`	`clone()`
`String`	`getBackendType()` FIRST_GEN: First Generation instance.
`String`	`getConnectionName()` Connection name of the Cloud SQL instance used in connection strings.
`Long`	`getCurrentDiskSize()` The current disk usage of the instance in bytes.
`String`	`getDatabaseVersion()` The database engine type and version.
`DiskEncryptionConfiguration`	`getDiskEncryptionConfiguration()` Disk encryption configuration specific to an instance.
`DiskEncryptionStatus`	`getDiskEncryptionStatus()` Disk encryption status specific to an instance.
`String`	`getEtag()` This field is deprecated and will be removed from a future version of the API.
`DatabaseInstance.FailoverReplica`	`getFailoverReplica()` The name and status of the failover replica.
`String`	`getGceZone()` The Compute Engine zone that the instance is currently serving from.
`String`	`getInstanceType()` The instance type.
`List<IpMapping>`	`getIpAddresses()` The assigned IP addresses for the instance.
`String`	`getIpv6Address()` The IPv6 address assigned to the instance.
`String`	`getKind()` This is always sql#instance.
`String`	`getMasterInstanceName()` The name of the instance which will act as master in the replication setup.
`Long`	`getMaxDiskSize()` The maximum disk size of the instance in bytes.
`String`	`getName()` Name of the Cloud SQL instance.
`OnPremisesConfiguration`	`getOnPremisesConfiguration()` Configuration specific to on-premises instances.
`String`	`getProject()` The project ID of the project containing the Cloud SQL instance.
`String`	`getRegion()` The geographical region.
`ReplicaConfiguration`	`getReplicaConfiguration()` Configuration specific to failover replicas and read replicas.
`List<String>`	`getReplicaNames()` The replicas of the instance.
`String`	`getRootPassword()` Initial root password.
`String`	`getSelfLink()` The URI of this resource.
`SslCert`	`getServerCaCert()` SSL configuration.
`String`	`getServiceAccountEmailAddress()` The service account email address assigned to the instance.
`Settings`	`getSettings()` The user settings.
`String`	`getState()` The current serving state of the Cloud SQL instance.
`List<String>`	`getSuspensionReason()` If the instance state is SUSPENDED, the reason for the suspension.
`DatabaseInstance`	`set(String fieldName, Object value)`
`DatabaseInstance`	`setBackendType(String backendType)` FIRST_GEN: First Generation instance.
`DatabaseInstance`	`setConnectionName(String connectionName)` Connection name of the Cloud SQL instance used in connection strings.
`DatabaseInstance`	`setCurrentDiskSize(Long currentDiskSize)` The current disk usage of the instance in bytes.
`DatabaseInstance`	`setDatabaseVersion(String databaseVersion)` The database engine type and version.
`DatabaseInstance`	`setDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration)` Disk encryption configuration specific to an instance.
`DatabaseInstance`	`setDiskEncryptionStatus(DiskEncryptionStatus diskEncryptionStatus)` Disk encryption status specific to an instance.
`DatabaseInstance`	`setEtag(String etag)` This field is deprecated and will be removed from a future version of the API.
`DatabaseInstance`	`setFailoverReplica(DatabaseInstance.FailoverReplica failoverReplica)` The name and status of the failover replica.
`DatabaseInstance`	`setGceZone(String gceZone)` The Compute Engine zone that the instance is currently serving from.
`DatabaseInstance`	`setInstanceType(String instanceType)` The instance type.
`DatabaseInstance`	`setIpAddresses(List<IpMapping> ipAddresses)` The assigned IP addresses for the instance.
`DatabaseInstance`	`setIpv6Address(String ipv6Address)` The IPv6 address assigned to the instance.
`DatabaseInstance`	`setKind(String kind)` This is always sql#instance.
`DatabaseInstance`	`setMasterInstanceName(String masterInstanceName)` The name of the instance which will act as master in the replication setup.
`DatabaseInstance`	`setMaxDiskSize(Long maxDiskSize)` The maximum disk size of the instance in bytes.
`DatabaseInstance`	`setName(String name)` Name of the Cloud SQL instance.
`DatabaseInstance`	`setOnPremisesConfiguration(OnPremisesConfiguration onPremisesConfiguration)` Configuration specific to on-premises instances.
`DatabaseInstance`	`setProject(String project)` The project ID of the project containing the Cloud SQL instance.
`DatabaseInstance`	`setRegion(String region)` The geographical region.
`DatabaseInstance`	`setReplicaConfiguration(ReplicaConfiguration replicaConfiguration)` Configuration specific to failover replicas and read replicas.
`DatabaseInstance`	`setReplicaNames(List<String> replicaNames)` The replicas of the instance.
`DatabaseInstance`	`setRootPassword(String rootPassword)` Initial root password.
`DatabaseInstance`	`setSelfLink(String selfLink)` The URI of this resource.
`DatabaseInstance`	`setServerCaCert(SslCert serverCaCert)` SSL configuration.
`DatabaseInstance`	`setServiceAccountEmailAddress(String serviceAccountEmailAddress)` The service account email address assigned to the instance.
`DatabaseInstance`	`setSettings(Settings settings)` The user settings.
`DatabaseInstance`	`setState(String state)` The current serving state of the Cloud SQL instance.
`DatabaseInstance`	`setSuspensionReason(List<String> suspensionReason)` If the instance state is SUSPENDED, the reason for the suspension.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - DatabaseInstance
```
public DatabaseInstance()
```
- Method Detail
  - getBackendType
```
public String getBackendType()
```
    FIRST_GEN: First Generation instance. MySQL only. SECOND_GEN: Second Generation instance or PostgreSQL instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type and Second or First Generation.
    
    Returns:
    
    value or null for none
  - setBackendType
```
public DatabaseInstance setBackendType(String backendType)
```
    FIRST_GEN: First Generation instance. MySQL only. SECOND_GEN: Second Generation instance or PostgreSQL instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type and Second or First Generation.
    
    Parameters:
    
    backendType - backendType or null for none
  - getConnectionName
```
public String getConnectionName()
```
    Connection name of the Cloud SQL instance used in connection strings.
    
    Returns:
    
    value or null for none
  - setConnectionName
```
public DatabaseInstance setConnectionName(String connectionName)
```
    Connection name of the Cloud SQL instance used in connection strings.
    
    Parameters:
    
    connectionName - connectionName or null for none
  - getCurrentDiskSize
```
public Long getCurrentDiskSize()
```
    The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.
    
    Returns:
    
    value or null for none
  - setCurrentDiskSize
```
public DatabaseInstance setCurrentDiskSize(Long currentDiskSize)
```
    The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.
    
    Parameters:
    
    currentDiskSize - currentDiskSize or null for none
  - getDatabaseVersion
```
public String getDatabaseVersion()
```
    The database engine type and version. The databaseVersion field can not be changed after instance creation. MySQL Second Generation instances: MYSQL_5_7 (default) or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6 (default) or POSTGRES_11 Beta MySQL First Generation instances: MYSQL_5_6 (default) or MYSQL_5_5
    
    Returns:
    
    value or null for none
  - setDatabaseVersion
```
public DatabaseInstance setDatabaseVersion(String databaseVersion)
```
    The database engine type and version. The databaseVersion field can not be changed after instance creation. MySQL Second Generation instances: MYSQL_5_7 (default) or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6 (default) or POSTGRES_11 Beta MySQL First Generation instances: MYSQL_5_6 (default) or MYSQL_5_5
    
    Parameters:
    
    databaseVersion - databaseVersion or null for none
  - getDiskEncryptionConfiguration
```
public DiskEncryptionConfiguration getDiskEncryptionConfiguration()
```
    Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
    
    Returns:
    
    value or null for none
  - setDiskEncryptionConfiguration
```
public DatabaseInstance setDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration)
```
    Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
    
    Parameters:
    
    diskEncryptionConfiguration - diskEncryptionConfiguration or null for none
  - getDiskEncryptionStatus
```
public DiskEncryptionStatus getDiskEncryptionStatus()
```
    Disk encryption status specific to an instance. Applies only to Second Generation instances.
    
    Returns:
    
    value or null for none
  - setDiskEncryptionStatus
```
public DatabaseInstance setDiskEncryptionStatus(DiskEncryptionStatus diskEncryptionStatus)
```
    Disk encryption status specific to an instance. Applies only to Second Generation instances.
    
    Parameters:
    
    diskEncryptionStatus - diskEncryptionStatus or null for none
  - getEtag
```
public String getEtag()
```
    This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.
    
    Returns:
    
    value or null for none
  - setEtag
```
public DatabaseInstance setEtag(String etag)
```
    This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.
    
    Parameters:
    
    etag - etag or null for none
  - getFailoverReplica
```
public DatabaseInstance.FailoverReplica getFailoverReplica()
```
    The name and status of the failover replica. This property is applicable only to Second Generation instances.
    
    Returns:
    
    value or null for none
  - setFailoverReplica
```
public DatabaseInstance setFailoverReplica(DatabaseInstance.FailoverReplica failoverReplica)
```
    The name and status of the failover replica. This property is applicable only to Second Generation instances.
    
    Parameters:
    
    failoverReplica - failoverReplica or null for none
  - getGceZone
```
public String getGceZone()
```
    The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
    
    Returns:
    
    value or null for none
  - setGceZone
```
public DatabaseInstance setGceZone(String gceZone)
```
    The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
    
    Parameters:
    
    gceZone - gceZone or null for none
  - getInstanceType
```
public String getInstanceType()
```
    The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. ON_PREMISES_INSTANCE: An instance running on the customer's premises. READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
    
    Returns:
    
    value or null for none
  - setInstanceType
```
public DatabaseInstance setInstanceType(String instanceType)
```
    The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. ON_PREMISES_INSTANCE: An instance running on the customer's premises. READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
    
    Parameters:
    
    instanceType - instanceType or null for none
  - getIpAddresses
```
public List<IpMapping> getIpAddresses()
```
    The assigned IP addresses for the instance.
    
    Returns:
    
    value or null for none
  - setIpAddresses
```
public DatabaseInstance setIpAddresses(List<IpMapping> ipAddresses)
```
    The assigned IP addresses for the instance.
    
    Parameters:
    
    ipAddresses - ipAddresses or null for none
  - getIpv6Address
```
public String getIpv6Address()
```
    The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
    
    Returns:
    
    value or null for none
  - setIpv6Address
```
public DatabaseInstance setIpv6Address(String ipv6Address)
```
    The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
    
    Parameters:
    
    ipv6Address - ipv6Address or null for none
  - getKind
```
public String getKind()
```
    This is always sql#instance.
    
    Returns:
    
    value or null for none
  - setKind
```
public DatabaseInstance setKind(String kind)
```
    This is always sql#instance.
    
    Parameters:
    
    kind - kind or null for none
  - getMasterInstanceName
```
public String getMasterInstanceName()
```
    The name of the instance which will act as master in the replication setup.
    
    Returns:
    
    value or null for none
  - setMasterInstanceName
```
public DatabaseInstance setMasterInstanceName(String masterInstanceName)
```
    The name of the instance which will act as master in the replication setup.
    
    Parameters:
    
    masterInstanceName - masterInstanceName or null for none
  - getMaxDiskSize
```
public Long getMaxDiskSize()
```
    The maximum disk size of the instance in bytes.
    
    Returns:
    
    value or null for none
  - setMaxDiskSize
```
public DatabaseInstance setMaxDiskSize(Long maxDiskSize)
```
    The maximum disk size of the instance in bytes.
    
    Parameters:
    
    maxDiskSize - maxDiskSize or null for none
  - getName
```
public String getName()
```
    Name of the Cloud SQL instance. This does not include the project ID.
    
    Returns:
    
    value or null for none
  - setName
```
public DatabaseInstance setName(String name)
```
    Name of the Cloud SQL instance. This does not include the project ID.
    
    Parameters:
    
    name - name or null for none
  - getOnPremisesConfiguration
```
public OnPremisesConfiguration getOnPremisesConfiguration()
```
    Configuration specific to on-premises instances.
    
    Returns:
    
    value or null for none
  - setOnPremisesConfiguration
```
public DatabaseInstance setOnPremisesConfiguration(OnPremisesConfiguration onPremisesConfiguration)
```
    Configuration specific to on-premises instances.
    
    Parameters:
    
    onPremisesConfiguration - onPremisesConfiguration or null for none
  - getProject
```
public String getProject()
```
    The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
    
    Returns:
    
    value or null for none
  - setProject
```
public DatabaseInstance setProject(String project)
```
    The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
    
    Parameters:
    
    project - project or null for none
  - getRegion
```
public String getRegion()
```
    The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.
    
    Returns:
    
    value or null for none
  - setRegion
```
public DatabaseInstance setRegion(String region)
```
    The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.
    
    Parameters:
    
    region - region or null for none
  - getReplicaConfiguration
```
public ReplicaConfiguration getReplicaConfiguration()
```
    Configuration specific to failover replicas and read replicas.
    
    Returns:
    
    value or null for none
  - setReplicaConfiguration
```
public DatabaseInstance setReplicaConfiguration(ReplicaConfiguration replicaConfiguration)
```
    Configuration specific to failover replicas and read replicas.
    
    Parameters:
    
    replicaConfiguration - replicaConfiguration or null for none
  - getReplicaNames
```
public List<String> getReplicaNames()
```
    The replicas of the instance.
    
    Returns:
    
    value or null for none
  - setReplicaNames
```
public DatabaseInstance setReplicaNames(List<String> replicaNames)
```
    The replicas of the instance.
    
    Parameters:
    
    replicaNames - replicaNames or null for none
  - getRootPassword
```
public String getRootPassword()
```
    Initial root password. Use only on creation.
    
    Returns:
    
    value or null for none
  - setRootPassword
```
public DatabaseInstance setRootPassword(String rootPassword)
```
    Initial root password. Use only on creation.
    
    Parameters:
    
    rootPassword - rootPassword or null for none
  - getSelfLink
```
public String getSelfLink()
```
    The URI of this resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public DatabaseInstance setSelfLink(String selfLink)
```
    The URI of this resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getServerCaCert
```
public SslCert getServerCaCert()
```
    SSL configuration.
    
    Returns:
    
    value or null for none
  - setServerCaCert
```
public DatabaseInstance setServerCaCert(SslCert serverCaCert)
```
    SSL configuration.
    
    Parameters:
    
    serverCaCert - serverCaCert or null for none
  - getServiceAccountEmailAddress
```
public String getServiceAccountEmailAddress()
```
    The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
    
    Returns:
    
    value or null for none
  - setServiceAccountEmailAddress
```
public DatabaseInstance setServiceAccountEmailAddress(String serviceAccountEmailAddress)
```
    The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
    
    Parameters:
    
    serviceAccountEmailAddress - serviceAccountEmailAddress or null for none
  - getSettings
```
public Settings getSettings()
```
    The user settings.
    
    Returns:
    
    value or null for none
  - setSettings
```
public DatabaseInstance setSettings(Settings settings)
```
    The user settings.
    
    Parameters:
    
    settings - settings or null for none
  - getState
```
public String getState()
```
    The current serving state of the Cloud SQL instance. This can be one of the following. RUNNABLE: The instance is running, or is ready to run when accessed. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. FAILED: The instance creation failed. UNKNOWN_STATE: The state of the instance is unknown.
    
    Returns:
    
    value or null for none
  - setState
```
public DatabaseInstance setState(String state)
```
    The current serving state of the Cloud SQL instance. This can be one of the following. RUNNABLE: The instance is running, or is ready to run when accessed. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. FAILED: The instance creation failed. UNKNOWN_STATE: The state of the instance is unknown.
    
    Parameters:
    
    state - state or null for none
  - getSuspensionReason
```
public List<String> getSuspensionReason()
```
    If the instance state is SUSPENDED, the reason for the suspension.
    
    Returns:
    
    value or null for none
  - setSuspensionReason
```
public DatabaseInstance setSuspensionReason(List<String> suspensionReason)
```
    If the instance state is SUSPENDED, the reason for the suspension.
    
    Parameters:
    
    suspensionReason - suspensionReason or null for none
  - set
```
public DatabaseInstance set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public DatabaseInstance clone()
```
    Overrides:
    
    clone in class GenericJson

Class DatabaseInstance

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

DatabaseInstance

Method Detail

getBackendType

setBackendType

getConnectionName

setConnectionName

getCurrentDiskSize

setCurrentDiskSize

getDatabaseVersion

setDatabaseVersion

getDiskEncryptionConfiguration

setDiskEncryptionConfiguration

getDiskEncryptionStatus

setDiskEncryptionStatus

getEtag

setEtag

getFailoverReplica

setFailoverReplica

getGceZone

setGceZone

getInstanceType

setInstanceType

getIpAddresses

setIpAddresses

getIpv6Address

setIpv6Address

getKind

setKind

getMasterInstanceName

setMasterInstanceName

getMaxDiskSize

setMaxDiskSize

getName

setName

getOnPremisesConfiguration

setOnPremisesConfiguration

getProject

setProject

getRegion

setRegion

getReplicaConfiguration

setReplicaConfiguration

getReplicaNames

setReplicaNames

getRootPassword

setRootPassword

getSelfLink

setSelfLink

getServerCaCert

setServerCaCert

getServiceAccountEmailAddress

setServiceAccountEmailAddress

getSettings

setSettings

getState

setState

getSuspensionReason

setSuspensionReason

set

clone