Class DatabaseInstance

A Cloud SQL instance resource.

Inheritance

object

DatabaseInstance

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.SQLAdmin.v1.Data

Assembly: Google.Apis.SQLAdmin.v1.dll

Syntax

public class DatabaseInstance : IDirectResponseSchema

Properties

AvailableMaintenanceVersions

Output only. List all maintenance versions applicable on the instance

Declaration

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

Property Value

Type	Description
IList<string>

BackendType

The backend type. 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
string

ClearNetwork

Clears private network settings when the instance is restored.

Declaration

[JsonProperty("clearNetwork")]
public virtual bool? ClearNetwork { get; set; }

Property Value

Type	Description
bool?

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
string

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
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
long?

DatabaseInstalledVersion

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

Declaration

[JsonProperty("databaseInstalledVersion")]
public virtual string DatabaseInstalledVersion { get; set; }

Property Value

Type	Description
string

DatabaseVersion

The database engine type and version. The databaseVersion field cannot be changed after instance creation.

Declaration

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

Property Value

Type	Description
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

DnsName

Output only. The dns name of the instance.

Declaration

[JsonProperty("dnsName")]
public virtual string DnsName { get; set; }

Property Value

Type	Description
string

DnsNames

Output only. The list of DNS names used by this instance.

Declaration

[JsonProperty("dnsNames")]
public virtual IList<DnsNameMapping> DnsNames { get; set; }

Property Value

Type	Description
IList<DnsNameMapping>

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
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. WARNING: Changing this might restart the instance.

Declaration

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

Property Value

Type	Description
string

GeminiConfig

Gemini instance configuration.

Declaration

[JsonProperty("geminiConfig")]
public virtual GeminiInstanceConfig GeminiConfig { get; set; }

Property Value

Type	Description
GeminiInstanceConfig

IncludeReplicasForMajorVersionUpgrade

Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.

Declaration

[JsonProperty("includeReplicasForMajorVersionUpgrade")]
public virtual bool? IncludeReplicasForMajorVersionUpgrade { get; set; }

Property Value

Type	Description
bool?

InstanceType

The instance type.

Declaration

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

Property Value

Type	Description
string

IpAddresses

The assigned IP addresses for the instance.

Declaration

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

Property Value

Type	Description
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
string

Kind

This is always sql#instance.

Declaration

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

Property Value

Type	Description
string

MaintenanceVersion

The current software version on the instance.

Declaration

[JsonProperty("maintenanceVersion")]
public virtual string MaintenanceVersion { get; set; }

Property Value

Type	Description
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
string

MaxDiskSize

The maximum disk size of the instance in bytes.

Declaration

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

Property Value

Type	Description
long?

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
string

NodeCount

The number of read pool nodes in a read pool.

Declaration

[JsonProperty("nodeCount")]
public virtual int? NodeCount { get; set; }

Property Value

Type	Description
int?

Nodes

Output only. Entries containing information about each read pool node of the read pool.

Declaration

[JsonProperty("nodes")]
public virtual IList<PoolNodeConfig> Nodes { get; set; }

Property Value

Type	Description
IList<PoolNodeConfig>

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

PrimaryDnsName

Output only. DEPRECATED: please use write_endpoint instead.

Declaration

[JsonProperty("primaryDnsName")]
public virtual string PrimaryDnsName { get; set; }

Property Value

Type	Description
string

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
string

PscServiceAttachmentLink

Output only. The link to service attachment of PSC instance.

Declaration

[JsonProperty("pscServiceAttachmentLink")]
public virtual string PscServiceAttachmentLink { get; set; }

Property Value

Type	Description
string

Region

The geographical region of the Cloud SQL instance. It can be one of the regions where Cloud SQL operates: For example, asia-east1, europe-west1, and us-central1. The default value is us-central1.

Declaration

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

Property Value

Type	Description
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
IList<string>

ReplicationCluster

Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.

Declaration

[JsonProperty("replicationCluster")]
public virtual ReplicationCluster ReplicationCluster { get; set; }

Property Value

Type	Description
ReplicationCluster

RootPassword

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

Declaration

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

Property Value

Type	Description
string

SatisfiesPzi

Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.

Declaration

[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

This status indicates whether the instance satisfies PZS. The status is reserved for future use.

Declaration

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

Property Value

Type	Description
bool?

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.

Declaration

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

Property Value

Type	Description
string

SelfLink

The URI of this resource.

Declaration

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

Property Value

Type	Description
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
string

Settings

The user settings.

Declaration

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

Property Value

Type	Description
Settings

SqlNetworkArchitecture

Declaration

[JsonProperty("sqlNetworkArchitecture")]
public virtual string SqlNetworkArchitecture { get; set; }

Property Value

Type	Description
string

State

The current serving state of the Cloud SQL instance.

Declaration

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

Property Value

Type	Description
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
IList<string>

SwitchTransactionLogsToCloudStorageEnabled

Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.

Declaration

[JsonProperty("switchTransactionLogsToCloudStorageEnabled")]
public virtual bool? SwitchTransactionLogsToCloudStorageEnabled { get; set; }

Property Value

Type	Description
bool?

Tags

Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "" : "". For example, a single resource can have the following tags:

"123/environment": "production", "123/costCenter": "marketing",

For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.

Declaration

[JsonProperty("tags")]
public virtual IDictionary<string, string> Tags { get; set; }

Property Value

Type	Description
IDictionary<string, string>

UpgradableDatabaseVersions

Output only. All database versions that are available for upgrade.

Declaration

[JsonProperty("upgradableDatabaseVersions")]
public virtual IList<AvailableDatabaseVersion> UpgradableDatabaseVersions { get; set; }

Property Value

Type	Description
IList<AvailableDatabaseVersion>

WriteEndpoint

Output only. The dns name of the primary instance in a replication group.

Declaration

[JsonProperty("writeEndpoint")]
public virtual string WriteEndpoint { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema