Class DatabaseInstance

A Cloud SQL instance resource.

Inheritance

System.Object

DatabaseInstance

Implements

IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.SQLAdmin.v1beta4.Data

Assembly: Google.Apis.SQLAdmin.v1beta4.dll

Syntax

public class DatabaseInstance : IDirectResponseSchema

Properties

BackendType

SECOND_GEN: Cloud SQL database 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.

Declaration

[JsonProperty("backendType")]
public virtual string BackendType { get; set; }

Property Value

Type	Description
System.String

ConnectionName

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

Declaration

[JsonProperty("connectionName")]
public virtual string ConnectionName { get; set; }

Property Value

Type	Description
System.String

CurrentDiskSize

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

Declaration

[JsonProperty("currentDiskSize")]
public virtual long? CurrentDiskSize { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

DatabaseVersion

The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13 (default). SQL Server instances: SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB, SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB.

Declaration

[JsonProperty("databaseVersion")]
public virtual string DatabaseVersion { get; set; }

Property Value

Type	Description
System.String

DiskEncryptionConfiguration

Disk encryption configuration specific to an instance.

Declaration

[JsonProperty("diskEncryptionConfiguration")]
public virtual DiskEncryptionConfiguration DiskEncryptionConfiguration { get; set; }

Property Value

Type	Description
DiskEncryptionConfiguration

DiskEncryptionStatus

Disk encryption status specific to an instance.

Declaration

[JsonProperty("diskEncryptionStatus")]
public virtual DiskEncryptionStatus DiskEncryptionStatus { get; set; }

Property Value

Type	Description
DiskEncryptionStatus

ETag

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

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

FailoverReplica

The name and status of the failover replica.

Declaration

[JsonProperty("failoverReplica")]
public virtual DatabaseInstance.FailoverReplicaData FailoverReplica { get; set; }

Property Value

Type	Description
DatabaseInstance.FailoverReplicaData

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.

Declaration

[JsonProperty("gceZone")]
public virtual string GceZone { get; set; }

Property Value

Type	Description
System.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 primary instance. ON_PREMISES_INSTANCE: An instance running on the customer's premises. READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.

Declaration

[JsonProperty("instanceType")]
public virtual string InstanceType { get; set; }

Property Value

Type	Description
System.String

IpAddresses

The assigned IP addresses for the instance.

Declaration

[JsonProperty("ipAddresses")]
public virtual IList<IpMapping> IpAddresses { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<IpMapping>

Ipv6Address

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

Declaration

[JsonProperty("ipv6Address")]
public virtual string Ipv6Address { get; set; }

Property Value

Type	Description
System.String

Kind

This is always sql#instance.

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
System.String

MasterInstanceName

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

Declaration

[JsonProperty("masterInstanceName")]
public virtual string MasterInstanceName { get; set; }

Property Value

Type	Description
System.String

MaxDiskSize

The maximum disk size of the instance in bytes.

Declaration

[JsonProperty("maxDiskSize")]
public virtual long? MaxDiskSize { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

Name

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

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
System.String

OnPremisesConfiguration

Configuration specific to on-premises instances.

Declaration

[JsonProperty("onPremisesConfiguration")]
public virtual OnPremisesConfiguration OnPremisesConfiguration { get; set; }

Property Value

Type	Description
OnPremisesConfiguration

OutOfDiskReport

This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the proactive database wellness job

Declaration

[JsonProperty("outOfDiskReport")]
public virtual SqlOutOfDiskReport OutOfDiskReport { get; set; }

Property Value

Type	Description
SqlOutOfDiskReport

Project

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

Declaration

[JsonProperty("project")]
public virtual string Project { get; set; }

Property Value

Type	Description
System.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. The region cannot be changed after instance creation.

Declaration

[JsonProperty("region")]
public virtual string Region { get; set; }

Property Value

Type	Description
System.String

ReplicaConfiguration

Configuration specific to failover replicas and read replicas.

Declaration

[JsonProperty("replicaConfiguration")]
public virtual ReplicaConfiguration ReplicaConfiguration { get; set; }

Property Value

Type	Description
ReplicaConfiguration

ReplicaNames

The replicas of the instance.

Declaration

[JsonProperty("replicaNames")]
public virtual IList<string> ReplicaNames { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

RootPassword

Initial root password. Use only on creation.

Declaration

[JsonProperty("rootPassword")]
public virtual string RootPassword { get; set; }

Property Value

Type	Description
System.String

SatisfiesPzs

The status indicating if instance satisfiesPzs. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ScheduledMaintenance

The start time of any upcoming scheduled maintenance for this instance.

Declaration

[JsonProperty("scheduledMaintenance")]
public virtual SqlScheduledMaintenance ScheduledMaintenance { get; set; }

Property Value

Type	Description
SqlScheduledMaintenance

SecondaryGceZone

The Compute Engine zone that the failover instance is currently serving from for a regional instance. 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/failover zone. Reserved for future use.

Declaration

[JsonProperty("secondaryGceZone")]
public virtual string SecondaryGceZone { get; set; }

Property Value

Type	Description
System.String

SelfLink

The URI of this resource.

Declaration

[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }

Property Value

Type	Description
System.String

ServerCaCert

SSL configuration.

Declaration

[JsonProperty("serverCaCert")]
public virtual SslCert ServerCaCert { get; set; }

Property Value

Type	Description
SslCert

ServiceAccountEmailAddress

The service account email address assigned to the instance. This property is read-only.

Declaration

[JsonProperty("serviceAccountEmailAddress")]
public virtual string ServiceAccountEmailAddress { get; set; }

Property Value

Type	Description
System.String

Settings

The user settings.

Declaration

[JsonProperty("settings")]
public virtual Settings Settings { get; set; }

Property Value

Type	Description
Settings

State

The current serving state of the Cloud SQL instance. This can be one of the following. SQL_INSTANCE_STATE_UNSPECIFIED: The state of the instance is unknown. RUNNABLE: The instance is running, or has been stopped by owner. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_DELETE: The instance is being deleted. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. FAILED: The instance creation failed.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
System.String

SuspensionReason

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

Declaration

[JsonProperty("suspensionReason")]
public virtual IList<string> SuspensionReason { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Implements

IDirectResponseSchema