Class: Google::Apis::SqladminV1::DatabaseInstance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/representations.rb

Overview

A Cloud SQL instance resource.

Defined Under Namespace

Classes: FailoverReplica

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DatabaseInstance

Returns a new instance of DatabaseInstance.



1084
1085
1086
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1084

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#available_maintenance_versions ⇒ Array<String>

Output only. List all maintenance versions applicable on the instance Corresponds to the JSON property availableMaintenanceVersions

Returns:

  • (Array<String>) 


826
827
828
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 826

def available_maintenance_versions
  @available_maintenance_versions
end

#backend_type ⇒ String

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. Corresponds to the JSON property backendType

Returns:

  • (String) 


833
834
835
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 833

def backend_type
  @backend_type
end

#connection_name ⇒ String

Connection name of the Cloud SQL instance used in connection strings. Corresponds to the JSON property connectionName

Returns:

  • (String) 


838
839
840
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 838

def connection_name
  @connection_name
end

#create_time ⇒ String

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

Returns:

  • (String) 


844
845
846
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 844

def create_time
  @create_time
end

#current_disk_size ⇒ Fixnum

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. Corresponds to the JSON property currentDiskSize

Returns:

  • (Fixnum) 


853
854
855
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 853

def current_disk_size
  @current_disk_size
end

#database_installed_version ⇒ String

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18. Corresponds to the JSON property databaseInstalledVersion

Returns:

  • (String) 


859
860
861
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 859

def database_installed_version
  @database_installed_version
end

#database_version ⇒ String

The database engine type and version. The databaseVersion field cannot be changed after instance creation. Corresponds to the JSON property databaseVersion

Returns:

  • (String) 


865
866
867
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 865

def database_version
  @database_version
end

#disk_encryption_configuration ⇒ Google::Apis::SqladminV1::DiskEncryptionConfiguration

Disk encryption configuration for an instance. Corresponds to the JSON property diskEncryptionConfiguration

Returns:



870
871
872
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 870

def disk_encryption_configuration
  @disk_encryption_configuration
end

#disk_encryption_status ⇒ Google::Apis::SqladminV1::DiskEncryptionStatus

Disk encryption status for an instance. Corresponds to the JSON property diskEncryptionStatus

Returns:



875
876
877
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 875

def disk_encryption_status
  @disk_encryption_status
end

#dns_name ⇒ String

Output only. The dns name of the instance. Corresponds to the JSON property dnsName

Returns:

  • (String) 


880
881
882
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 880

def dns_name
  @dns_name
end

#etag ⇒ String

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

Returns:

  • (String) 


886
887
888
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 886

def etag
  @etag
end

#failover_replica ⇒ Google::Apis::SqladminV1::DatabaseInstance::FailoverReplica

The name and status of the failover replica. Corresponds to the JSON property failoverReplica

Returns:



891
892
893
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 891

def failover_replica
  @failover_replica
end

#gce_zone ⇒ 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. Corresponds to the JSON property gceZone

Returns:

  • (String) 


899
900
901
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 899

def gce_zone
  @gce_zone
end

#gemini_config ⇒ Google::Apis::SqladminV1::GeminiInstanceConfig

Gemini instance configuration. Corresponds to the JSON property geminiConfig

Returns:



904
905
906
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 904

def gemini_config
  @gemini_config
end

#instance_type ⇒ String

The instance type. Corresponds to the JSON property instanceType

Returns:

  • (String) 


909
910
911
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 909

def instance_type
  @instance_type
end

#ip_addresses ⇒ Array<Google::Apis::SqladminV1::IpMapping>

The assigned IP addresses for the instance. Corresponds to the JSON property ipAddresses

Returns:



914
915
916
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 914

def ip_addresses
  @ip_addresses
end

#ipv6_address ⇒ String

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

Returns:

  • (String) 


920
921
922
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 920

def ipv6_address
  @ipv6_address
end

#kind ⇒ String

This is always sql#instance. Corresponds to the JSON property kind

Returns:

  • (String) 


925
926
927
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 925

def kind
  @kind
end

#maintenance_version ⇒ String

The current software version on the instance. Corresponds to the JSON property maintenanceVersion

Returns:

  • (String) 


930
931
932
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 930

def maintenance_version
  @maintenance_version
end

#master_instance_name ⇒ String

The name of the instance which will act as primary in the replication setup. Corresponds to the JSON property masterInstanceName

Returns:

  • (String) 


935
936
937
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 935

def master_instance_name
  @master_instance_name
end

#max_disk_size ⇒ Fixnum

The maximum disk size of the instance in bytes. Corresponds to the JSON property maxDiskSize

Returns:

  • (Fixnum) 


940
941
942
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 940

def max_disk_size
  @max_disk_size
end

#name ⇒ String

Name of the Cloud SQL instance. This does not include the project ID. Corresponds to the JSON property name

Returns:

  • (String) 


945
946
947
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 945

def name
  @name
end

#on_premises_configuration ⇒ Google::Apis::SqladminV1::OnPremisesConfiguration

On-premises instance configuration. Corresponds to the JSON property onPremisesConfiguration

Returns:



950
951
952
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 950

def on_premises_configuration
  @on_premises_configuration
end

#out_of_disk_report ⇒ Google::Apis::SqladminV1::SqlOutOfDiskReport

This message wraps up the information written by out-of-disk detection job. Corresponds to the JSON property outOfDiskReport

Returns:



955
956
957
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 955

def out_of_disk_report
  @out_of_disk_report
end

#primary_dns_name ⇒ String

Output only. DEPRECATED: please use write_endpoint instead. Corresponds to the JSON property primaryDnsName

Returns:

  • (String) 


960
961
962
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 960

def primary_dns_name
  @primary_dns_name
end

#project ⇒ String

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

Returns:

  • (String) 


966
967
968
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 966

def project
  @project
end

#psc_service_attachment_link ⇒ String

Output only. The link to service attachment of PSC instance. Corresponds to the JSON property pscServiceAttachmentLink

Returns:

  • (String) 


971
972
973
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 971

def psc_service_attachment_link
  @psc_service_attachment_link
end

#region ⇒ 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. Corresponds to the JSON property region

Returns:

  • (String) 


979
980
981
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 979

def region
  @region
end

#replica_configuration ⇒ Google::Apis::SqladminV1::ReplicaConfiguration

Read-replica configuration for connecting to the primary instance. Corresponds to the JSON property replicaConfiguration

Returns:



984
985
986
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 984

def replica_configuration
  @replica_configuration
end

#replica_names ⇒ Array<String>

The replicas of the instance. Corresponds to the JSON property replicaNames

Returns:

  • (Array<String>) 


989
990
991
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 989

def replica_names
  @replica_names
end

#replication_cluster ⇒ Google::Apis::SqladminV1::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. Only applicable to MySQL. Corresponds to the JSON property replicationCluster

Returns:



996
997
998
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 996

def replication_cluster
  @replication_cluster
end

#root_password ⇒ String

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. Corresponds to the JSON property rootPassword

Returns:

  • (String) 


1002
1003
1004
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1002

def root_password
  @root_password
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


1008
1009
1010
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1008

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

This status indicates whether the instance satisfies PZS. The status is reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


1015
1016
1017
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1015

def satisfies_pzs
  @satisfies_pzs
end

#scheduled_maintenance ⇒ Google::Apis::SqladminV1::SqlScheduledMaintenance

Any scheduled maintenance for this instance. Corresponds to the JSON property scheduledMaintenance

Returns:



1021
1022
1023
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1021

def scheduled_maintenance
  @scheduled_maintenance
end

#secondary_gce_zone ⇒ 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. Corresponds to the JSON property secondaryGceZone

Returns:

  • (String) 


1029
1030
1031
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1029

def secondary_gce_zone
  @secondary_gce_zone
end

#self_link ⇒ String

The URI of this resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


1034
1035
1036
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1034

def self_link
  @self_link
end

#server_ca_cert ⇒ Google::Apis::SqladminV1::SslCert

SslCerts Resource Corresponds to the JSON property serverCaCert

Returns:



1039
1040
1041
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1039

def server_ca_cert
  @server_ca_cert
end

#service_account_email_address ⇒ String

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

Returns:

  • (String) 


1045
1046
1047
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1045

def 
  @service_account_email_address
end

#settings ⇒ Google::Apis::SqladminV1::Settings

Database instance settings. Corresponds to the JSON property settings

Returns:



1050
1051
1052
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1050

def settings
  @settings
end

#sql_network_architecture ⇒ String

Corresponds to the JSON property sqlNetworkArchitecture

Returns:

  • (String) 


1055
1056
1057
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1055

def sql_network_architecture
  @sql_network_architecture
end

#state ⇒ String

The current serving state of the Cloud SQL instance. Corresponds to the JSON property state

Returns:

  • (String) 


1060
1061
1062
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1060

def state
  @state
end

#suspension_reason ⇒ Array<String>

If the instance state is SUSPENDED, the reason for the suspension. Corresponds to the JSON property suspensionReason

Returns:

  • (Array<String>) 


1065
1066
1067
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1065

def suspension_reason
  @suspension_reason
end

#switch_transaction_logs_to_cloud_storage_enabled ⇒ Boolean Also known as: switch_transaction_logs_to_cloud_storage_enabled?

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

Returns:

  • (Boolean) 


1071
1072
1073
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1071

def switch_transaction_logs_to_cloud_storage_enabled
  @switch_transaction_logs_to_cloud_storage_enabled
end

#upgradable_database_versions ⇒ Array<Google::Apis::SqladminV1::AvailableDatabaseVersion>

Output only. All database versions that are available for upgrade. Corresponds to the JSON property upgradableDatabaseVersions

Returns:



1077
1078
1079
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1077

def upgradable_database_versions
  @upgradable_database_versions
end

#write_endpoint ⇒ String

Output only. The dns name of the primary instance in a replication group. Corresponds to the JSON property writeEndpoint

Returns:

  • (String) 


1082
1083
1084
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1082

def write_endpoint
  @write_endpoint
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 1089

def update!(**args)
  @available_maintenance_versions = args[:available_maintenance_versions] if args.key?(:available_maintenance_versions)
  @backend_type = args[:backend_type] if args.key?(:backend_type)
  @connection_name = args[:connection_name] if args.key?(:connection_name)
  @create_time = args[:create_time] if args.key?(:create_time)
  @current_disk_size = args[:current_disk_size] if args.key?(:current_disk_size)
  @database_installed_version = args[:database_installed_version] if args.key?(:database_installed_version)
  @database_version = args[:database_version] if args.key?(:database_version)
  @disk_encryption_configuration = args[:disk_encryption_configuration] if args.key?(:disk_encryption_configuration)
  @disk_encryption_status = args[:disk_encryption_status] if args.key?(:disk_encryption_status)
  @dns_name = args[:dns_name] if args.key?(:dns_name)
  @etag = args[:etag] if args.key?(:etag)
  @failover_replica = args[:failover_replica] if args.key?(:failover_replica)
  @gce_zone = args[:gce_zone] if args.key?(:gce_zone)
  @gemini_config = args[:gemini_config] if args.key?(:gemini_config)
  @instance_type = args[:instance_type] if args.key?(:instance_type)
  @ip_addresses = args[:ip_addresses] if args.key?(:ip_addresses)
  @ipv6_address = args[:ipv6_address] if args.key?(:ipv6_address)
  @kind = args[:kind] if args.key?(:kind)
  @maintenance_version = args[:maintenance_version] if args.key?(:maintenance_version)
  @master_instance_name = args[:master_instance_name] if args.key?(:master_instance_name)
  @max_disk_size = args[:max_disk_size] if args.key?(:max_disk_size)
  @name = args[:name] if args.key?(:name)
  @on_premises_configuration = args[:on_premises_configuration] if args.key?(:on_premises_configuration)
  @out_of_disk_report = args[:out_of_disk_report] if args.key?(:out_of_disk_report)
  @primary_dns_name = args[:primary_dns_name] if args.key?(:primary_dns_name)
  @project = args[:project] if args.key?(:project)
  @psc_service_attachment_link = args[:psc_service_attachment_link] if args.key?(:psc_service_attachment_link)
  @region = args[:region] if args.key?(:region)
  @replica_configuration = args[:replica_configuration] if args.key?(:replica_configuration)
  @replica_names = args[:replica_names] if args.key?(:replica_names)
  @replication_cluster = args[:replication_cluster] if args.key?(:replication_cluster)
  @root_password = args[:root_password] if args.key?(:root_password)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @scheduled_maintenance = args[:scheduled_maintenance] if args.key?(:scheduled_maintenance)
  @secondary_gce_zone = args[:secondary_gce_zone] if args.key?(:secondary_gce_zone)
  @self_link = args[:self_link] if args.key?(:self_link)
  @server_ca_cert = args[:server_ca_cert] if args.key?(:server_ca_cert)
  @service_account_email_address = args[:service_account_email_address] if args.key?(:service_account_email_address)
  @settings = args[:settings] if args.key?(:settings)
  @sql_network_architecture = args[:sql_network_architecture] if args.key?(:sql_network_architecture)
  @state = args[:state] if args.key?(:state)
  @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason)
  @switch_transaction_logs_to_cloud_storage_enabled = args[:switch_transaction_logs_to_cloud_storage_enabled] if args.key?(:switch_transaction_logs_to_cloud_storage_enabled)
  @upgradable_database_versions = args[:upgradable_database_versions] if args.key?(:upgradable_database_versions)
  @write_endpoint = args[:write_endpoint] if args.key?(:write_endpoint)
end