sqladmin  v1beta4
Classes | Properties | List of all members
Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance Class Reference

A Cloud SQL instance resource. More...

Inheritance diagram for Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance:
Google::Apis::Requests::IDirectResponseSchema

Classes

class  FailoverReplicaData
 The name and status of the failover replica. This property is applicable only to Second Generation instances. More...
 

Properties

virtual string BackendType [get, set]
 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. More...
 
virtual string ConnectionName [get, set]
 Connection name of the Cloud SQL instance used in connection strings. More...
 
virtual System.Nullable< long > CurrentDiskSize [get, set]
 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. More...
 
virtual string DatabaseVersion [get, set]
 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 More...
 
virtual DiskEncryptionConfiguration DiskEncryptionConfiguration [get, set]
 Disk encryption configuration specific to an instance. Applies only to Second Generation instances. More...
 
virtual DiskEncryptionStatus DiskEncryptionStatus [get, set]
 Disk encryption status specific to an instance. Applies only to Second Generation instances. More...
 
virtual string ETag [get, set]
 This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead. More...
 
virtual DatabaseInstance.FailoverReplicaData FailoverReplica [get, set]
 The name and status of the failover replica. This property is applicable only to Second Generation instances. More...
 
virtual string GceZone [get, set]
 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. More...
 
virtual string InstanceType [get, set]
 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. More...
 
virtual System.Collections.Generic.IList< IpMappingIpAddresses [get, set]
 The assigned IP addresses for the instance. More...
 
virtual string Ipv6Address [get, set]
 The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. More...
 
virtual string Kind [get, set]
 This is always sql::instance. More...
 
virtual string MasterInstanceName [get, set]
 The name of the instance which will act as master in the replication setup. More...
 
virtual System.Nullable< long > MaxDiskSize [get, set]
 The maximum disk size of the instance in bytes. More...
 
virtual string Name [get, set]
 Name of the Cloud SQL instance. This does not include the project ID. More...
 
virtual OnPremisesConfiguration OnPremisesConfiguration [get, set]
 Configuration specific to on-premises instances. More...
 
virtual string Project [get, set]
 The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. More...
 
virtual string Region [get, set]
 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. More...
 
virtual ReplicaConfiguration ReplicaConfiguration [get, set]
 Configuration specific to failover replicas and read replicas. More...
 
virtual System.Collections.Generic.IList< string > ReplicaNames [get, set]
 The replicas of the instance. More...
 
virtual string RootPassword [get, set]
 Initial root password. Use only on creation. More...
 
virtual string SelfLink [get, set]
 The URI of this resource. More...
 
virtual SslCert ServerCaCert [get, set]
 SSL configuration. More...
 
virtual string ServiceAccountEmailAddress [get, set]
 The service account email address assigned to the instance. This property is applicable only to Second Generation instances. More...
 
virtual Settings Settings [get, set]
 The user settings. More...
 
virtual string State [get, set]
 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. More...
 
virtual System.Collections.Generic.IList< string > SuspensionReason [get, set]
 If the instance state is SUSPENDED, the reason for the suspension. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

A Cloud SQL instance resource.

Property Documentation

◆ BackendType

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.BackendType
getset

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.

◆ ConnectionName

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.ConnectionName
getset

Connection name of the Cloud SQL instance used in connection strings.

◆ CurrentDiskSize

virtual System.Nullable<long> Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.CurrentDiskSize
getset

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.

◆ DatabaseVersion

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.DatabaseVersion
getset

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

◆ DiskEncryptionConfiguration

virtual DiskEncryptionConfiguration Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.DiskEncryptionConfiguration
getset

Disk encryption configuration specific to an instance. Applies only to Second Generation instances.

◆ DiskEncryptionStatus

virtual DiskEncryptionStatus Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.DiskEncryptionStatus
getset

Disk encryption status specific to an instance. Applies only to Second Generation instances.

◆ ETag

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.ETag
getset

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.

◆ FailoverReplica

virtual DatabaseInstance.FailoverReplicaData Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.FailoverReplica
getset

The name and status of the failover replica. This property is applicable only to Second Generation instances.

◆ GceZone

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.GceZone
getset

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.

◆ InstanceType

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.InstanceType
getset

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.

◆ IpAddresses

virtual System.Collections.Generic.IList<IpMapping> Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.IpAddresses
getset

The assigned IP addresses for the instance.

◆ Ipv6Address

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.Ipv6Address
getset

The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.

◆ Kind

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.Kind
getset

This is always sql::instance.

◆ MasterInstanceName

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.MasterInstanceName
getset

The name of the instance which will act as master in the replication setup.

◆ MaxDiskSize

virtual System.Nullable<long> Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.MaxDiskSize
getset

The maximum disk size of the instance in bytes.

◆ Name

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.Name
getset

Name of the Cloud SQL instance. This does not include the project ID.

◆ OnPremisesConfiguration

virtual OnPremisesConfiguration Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.OnPremisesConfiguration
getset

Configuration specific to on-premises instances.

◆ Project

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.Project
getset

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

◆ Region

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.Region
getset

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.

◆ ReplicaConfiguration

virtual ReplicaConfiguration Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.ReplicaConfiguration
getset

Configuration specific to failover replicas and read replicas.

◆ ReplicaNames

virtual System.Collections.Generic.IList<string> Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.ReplicaNames
getset

The replicas of the instance.

◆ RootPassword

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.RootPassword
getset

Initial root password. Use only on creation.

◆ SelfLink

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.SelfLink
getset

The URI of this resource.

◆ ServerCaCert

virtual SslCert Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.ServerCaCert
getset

SSL configuration.

◆ ServiceAccountEmailAddress

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.ServiceAccountEmailAddress
getset

The service account email address assigned to the instance. This property is applicable only to Second Generation instances.

◆ Settings

virtual Settings Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.Settings
getset

The user settings.

◆ State

virtual string Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.State
getset

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.

◆ SuspensionReason

virtual System.Collections.Generic.IList<string> Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance.SuspensionReason
getset

If the instance state is SUSPENDED, the reason for the suspension.


The documentation for this class was generated from the following file: