Class: Google::Cloud::Sql::V1beta4::DatabaseInstance

Inherits:

Object

Object
Google::Cloud::Sql::V1beta4::DatabaseInstance

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb

Overview

A Cloud SQL instance resource.

Defined Under Namespace

Modules: SqlInstanceState, SqlNetworkArchitecture Classes: PoolNodeConfig, SqlFailoverReplica, SqlOutOfDiskReport, SqlScheduledMaintenance, TagsEntry

Instance Attribute Summary collapse

#available_maintenance_versions ⇒ ::Array<::String> readonly
Output only.
#backend_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlBackendType
The backend type.
#connection_name ⇒ ::String
Connection name of the Cloud SQL instance used in connection strings.
#create_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#current_disk_size ⇒ ::Google::Protobuf::Int64Value deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#database_center_integration_enabled ⇒ ::Google::Protobuf::BoolValue
Optional.
#database_installed_version ⇒ ::String readonly
Output only.
#database_version ⇒ ::Google::Cloud::Sql::V1beta4::SqlDatabaseVersion
The database engine type and version.
#disk_encryption_configuration ⇒ ::Google::Cloud::Sql::V1beta4::DiskEncryptionConfiguration
Disk encryption configuration specific to an instance.
#disk_encryption_status ⇒ ::Google::Cloud::Sql::V1beta4::DiskEncryptionStatus
Disk encryption status specific to an instance.
#dns_name ⇒ ::String readonly
Output only.
#dns_names ⇒ ::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping> readonly
Output only.
#etag ⇒ ::String
This field is deprecated and will be removed from a future version of the API.
#failover_replica ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlFailoverReplica
The name and status of the failover replica.
#gce_zone ⇒ ::String
The Compute Engine zone that the instance is currently serving from.
#gemini_config ⇒ ::Google::Cloud::Sql::V1beta4::GeminiInstanceConfig
Gemini instance configuration.
#include_replicas_for_major_version_upgrade ⇒ ::Google::Protobuf::BoolValue
Input only.
#instance_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlInstanceType
The instance type.
#ip_addresses ⇒ ::Array<::Google::Cloud::Sql::V1beta4::IpMapping>
The assigned IP addresses for the instance.
#ipv6_address ⇒ ::String deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#kind ⇒ ::String
This is always sql#instance.
#maintenance_version ⇒ ::String
The current software version on the instance.
#master_instance_name ⇒ ::String
The name of the instance which will act as primary in the replication setup.
#max_disk_size ⇒ ::Google::Protobuf::Int64Value deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#name ⇒ ::String
Name of the Cloud SQL instance.
#node_count ⇒ ::Integer
The number of read pool nodes in a read pool.
#nodes ⇒ ::Array<::Google::Cloud::Sql::V1beta4::DatabaseInstance::PoolNodeConfig> readonly
Output only.
#on_premises_configuration ⇒ ::Google::Cloud::Sql::V1beta4::OnPremisesConfiguration
Configuration specific to on-premises instances.
#out_of_disk_report ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport
This field represents the report generated by the proactive database wellness job for OutOfDisk issues.
#primary_dns_name ⇒ ::String readonly deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#project ⇒ ::String
The project ID of the project containing the Cloud SQL instance.
#psc_service_attachment_link ⇒ ::String readonly
Output only.
#region ⇒ ::String
The geographical region of the Cloud SQL instance.
#replica_configuration ⇒ ::Google::Cloud::Sql::V1beta4::ReplicaConfiguration
Configuration specific to failover replicas and read replicas.
#replica_names ⇒ ::Array<::String>
The replicas of the instance.
#replication_cluster ⇒ ::Google::Cloud::Sql::V1beta4::ReplicationCluster
A primary instance and disaster recovery (DR) replica pair.
#root_password ⇒ ::String
Initial root password.
#satisfies_pzi ⇒ ::Google::Protobuf::BoolValue readonly
Output only.
#satisfies_pzs ⇒ ::Google::Protobuf::BoolValue
This status indicates whether the instance satisfies PZS.
#scheduled_maintenance ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlScheduledMaintenance
The start time of any upcoming scheduled maintenance for this instance.
#secondary_gce_zone ⇒ ::String
The Compute Engine zone that the failover instance is currently serving from for a regional instance.
#self_link ⇒ ::String
The URI of this resource.
#server_ca_cert ⇒ ::Google::Cloud::Sql::V1beta4::SslCert
SSL configuration.
#service_account_email_address ⇒ ::String
The service account email address assigned to the instance.
#settings ⇒ ::Google::Cloud::Sql::V1beta4::Settings
The user settings.
#sql_network_architecture ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlNetworkArchitecture
The SQL network architecture for the instance.
#state ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState
The current serving state of the Cloud SQL instance.
#suspension_reason ⇒ ::Array<::Google::Cloud::Sql::V1beta4::SqlSuspensionReason>
If the instance state is SUSPENDED, the reason for the suspension.
#switch_transaction_logs_to_cloud_storage_enabled ⇒ ::Google::Protobuf::BoolValue
Input only.
#tags ⇒ ::Google::Protobuf::Map{::String => ::String}
Optional.
#upgradable_database_versions ⇒ ::Array<::Google::Cloud::Sql::V1beta4::AvailableDatabaseVersion> readonly
Output only.
#write_endpoint ⇒ ::String readonly
Output only.

Instance Attribute Details

#available_maintenance_versions ⇒ `::Array<::String>` (readonly)

Returns Output only. List all maintenance versions applicable on the instance.

Returns:

(::Array<::String>) —
Output only. List all maintenance versions applicable on the instance

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#backend_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlBackendType`

Returns 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.

Returns:

(::Google::Cloud::Sql::V1beta4::SqlBackendType) —
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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#connection_name ⇒ `::String`

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

Returns:

(::String) —
Connection name of the Cloud SQL instance used in connection strings.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

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

Returns:

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

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#current_disk_size ⇒ `::Google::Protobuf::Int64Value`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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.

Returns:

(::Google::Protobuf::Int64Value) —
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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#database_center_integration_enabled ⇒ `::Google::Protobuf::BoolValue`

Returns Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center.

Returns:

(::Google::Protobuf::BoolValue) —
Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#database_installed_version ⇒ `::String` (readonly)

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

Returns:

(::String) —
Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#database_version ⇒ `::Google::Cloud::Sql::V1beta4::SqlDatabaseVersion`

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

Returns:

(::Google::Cloud::Sql::V1beta4::SqlDatabaseVersion) —
The database engine type and version. The databaseVersion field cannot be changed after instance creation.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#disk_encryption_configuration ⇒ `::Google::Cloud::Sql::V1beta4::DiskEncryptionConfiguration`

Returns Disk encryption configuration specific to an instance.

Returns:

(::Google::Cloud::Sql::V1beta4::DiskEncryptionConfiguration) —
Disk encryption configuration specific to an instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#disk_encryption_status ⇒ `::Google::Cloud::Sql::V1beta4::DiskEncryptionStatus`

Returns Disk encryption status specific to an instance.

Returns:

(::Google::Cloud::Sql::V1beta4::DiskEncryptionStatus) —
Disk encryption status specific to an instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#dns_name ⇒ `::String` (readonly)

Returns Output only. The dns name of the instance.

Returns:

(::String) —
Output only. The dns name of the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#dns_names ⇒ `::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>` (readonly)

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

Returns:

(::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>) —
Output only. The list of DNS names used by this instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#etag ⇒ `::String`

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

Returns:

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

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#failover_replica ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlFailoverReplica`

Returns The name and status of the failover replica.

Returns:

(::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlFailoverReplica) —
The name and status of the failover replica.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#gce_zone ⇒ `::String`

Returns 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.

Returns:

(::String) —
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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#gemini_config ⇒ `::Google::Cloud::Sql::V1beta4::GeminiInstanceConfig`

Returns Gemini instance configuration.

Returns:

(::Google::Cloud::Sql::V1beta4::GeminiInstanceConfig) —
Gemini instance configuration.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#include_replicas_for_major_version_upgrade ⇒ `::Google::Protobuf::BoolValue`

Returns 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.

Returns:

(::Google::Protobuf::BoolValue) —
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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#instance_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlInstanceType`

Returns The instance type.

Returns:

(::Google::Cloud::Sql::V1beta4::SqlInstanceType) —
The instance type.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#ip_addresses ⇒ `::Array<::Google::Cloud::Sql::V1beta4::IpMapping>`

Returns The assigned IP addresses for the instance.

Returns:

(::Array<::Google::Cloud::Sql::V1beta4::IpMapping>) —
The assigned IP addresses for the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#ipv6_address ⇒ `::String`

Deprecated.

This field is deprecated and may be removed in the next major version update.

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

Returns:

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

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#kind ⇒ `::String`

Returns This is always sql#instance.

Returns:

(::String) —
This is always sql#instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#maintenance_version ⇒ `::String`

Returns The current software version on the instance.

Returns:

(::String) —
The current software version on the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#master_instance_name ⇒ `::String`

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

Returns:

(::String) —
The name of the instance which will act as primary in the replication setup.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#max_disk_size ⇒ `::Google::Protobuf::Int64Value`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns The maximum disk size of the instance in bytes.

Returns:

(::Google::Protobuf::Int64Value) —
The maximum disk size of the instance in bytes.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#name ⇒ `::String`

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

Returns:

(::String) —
Name of the Cloud SQL instance. This does not include the project ID.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#node_count ⇒ `::Integer`

Returns The number of read pool nodes in a read pool.

Returns:

(::Integer) —
The number of read pool nodes in a read pool.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#nodes ⇒ `::Array<::Google::Cloud::Sql::V1beta4::DatabaseInstance::PoolNodeConfig>` (readonly)

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

Returns:

(::Array<::Google::Cloud::Sql::V1beta4::DatabaseInstance::PoolNodeConfig>) —
Output only. Entries containing information about each read pool node of the read pool.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#on_premises_configuration ⇒ `::Google::Cloud::Sql::V1beta4::OnPremisesConfiguration`

Returns Configuration specific to on-premises instances.

Returns:

(::Google::Cloud::Sql::V1beta4::OnPremisesConfiguration) —
Configuration specific to on-premises instances.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#out_of_disk_report ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport`

Returns 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.

Returns:

(::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport) —
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

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#primary_dns_name ⇒ `::String` (readonly)

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Output only. DEPRECATED: please use write_endpoint instead.

Returns:

(::String) —
Output only. DEPRECATED: please use write_endpoint instead.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#project ⇒ `::String`

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

Returns:

(::String) —
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#psc_service_attachment_link ⇒ `::String` (readonly)

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

Returns:

(::String) —
Output only. The link to service attachment of PSC instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#region ⇒ `::String`

Returns 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.

Returns:

(::String) —
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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#replica_configuration ⇒ `::Google::Cloud::Sql::V1beta4::ReplicaConfiguration`

Returns Configuration specific to failover replicas and read replicas.

Returns:

(::Google::Cloud::Sql::V1beta4::ReplicaConfiguration) —
Configuration specific to failover replicas and read replicas.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#replica_names ⇒ `::Array<::String>`

Returns The replicas of the instance.

Returns:

(::Array<::String>) —
The replicas of the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#replication_cluster ⇒ `::Google::Cloud::Sql::V1beta4::ReplicationCluster`

Returns 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.

Returns:

(::Google::Cloud::Sql::V1beta4::ReplicationCluster) —
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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#root_password ⇒ `::String`

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

Returns:

(::String) —
Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#satisfies_pzi ⇒ `::Google::Protobuf::BoolValue` (readonly)

Returns Output only. This status indicates whether the instance satisfies PZI.

The status is reserved for future use.

Returns:

(::Google::Protobuf::BoolValue) —
Output only. This status indicates whether the instance satisfies PZI.

The status is reserved for future use.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#satisfies_pzs ⇒ `::Google::Protobuf::BoolValue`

Returns This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

Returns:

(::Google::Protobuf::BoolValue) —
This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#scheduled_maintenance ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlScheduledMaintenance`

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

Returns:

(::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlScheduledMaintenance) —
The start time of any upcoming scheduled maintenance for this instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#secondary_gce_zone ⇒ `::String`

Returns 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.

Returns:

(::String) —
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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#self_link ⇒ `::String`

Returns The URI of this resource.

Returns:

(::String) —
The URI of this resource.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#server_ca_cert ⇒ `::Google::Cloud::Sql::V1beta4::SslCert`

Returns SSL configuration.

Returns:

(::Google::Cloud::Sql::V1beta4::SslCert) —
SSL configuration.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#service_account_email_address ⇒ `::String`

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

Returns:

(::String) —
The service account email address assigned to the instance. \This property is read-only.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#settings ⇒ `::Google::Cloud::Sql::V1beta4::Settings`

Returns The user settings.

Returns:

(::Google::Cloud::Sql::V1beta4::Settings) —
The user settings.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#sql_network_architecture ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlNetworkArchitecture`

Returns The SQL network architecture for the instance.

Returns:

(::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlNetworkArchitecture) —
The SQL network architecture for the instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#state ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState`

Returns The current serving state of the Cloud SQL instance.

Returns:

(::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState) —
The current serving state of the Cloud SQL instance.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#suspension_reason ⇒ `::Array<::Google::Cloud::Sql::V1beta4::SqlSuspensionReason>`

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

Returns:

(::Array<::Google::Cloud::Sql::V1beta4::SqlSuspensionReason>) —
If the instance state is SUSPENDED, the reason for the suspension.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#switch_transaction_logs_to_cloud_storage_enabled ⇒ `::Google::Protobuf::BoolValue`

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

Returns:

(::Google::Protobuf::BoolValue) —
Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#tags ⇒ `::Google::Protobuf::Map{::String => ::String}`

Returns Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

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.

Returns:

(::Google::Protobuf::Map{::String => ::String}) —
Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

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.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#upgradable_database_versions ⇒ `::Array<::Google::Cloud::Sql::V1beta4::AvailableDatabaseVersion>` (readonly)

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

Returns:

(::Array<::Google::Cloud::Sql::V1beta4::AvailableDatabaseVersion>) —
Output only. All database versions that are available for upgrade.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

#write_endpoint ⇒ `::String` (readonly)

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

Returns:

(::String) —
Output only. The dns name of the primary instance in a replication group.

# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 837

class DatabaseInstance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] name
  #   @return [::String]
  #     The name of the failover replica. If specified at instance creation, a
  #     failover replica is created for the instance. The name
  #     doesn't include the project ID.
  # @!attribute [rw] available
  #   @return [::Google::Protobuf::BoolValue]
  #     The availability status of the failover replica. A false status indicates
  #     that the failover replica is out of sync. The primary instance can only
  #     failover to the failover replica when the status is true.
  class SqlFailoverReplica
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Any scheduled maintenance for this instance.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The start time of any upcoming scheduled maintenance for this instance.
  # @!attribute [rw] can_defer
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  # @!attribute [rw] can_reschedule
  #   @return [::Boolean]
  #     If the scheduled maintenance can be rescheduled.
  # @!attribute [rw] schedule_deadline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Maintenance cannot be rescheduled to start beyond this deadline.
  class SqlScheduledMaintenance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This message wraps up the information written by out-of-disk detection job.
  # @!attribute [rw] sql_out_of_disk_state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
  #     This field represents the state generated by the proactive database
  #     wellness job for OutOfDisk issues.
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  #       *  the proactive database wellness job
  # @!attribute [rw] sql_min_recommended_increase_size_gb
  #   @return [::Integer]
  #     The minimum recommended increase size in GigaBytes
  #     This field is consumed by the frontend
  #     *  Writers:
  #       *  the proactive database wellness job for OOD.
  #     *  Readers:
  class SqlOutOfDiskReport
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This enum lists all possible states regarding out-of-disk issues.
    module SqlOutOfDiskState
      # Unspecified state
      SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0

      # The instance has plenty space on data disk
      NORMAL = 1

      # Data disk is almost used up. It is shutdown to prevent data
      # corruption.
      SOFT_SHUTDOWN = 2
    end
  end

  # Details of a single read pool node of a read pool.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the read pool node, to be used for retrieving
  #     metrics and logs.
  # @!attribute [r] gce_zone
  #   @return [::String]
  #     Output only. The zone of the read pool node.
  # @!attribute [r] ip_addresses
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
  #     Output only. Mappings containing IP addresses that can be used to connect
  #     to the read pool node.
  # @!attribute [r] dns_name
  #   @return [::String]
  #     Output only. The DNS name of the read pool node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState]
  #     Output only. The current state of the read pool node.
  # @!attribute [r] dns_names
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>]
  #     Output only. The list of DNS names used by this read pool node.
  # @!attribute [r] psc_service_attachment_link
  #   @return [::String]
  #     Output only. The Private Service Connect (PSC) service attachment of the
  #     read pool node.
  # @!attribute [r] psc_auto_connections
  #   @return [::Array<::Google::Cloud::Sql::V1beta4::PscAutoConnectionConfig>]
  #     Output only. The list of settings for requested automatically-setup
  #     Private Service Connect (PSC) consumer endpoints that can be used to
  #     connect to this read pool node.
  class PoolNodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current serving state of the database instance.
  module SqlInstanceState
    # The state of the instance is unknown.
    SQL_INSTANCE_STATE_UNSPECIFIED = 0

    # The instance is running, or has been stopped by owner.
    RUNNABLE = 1

    # The instance is not available, for example due to problems with billing.
    SUSPENDED = 2

    # The instance is being deleted.
    PENDING_DELETE = 3

    # The instance is being created.
    PENDING_CREATE = 4

    # The instance is down for maintenance.
    MAINTENANCE = 5

    # The creation of the instance failed or a fatal error occurred during
    # maintenance.
    FAILED = 6

    # Deprecated
    ONLINE_MAINTENANCE = 7

    # (Applicable to read pool nodes only.) The read pool node needs to be
    # repaired. The database might be unavailable.
    REPAIRING = 8
  end

  # The SQL network architecture for the instance.
  module SqlNetworkArchitecture
    SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0

    # The instance uses the new network architecture.
    NEW_NETWORK_ARCHITECTURE = 1

    # The instance uses the old network architecture.
    OLD_NETWORK_ARCHITECTURE = 2
  end
end

Class: Google::Cloud::Sql::V1beta4::DatabaseInstance

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#available_maintenance_versions ⇒ ::Array<::String> (readonly)

#backend_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlBackendType

#connection_name ⇒ ::String

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#current_disk_size ⇒ ::Google::Protobuf::Int64Value

#database_center_integration_enabled ⇒ ::Google::Protobuf::BoolValue

#database_installed_version ⇒ ::String (readonly)

#database_version ⇒ ::Google::Cloud::Sql::V1beta4::SqlDatabaseVersion

#disk_encryption_configuration ⇒ ::Google::Cloud::Sql::V1beta4::DiskEncryptionConfiguration

#disk_encryption_status ⇒ ::Google::Cloud::Sql::V1beta4::DiskEncryptionStatus

#dns_name ⇒ ::String (readonly)

#dns_names ⇒ ::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping> (readonly)

#etag ⇒ ::String

#failover_replica ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlFailoverReplica

#gce_zone ⇒ ::String

#gemini_config ⇒ ::Google::Cloud::Sql::V1beta4::GeminiInstanceConfig

#include_replicas_for_major_version_upgrade ⇒ ::Google::Protobuf::BoolValue

#instance_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlInstanceType

#ip_addresses ⇒ ::Array<::Google::Cloud::Sql::V1beta4::IpMapping>

#ipv6_address ⇒ ::String

#kind ⇒ ::String

#maintenance_version ⇒ ::String

#master_instance_name ⇒ ::String

#max_disk_size ⇒ ::Google::Protobuf::Int64Value

#name ⇒ ::String

#node_count ⇒ ::Integer

#nodes ⇒ ::Array<::Google::Cloud::Sql::V1beta4::DatabaseInstance::PoolNodeConfig> (readonly)

#on_premises_configuration ⇒ ::Google::Cloud::Sql::V1beta4::OnPremisesConfiguration

#out_of_disk_report ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport

#primary_dns_name ⇒ ::String (readonly)

#project ⇒ ::String

#psc_service_attachment_link ⇒ ::String (readonly)

#region ⇒ ::String

#replica_configuration ⇒ ::Google::Cloud::Sql::V1beta4::ReplicaConfiguration

#replica_names ⇒ ::Array<::String>

#replication_cluster ⇒ ::Google::Cloud::Sql::V1beta4::ReplicationCluster

#root_password ⇒ ::String

#satisfies_pzi ⇒ ::Google::Protobuf::BoolValue (readonly)

#satisfies_pzs ⇒ ::Google::Protobuf::BoolValue

#scheduled_maintenance ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlScheduledMaintenance

#secondary_gce_zone ⇒ ::String

#self_link ⇒ ::String

#server_ca_cert ⇒ ::Google::Cloud::Sql::V1beta4::SslCert

#service_account_email_address ⇒ ::String

#settings ⇒ ::Google::Cloud::Sql::V1beta4::Settings

#sql_network_architecture ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlNetworkArchitecture

#state ⇒ ::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState

#suspension_reason ⇒ ::Array<::Google::Cloud::Sql::V1beta4::SqlSuspensionReason>

#switch_transaction_logs_to_cloud_storage_enabled ⇒ ::Google::Protobuf::BoolValue

#tags ⇒ ::Google::Protobuf::Map{::String => ::String}

#upgradable_database_versions ⇒ ::Array<::Google::Cloud::Sql::V1beta4::AvailableDatabaseVersion> (readonly)

#write_endpoint ⇒ ::String (readonly)

#available_maintenance_versions ⇒ `::Array<::String>` (readonly)

#backend_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlBackendType`

#connection_name ⇒ `::String`

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#current_disk_size ⇒ `::Google::Protobuf::Int64Value`

#database_center_integration_enabled ⇒ `::Google::Protobuf::BoolValue`

#database_installed_version ⇒ `::String` (readonly)

#database_version ⇒ `::Google::Cloud::Sql::V1beta4::SqlDatabaseVersion`

#disk_encryption_configuration ⇒ `::Google::Cloud::Sql::V1beta4::DiskEncryptionConfiguration`

#disk_encryption_status ⇒ `::Google::Cloud::Sql::V1beta4::DiskEncryptionStatus`

#dns_name ⇒ `::String` (readonly)

#dns_names ⇒ `::Array<::Google::Cloud::Sql::V1beta4::DnsNameMapping>` (readonly)

#etag ⇒ `::String`

#failover_replica ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlFailoverReplica`

#gce_zone ⇒ `::String`

#gemini_config ⇒ `::Google::Cloud::Sql::V1beta4::GeminiInstanceConfig`

#include_replicas_for_major_version_upgrade ⇒ `::Google::Protobuf::BoolValue`

#instance_type ⇒ `::Google::Cloud::Sql::V1beta4::SqlInstanceType`

#ip_addresses ⇒ `::Array<::Google::Cloud::Sql::V1beta4::IpMapping>`

#ipv6_address ⇒ `::String`

#kind ⇒ `::String`

#maintenance_version ⇒ `::String`

#master_instance_name ⇒ `::String`

#max_disk_size ⇒ `::Google::Protobuf::Int64Value`

#name ⇒ `::String`

#node_count ⇒ `::Integer`

#nodes ⇒ `::Array<::Google::Cloud::Sql::V1beta4::DatabaseInstance::PoolNodeConfig>` (readonly)

#on_premises_configuration ⇒ `::Google::Cloud::Sql::V1beta4::OnPremisesConfiguration`

#out_of_disk_report ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlOutOfDiskReport`

#primary_dns_name ⇒ `::String` (readonly)

#project ⇒ `::String`

#psc_service_attachment_link ⇒ `::String` (readonly)

#region ⇒ `::String`

#replica_configuration ⇒ `::Google::Cloud::Sql::V1beta4::ReplicaConfiguration`

#replica_names ⇒ `::Array<::String>`

#replication_cluster ⇒ `::Google::Cloud::Sql::V1beta4::ReplicationCluster`

#root_password ⇒ `::String`

#satisfies_pzi ⇒ `::Google::Protobuf::BoolValue` (readonly)

#satisfies_pzs ⇒ `::Google::Protobuf::BoolValue`

#scheduled_maintenance ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlScheduledMaintenance`

#secondary_gce_zone ⇒ `::String`

#self_link ⇒ `::String`

#server_ca_cert ⇒ `::Google::Cloud::Sql::V1beta4::SslCert`

#service_account_email_address ⇒ `::String`

#settings ⇒ `::Google::Cloud::Sql::V1beta4::Settings`

#sql_network_architecture ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlNetworkArchitecture`

#state ⇒ `::Google::Cloud::Sql::V1beta4::DatabaseInstance::SqlInstanceState`

#suspension_reason ⇒ `::Array<::Google::Cloud::Sql::V1beta4::SqlSuspensionReason>`

#switch_transaction_logs_to_cloud_storage_enabled ⇒ `::Google::Protobuf::BoolValue`

#tags ⇒ `::Google::Protobuf::Map{::String => ::String}`

#upgradable_database_versions ⇒ `::Array<::Google::Cloud::Sql::V1beta4::AvailableDatabaseVersion>` (readonly)

#write_endpoint ⇒ `::String` (readonly)