google-cloud-sql-v1 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +146 -8
  5. data/lib/google/cloud/sql/v1/cloud_sql_available_database_versions_pb.rb +25 -0
  6. data/lib/google/cloud/sql/v1/cloud_sql_available_database_versions_services_pb.rb +29 -0
  7. data/lib/google/cloud/sql/v1/cloud_sql_backup_runs_pb.rb +35 -0
  8. data/lib/google/cloud/sql/v1/cloud_sql_backup_runs_services_pb.rb +53 -0
  9. data/lib/google/cloud/sql/v1/cloud_sql_backups_pb.rb +41 -0
  10. data/lib/google/cloud/sql/v1/cloud_sql_backups_services_pb.rb +54 -0
  11. data/lib/google/cloud/sql/v1/cloud_sql_connect_pb.rb +34 -0
  12. data/lib/google/cloud/sql/v1/cloud_sql_connect_services_pb.rb +50 -0
  13. data/lib/google/cloud/sql/v1/cloud_sql_databases_pb.rb +30 -0
  14. data/lib/google/cloud/sql/v1/cloud_sql_databases_services_pb.rb +61 -0
  15. data/lib/google/cloud/sql/v1/cloud_sql_events_pb.rb +25 -0
  16. data/lib/google/cloud/sql/v1/cloud_sql_events_services_pb.rb +29 -0
  17. data/lib/google/cloud/sql/v1/cloud_sql_feature_eligibility_pb.rb +24 -0
  18. data/lib/google/cloud/sql/v1/cloud_sql_feature_eligibility_services_pb.rb +29 -0
  19. data/lib/google/cloud/sql/v1/cloud_sql_flags_pb.rb +31 -0
  20. data/lib/google/cloud/sql/v1/cloud_sql_flags_services_pb.rb +45 -0
  21. data/lib/google/cloud/sql/v1/cloud_sql_iam_policies_pb.rb +23 -0
  22. data/lib/google/cloud/sql/v1/cloud_sql_iam_policies_services_pb.rb +29 -0
  23. data/lib/google/cloud/sql/v1/cloud_sql_instance_names_pb.rb +24 -0
  24. data/lib/google/cloud/sql/v1/cloud_sql_instance_names_services_pb.rb +29 -0
  25. data/lib/google/cloud/sql/v1/cloud_sql_instances_pb.rb +146 -0
  26. data/lib/google/cloud/sql/v1/cloud_sql_instances_services_pb.rb +184 -0
  27. data/lib/google/cloud/sql/v1/cloud_sql_operations_pb.rb +30 -0
  28. data/lib/google/cloud/sql/v1/cloud_sql_operations_services_pb.rb +50 -0
  29. data/lib/google/cloud/sql/v1/cloud_sql_regions_pb.rb +25 -0
  30. data/lib/google/cloud/sql/v1/cloud_sql_regions_services_pb.rb +29 -0
  31. data/lib/google/cloud/sql/v1/cloud_sql_resources_pb.rb +119 -0
  32. data/lib/google/cloud/sql/v1/cloud_sql_ssl_certs_pb.rb +31 -0
  33. data/lib/google/cloud/sql/v1/cloud_sql_ssl_certs_services_pb.rb +56 -0
  34. data/lib/google/cloud/sql/v1/cloud_sql_tiers_pb.rb +26 -0
  35. data/lib/google/cloud/sql/v1/cloud_sql_tiers_services_pb.rb +47 -0
  36. data/lib/google/cloud/sql/v1/cloud_sql_users_pb.rb +41 -0
  37. data/lib/google/cloud/sql/v1/cloud_sql_users_services_pb.rb +53 -0
  38. data/lib/google/cloud/sql/v1/rest.rb +46 -0
  39. data/lib/google/cloud/sql/v1/sql_backup_runs_service/client.rb +809 -0
  40. data/lib/google/cloud/sql/v1/sql_backup_runs_service/credentials.rb +48 -0
  41. data/lib/google/cloud/sql/v1/sql_backup_runs_service/rest/client.rb +720 -0
  42. data/lib/google/cloud/sql/v1/sql_backup_runs_service/rest/service_stub.rb +332 -0
  43. data/lib/google/cloud/sql/v1/sql_backup_runs_service/rest.rb +51 -0
  44. data/lib/google/cloud/sql/v1/sql_backup_runs_service.rb +54 -0
  45. data/lib/google/cloud/sql/v1/sql_backups_service/client.rb +896 -0
  46. data/lib/google/cloud/sql/v1/sql_backups_service/credentials.rb +48 -0
  47. data/lib/google/cloud/sql/v1/sql_backups_service/paths.rb +64 -0
  48. data/lib/google/cloud/sql/v1/sql_backups_service/rest/client.rb +818 -0
  49. data/lib/google/cloud/sql/v1/sql_backups_service/rest/service_stub.rb +388 -0
  50. data/lib/google/cloud/sql/v1/sql_backups_service/rest.rb +50 -0
  51. data/lib/google/cloud/sql/v1/sql_backups_service.rb +53 -0
  52. data/lib/google/cloud/sql/v1/sql_connect_service/client.rb +607 -0
  53. data/lib/google/cloud/sql/v1/sql_connect_service/credentials.rb +48 -0
  54. data/lib/google/cloud/sql/v1/sql_connect_service/rest/client.rb +544 -0
  55. data/lib/google/cloud/sql/v1/sql_connect_service/rest/service_stub.rb +206 -0
  56. data/lib/google/cloud/sql/v1/sql_connect_service/rest.rb +51 -0
  57. data/lib/google/cloud/sql/v1/sql_connect_service.rb +54 -0
  58. data/lib/google/cloud/sql/v1/sql_databases_service/client.rb +1011 -0
  59. data/lib/google/cloud/sql/v1/sql_databases_service/credentials.rb +48 -0
  60. data/lib/google/cloud/sql/v1/sql_databases_service/rest/client.rb +896 -0
  61. data/lib/google/cloud/sql/v1/sql_databases_service/rest/service_stub.rb +460 -0
  62. data/lib/google/cloud/sql/v1/sql_databases_service/rest.rb +51 -0
  63. data/lib/google/cloud/sql/v1/sql_databases_service.rb +54 -0
  64. data/lib/google/cloud/sql/v1/sql_flags_service/client.rb +488 -0
  65. data/lib/google/cloud/sql/v1/sql_flags_service/credentials.rb +48 -0
  66. data/lib/google/cloud/sql/v1/sql_flags_service/rest/client.rb +446 -0
  67. data/lib/google/cloud/sql/v1/sql_flags_service/rest/service_stub.rb +140 -0
  68. data/lib/google/cloud/sql/v1/sql_flags_service/rest.rb +51 -0
  69. data/lib/google/cloud/sql/v1/sql_flags_service.rb +54 -0
  70. data/lib/google/cloud/sql/v1/sql_instances_service/client.rb +4738 -0
  71. data/lib/google/cloud/sql/v1/sql_instances_service/credentials.rb +48 -0
  72. data/lib/google/cloud/sql/v1/sql_instances_service/paths.rb +95 -0
  73. data/lib/google/cloud/sql/v1/sql_instances_service/rest/client.rb +4274 -0
  74. data/lib/google/cloud/sql/v1/sql_instances_service/rest/service_stub.rb +2769 -0
  75. data/lib/google/cloud/sql/v1/sql_instances_service/rest.rb +50 -0
  76. data/lib/google/cloud/sql/v1/sql_instances_service.rb +53 -0
  77. data/lib/google/cloud/sql/v1/sql_operations_service/client.rb +694 -0
  78. data/lib/google/cloud/sql/v1/sql_operations_service/credentials.rb +48 -0
  79. data/lib/google/cloud/sql/v1/sql_operations_service/rest/client.rb +624 -0
  80. data/lib/google/cloud/sql/v1/sql_operations_service/rest/service_stub.rb +266 -0
  81. data/lib/google/cloud/sql/v1/sql_operations_service/rest.rb +51 -0
  82. data/lib/google/cloud/sql/v1/sql_operations_service.rb +54 -0
  83. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/client.rb +804 -0
  84. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/credentials.rb +48 -0
  85. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/rest/client.rb +715 -0
  86. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/rest/service_stub.rb +332 -0
  87. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/rest.rb +51 -0
  88. data/lib/google/cloud/sql/v1/sql_ssl_certs_service.rb +54 -0
  89. data/lib/google/cloud/sql/v1/sql_tiers_service/client.rb +494 -0
  90. data/lib/google/cloud/sql/v1/sql_tiers_service/credentials.rb +48 -0
  91. data/lib/google/cloud/sql/v1/sql_tiers_service/rest/client.rb +444 -0
  92. data/lib/google/cloud/sql/v1/sql_tiers_service/rest/service_stub.rb +142 -0
  93. data/lib/google/cloud/sql/v1/sql_tiers_service/rest.rb +51 -0
  94. data/lib/google/cloud/sql/v1/sql_tiers_service.rb +54 -0
  95. data/lib/google/cloud/sql/v1/sql_users_service/client.rb +909 -0
  96. data/lib/google/cloud/sql/v1/sql_users_service/credentials.rb +48 -0
  97. data/lib/google/cloud/sql/v1/sql_users_service/rest/client.rb +813 -0
  98. data/lib/google/cloud/sql/v1/sql_users_service/rest/service_stub.rb +394 -0
  99. data/lib/google/cloud/sql/v1/sql_users_service/rest.rb +51 -0
  100. data/lib/google/cloud/sql/v1/sql_users_service.rb +54 -0
  101. data/lib/google/cloud/sql/v1/version.rb +8 -3
  102. data/lib/google/cloud/sql/v1.rb +60 -0
  103. data/lib/google-cloud-sql-v1.rb +21 -0
  104. data/proto_docs/README.md +4 -0
  105. data/proto_docs/google/api/client.rb +593 -0
  106. data/proto_docs/google/api/field_behavior.rb +85 -0
  107. data/proto_docs/google/api/field_info.rb +88 -0
  108. data/proto_docs/google/api/launch_stage.rb +71 -0
  109. data/proto_docs/google/api/resource.rb +227 -0
  110. data/proto_docs/google/cloud/sql/v1/cloud_sql_backup_runs.rb +245 -0
  111. data/proto_docs/google/cloud/sql/v1/cloud_sql_backups.rb +259 -0
  112. data/proto_docs/google/cloud/sql/v1/cloud_sql_connect.rb +190 -0
  113. data/proto_docs/google/cloud/sql/v1/cloud_sql_databases.rb +111 -0
  114. data/proto_docs/google/cloud/sql/v1/cloud_sql_flags.rb +154 -0
  115. data/proto_docs/google/cloud/sql/v1/cloud_sql_instances.rb +2357 -0
  116. data/proto_docs/google/cloud/sql/v1/cloud_sql_operations.rb +85 -0
  117. data/proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb +2522 -0
  118. data/proto_docs/google/cloud/sql/v1/cloud_sql_ssl_certs.rb +120 -0
  119. data/proto_docs/google/cloud/sql/v1/cloud_sql_tiers.rb +69 -0
  120. data/proto_docs/google/cloud/sql/v1/cloud_sql_users.rb +291 -0
  121. data/proto_docs/google/protobuf/any.rb +145 -0
  122. data/proto_docs/google/protobuf/duration.rb +98 -0
  123. data/proto_docs/google/protobuf/empty.rb +34 -0
  124. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  125. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  126. data/proto_docs/google/protobuf/wrappers.rb +148 -0
  127. data/proto_docs/google/rpc/status.rb +48 -0
  128. data/proto_docs/google/type/interval.rb +45 -0
  129. metadata +176 -14
@@ -0,0 +1,2357 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Sql
23
+ module V1
24
+ # Instance add server CA request.
25
+ # @!attribute [rw] instance
26
+ # @return [::String]
27
+ # Cloud SQL instance ID. This does not include the project ID.
28
+ # @!attribute [rw] project
29
+ # @return [::String]
30
+ # Project ID of the project that contains the instance.
31
+ class SqlInstancesAddServerCaRequest
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+ end
35
+
36
+ # Instance add server certificate request.
37
+ # @!attribute [rw] instance
38
+ # @return [::String]
39
+ # Cloud SQL instance ID. This does not include the project ID.
40
+ # @!attribute [rw] project
41
+ # @return [::String]
42
+ # Project ID of the project that contains the instance.
43
+ class SqlInstancesAddServerCertificateRequest
44
+ include ::Google::Protobuf::MessageExts
45
+ extend ::Google::Protobuf::MessageExts::ClassMethods
46
+ end
47
+
48
+ # Instance add Entra ID certificate request.
49
+ # @!attribute [rw] instance
50
+ # @return [::String]
51
+ # Required. Cloud SQL instance ID. This does not include the project ID.
52
+ # @!attribute [rw] project
53
+ # @return [::String]
54
+ # Required. Project ID of the project that contains the instance.
55
+ class SqlInstancesAddEntraIdCertificateRequest
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+ end
59
+
60
+ # Instance clone request.
61
+ # @!attribute [rw] instance
62
+ # @return [::String]
63
+ # Required. The ID of the Cloud SQL instance to be cloned (source). This does
64
+ # not include the project ID.
65
+ # @!attribute [rw] project
66
+ # @return [::String]
67
+ # Required. Project ID of the source Cloud SQL instance.
68
+ # @!attribute [rw] body
69
+ # @return [::Google::Cloud::Sql::V1::InstancesCloneRequest]
70
+ class SqlInstancesCloneRequest
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # Instance delete request.
76
+ # @!attribute [rw] instance
77
+ # @return [::String]
78
+ # Cloud SQL instance ID. This does not include the project ID.
79
+ # @!attribute [rw] project
80
+ # @return [::String]
81
+ # Project ID of the project that contains the instance to be deleted.
82
+ # @!attribute [rw] enable_final_backup
83
+ # @return [::Boolean]
84
+ # Flag to opt-in for final backup. By default, it is turned off.
85
+ # @!attribute [rw] final_backup_ttl_days
86
+ # @return [::Integer]
87
+ # Optional. Retention period of the final backup.
88
+ #
89
+ # Note: The following fields are mutually exclusive: `final_backup_ttl_days`, `final_backup_expiry_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
90
+ # @!attribute [rw] final_backup_expiry_time
91
+ # @return [::Google::Protobuf::Timestamp]
92
+ # Optional. Final Backup expiration time.
93
+ # Timestamp in UTC of when this resource is considered expired.
94
+ #
95
+ # Note: The following fields are mutually exclusive: `final_backup_expiry_time`, `final_backup_ttl_days`. If a field in that set is populated, all other fields in the set will automatically be cleared.
96
+ # @!attribute [rw] final_backup_description
97
+ # @return [::String]
98
+ # Optional. The description of the final backup.
99
+ class SqlInstancesDeleteRequest
100
+ include ::Google::Protobuf::MessageExts
101
+ extend ::Google::Protobuf::MessageExts::ClassMethods
102
+ end
103
+
104
+ # Instance demote master request.
105
+ # @!attribute [rw] instance
106
+ # @return [::String]
107
+ # Cloud SQL instance name.
108
+ # @!attribute [rw] project
109
+ # @return [::String]
110
+ # ID of the project that contains the instance.
111
+ # @!attribute [rw] body
112
+ # @return [::Google::Cloud::Sql::V1::InstancesDemoteMasterRequest]
113
+ class SqlInstancesDemoteMasterRequest
114
+ include ::Google::Protobuf::MessageExts
115
+ extend ::Google::Protobuf::MessageExts::ClassMethods
116
+ end
117
+
118
+ # Instance demote request.
119
+ # @!attribute [rw] instance
120
+ # @return [::String]
121
+ # Required. Cloud SQL instance name.
122
+ # @!attribute [rw] project
123
+ # @return [::String]
124
+ # Required. ID of the project that contains the instance.
125
+ # @!attribute [rw] body
126
+ # @return [::Google::Cloud::Sql::V1::InstancesDemoteRequest]
127
+ # Required. The request body.
128
+ class SqlInstancesDemoteRequest
129
+ include ::Google::Protobuf::MessageExts
130
+ extend ::Google::Protobuf::MessageExts::ClassMethods
131
+ end
132
+
133
+ # Instance export request.
134
+ # @!attribute [rw] instance
135
+ # @return [::String]
136
+ # Cloud SQL instance ID. This does not include the project ID.
137
+ # @!attribute [rw] project
138
+ # @return [::String]
139
+ # Project ID of the project that contains the instance to be exported.
140
+ # @!attribute [rw] body
141
+ # @return [::Google::Cloud::Sql::V1::InstancesExportRequest]
142
+ class SqlInstancesExportRequest
143
+ include ::Google::Protobuf::MessageExts
144
+ extend ::Google::Protobuf::MessageExts::ClassMethods
145
+ end
146
+
147
+ # Instance failover request.
148
+ # @!attribute [rw] instance
149
+ # @return [::String]
150
+ # Cloud SQL instance ID. This does not include the project ID.
151
+ # @!attribute [rw] project
152
+ # @return [::String]
153
+ # ID of the project that contains the read replica.
154
+ # @!attribute [rw] body
155
+ # @return [::Google::Cloud::Sql::V1::InstancesFailoverRequest]
156
+ class SqlInstancesFailoverRequest
157
+ include ::Google::Protobuf::MessageExts
158
+ extend ::Google::Protobuf::MessageExts::ClassMethods
159
+ end
160
+
161
+ # Instance get request.
162
+ # @!attribute [rw] instance
163
+ # @return [::String]
164
+ # Required. Database instance ID. This does not include the project ID.
165
+ # @!attribute [rw] project
166
+ # @return [::String]
167
+ # Required. Project ID of the project that contains the instance.
168
+ class SqlInstancesGetRequest
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
172
+
173
+ # Instance import request.
174
+ # @!attribute [rw] instance
175
+ # @return [::String]
176
+ # Cloud SQL instance ID. This does not include the project ID.
177
+ # @!attribute [rw] project
178
+ # @return [::String]
179
+ # Project ID of the project that contains the instance.
180
+ # @!attribute [rw] body
181
+ # @return [::Google::Cloud::Sql::V1::InstancesImportRequest]
182
+ class SqlInstancesImportRequest
183
+ include ::Google::Protobuf::MessageExts
184
+ extend ::Google::Protobuf::MessageExts::ClassMethods
185
+ end
186
+
187
+ # Instance insert request.
188
+ # @!attribute [rw] project
189
+ # @return [::String]
190
+ # Project ID of the project to which the newly created Cloud SQL instances
191
+ # should belong.
192
+ # @!attribute [rw] body
193
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance]
194
+ class SqlInstancesInsertRequest
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # Instance list request.
200
+ # @!attribute [rw] filter
201
+ # @return [::String]
202
+ # A filter expression that filters resources listed in the response.
203
+ # The expression is in the form of field:value. For example,
204
+ # 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per
205
+ # their JSON representation, such as 'settings.userLabels.auto_start:true'.
206
+ #
207
+ # Multiple filter queries are space-separated. For example.
208
+ # 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each
209
+ # expression is an AND expression. However, you can include AND and OR
210
+ # expressions explicitly.
211
+ # @!attribute [rw] max_results
212
+ # @return [::Integer]
213
+ # The maximum number of instances to return. The service may return fewer
214
+ # than this value.
215
+ # If unspecified, at most 500 instances are returned.
216
+ # The maximum value is 1000; values above 1000 are coerced to 1000.
217
+ # @!attribute [rw] page_token
218
+ # @return [::String]
219
+ # A previously-returned page token representing part of the larger set of
220
+ # results to view.
221
+ # @!attribute [rw] project
222
+ # @return [::String]
223
+ # Project ID of the project for which to list Cloud SQL instances.
224
+ class SqlInstancesListRequest
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Instance list server CAs request.
230
+ # @!attribute [rw] instance
231
+ # @return [::String]
232
+ # Cloud SQL instance ID. This does not include the project ID.
233
+ # @!attribute [rw] project
234
+ # @return [::String]
235
+ # Project ID of the project that contains the instance.
236
+ class SqlInstancesListServerCasRequest
237
+ include ::Google::Protobuf::MessageExts
238
+ extend ::Google::Protobuf::MessageExts::ClassMethods
239
+ end
240
+
241
+ # Instance list server certificates request.
242
+ # @!attribute [rw] instance
243
+ # @return [::String]
244
+ # Required. Cloud SQL instance ID. This does not include the project ID.
245
+ # @!attribute [rw] project
246
+ # @return [::String]
247
+ # Required. Project ID of the project that contains the instance.
248
+ class SqlInstancesListServerCertificatesRequest
249
+ include ::Google::Protobuf::MessageExts
250
+ extend ::Google::Protobuf::MessageExts::ClassMethods
251
+ end
252
+
253
+ # Instance list Entra ID certificates request.
254
+ # @!attribute [rw] instance
255
+ # @return [::String]
256
+ # Required. Cloud SQL instance ID. This does not include the project ID.
257
+ # @!attribute [rw] project
258
+ # @return [::String]
259
+ # Required. Project ID of the project that contains the instance.
260
+ class SqlInstancesListEntraIdCertificatesRequest
261
+ include ::Google::Protobuf::MessageExts
262
+ extend ::Google::Protobuf::MessageExts::ClassMethods
263
+ end
264
+
265
+ # Instance patch request.
266
+ # @!attribute [rw] instance
267
+ # @return [::String]
268
+ # Cloud SQL instance ID. This does not include the project ID.
269
+ # @!attribute [rw] project
270
+ # @return [::String]
271
+ # Project ID of the project that contains the instance.
272
+ # @!attribute [rw] body
273
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance]
274
+ class SqlInstancesPatchRequest
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
+ end
278
+
279
+ # Instance promote replica request.
280
+ # @!attribute [rw] instance
281
+ # @return [::String]
282
+ # Cloud SQL read replica instance name.
283
+ # @!attribute [rw] project
284
+ # @return [::String]
285
+ # ID of the project that contains the read replica.
286
+ # @!attribute [rw] failover
287
+ # @return [::Boolean]
288
+ # Set to true to invoke a replica failover to the DR
289
+ # replica. As part of replica failover, the promote operation attempts
290
+ # to add the original primary instance as a replica of the promoted
291
+ # DR replica when the original primary instance comes back online.
292
+ # If set to false or not specified, then the original primary
293
+ # instance becomes an independent Cloud SQL primary instance.
294
+ class SqlInstancesPromoteReplicaRequest
295
+ include ::Google::Protobuf::MessageExts
296
+ extend ::Google::Protobuf::MessageExts::ClassMethods
297
+ end
298
+
299
+ # Instance switchover request.
300
+ # @!attribute [rw] instance
301
+ # @return [::String]
302
+ # Cloud SQL read replica instance name.
303
+ # @!attribute [rw] project
304
+ # @return [::String]
305
+ # ID of the project that contains the replica.
306
+ # @!attribute [rw] db_timeout
307
+ # @return [::Google::Protobuf::Duration]
308
+ # Optional. (MySQL and PostgreSQL only) Cloud SQL instance operations
309
+ # timeout, which is a sum of all database operations. Default value is 10
310
+ # minutes and can be modified to a maximum value of 24 hours.
311
+ class SqlInstancesSwitchoverRequest
312
+ include ::Google::Protobuf::MessageExts
313
+ extend ::Google::Protobuf::MessageExts::ClassMethods
314
+ end
315
+
316
+ # Instance reset SSL config request.
317
+ # @!attribute [rw] instance
318
+ # @return [::String]
319
+ # Cloud SQL instance ID. This does not include the project ID.
320
+ # @!attribute [rw] project
321
+ # @return [::String]
322
+ # Project ID of the project that contains the instance.
323
+ # @!attribute [rw] mode
324
+ # @return [::Google::Cloud::Sql::V1::SqlInstancesResetSslConfigRequest::ResetSslMode]
325
+ # Optional. Reset SSL mode to use.
326
+ class SqlInstancesResetSslConfigRequest
327
+ include ::Google::Protobuf::MessageExts
328
+ extend ::Google::Protobuf::MessageExts::ClassMethods
329
+
330
+ # Reset SSL mode to selectively refresh the SSL materials.
331
+ module ResetSslMode
332
+ # Reset SSL mode is not specified.
333
+ RESET_SSL_MODE_UNSPECIFIED = 0
334
+
335
+ # Refresh all TLS configs. This is the default behaviour.
336
+ ALL = 1
337
+
338
+ # Refreshes the replication-related TLS configuration settings provided by
339
+ # the primary instance.
340
+ # Not applicable to on-premises replication instances.
341
+ SYNC_FROM_PRIMARY = 2
342
+ end
343
+ end
344
+
345
+ # Instance restart request.
346
+ # @!attribute [rw] instance
347
+ # @return [::String]
348
+ # Cloud SQL instance ID. This does not include the project ID.
349
+ # @!attribute [rw] project
350
+ # @return [::String]
351
+ # Project ID of the project that contains the instance to be restarted.
352
+ class SqlInstancesRestartRequest
353
+ include ::Google::Protobuf::MessageExts
354
+ extend ::Google::Protobuf::MessageExts::ClassMethods
355
+ end
356
+
357
+ # Instance restore backup request.
358
+ # @!attribute [rw] instance
359
+ # @return [::String]
360
+ # Cloud SQL instance ID. This does not include the project ID.
361
+ # @!attribute [rw] project
362
+ # @return [::String]
363
+ # Project ID of the project that contains the instance.
364
+ # @!attribute [rw] body
365
+ # @return [::Google::Cloud::Sql::V1::InstancesRestoreBackupRequest]
366
+ class SqlInstancesRestoreBackupRequest
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
+ end
370
+
371
+ # Instance rotate server CA request.
372
+ # @!attribute [rw] instance
373
+ # @return [::String]
374
+ # Cloud SQL instance ID. This does not include the project ID.
375
+ # @!attribute [rw] project
376
+ # @return [::String]
377
+ # Project ID of the project that contains the instance.
378
+ # @!attribute [rw] body
379
+ # @return [::Google::Cloud::Sql::V1::InstancesRotateServerCaRequest]
380
+ class SqlInstancesRotateServerCaRequest
381
+ include ::Google::Protobuf::MessageExts
382
+ extend ::Google::Protobuf::MessageExts::ClassMethods
383
+ end
384
+
385
+ # Instance rotate server certificate request.
386
+ # @!attribute [rw] instance
387
+ # @return [::String]
388
+ # Required. Cloud SQL instance ID. This does not include the project ID.
389
+ # @!attribute [rw] project
390
+ # @return [::String]
391
+ # Required. Project ID of the project that contains the instance.
392
+ # @!attribute [rw] body
393
+ # @return [::Google::Cloud::Sql::V1::InstancesRotateServerCertificateRequest]
394
+ # Optional. Rotate server certificate request body.
395
+ class SqlInstancesRotateServerCertificateRequest
396
+ include ::Google::Protobuf::MessageExts
397
+ extend ::Google::Protobuf::MessageExts::ClassMethods
398
+ end
399
+
400
+ # Instance rotate server certificate request.
401
+ # @!attribute [rw] instance
402
+ # @return [::String]
403
+ # Required. Cloud SQL instance ID. This does not include the project ID.
404
+ # @!attribute [rw] project
405
+ # @return [::String]
406
+ # Required. Project ID of the project that contains the instance.
407
+ # @!attribute [rw] body
408
+ # @return [::Google::Cloud::Sql::V1::InstancesRotateEntraIdCertificateRequest]
409
+ # Optional. Rotate Entra ID certificate request body.
410
+ class SqlInstancesRotateEntraIdCertificateRequest
411
+ include ::Google::Protobuf::MessageExts
412
+ extend ::Google::Protobuf::MessageExts::ClassMethods
413
+ end
414
+
415
+ # Instance start replica request.
416
+ # @!attribute [rw] instance
417
+ # @return [::String]
418
+ # Cloud SQL read replica instance name.
419
+ # @!attribute [rw] project
420
+ # @return [::String]
421
+ # ID of the project that contains the read replica.
422
+ class SqlInstancesStartReplicaRequest
423
+ include ::Google::Protobuf::MessageExts
424
+ extend ::Google::Protobuf::MessageExts::ClassMethods
425
+ end
426
+
427
+ # Instance stop replica request.
428
+ # @!attribute [rw] instance
429
+ # @return [::String]
430
+ # Cloud SQL read replica instance name.
431
+ # @!attribute [rw] project
432
+ # @return [::String]
433
+ # ID of the project that contains the read replica.
434
+ class SqlInstancesStopReplicaRequest
435
+ include ::Google::Protobuf::MessageExts
436
+ extend ::Google::Protobuf::MessageExts::ClassMethods
437
+ end
438
+
439
+ # Instance truncate log request.
440
+ # @!attribute [rw] instance
441
+ # @return [::String]
442
+ # Cloud SQL instance ID. This does not include the project ID.
443
+ # @!attribute [rw] project
444
+ # @return [::String]
445
+ # Project ID of the Cloud SQL project.
446
+ # @!attribute [rw] body
447
+ # @return [::Google::Cloud::Sql::V1::InstancesTruncateLogRequest]
448
+ class SqlInstancesTruncateLogRequest
449
+ include ::Google::Protobuf::MessageExts
450
+ extend ::Google::Protobuf::MessageExts::ClassMethods
451
+ end
452
+
453
+ # Instance perform disk shrink request.
454
+ # @!attribute [rw] instance
455
+ # @return [::String]
456
+ # Cloud SQL instance ID. This does not include the project ID.
457
+ # @!attribute [rw] project
458
+ # @return [::String]
459
+ # Project ID of the project that contains the instance.
460
+ # @!attribute [rw] body
461
+ # @return [::Google::Cloud::Sql::V1::PerformDiskShrinkContext]
462
+ # Perform disk shrink context.
463
+ class SqlInstancesPerformDiskShrinkRequest
464
+ include ::Google::Protobuf::MessageExts
465
+ extend ::Google::Protobuf::MessageExts::ClassMethods
466
+ end
467
+
468
+ # Instance update request.
469
+ # @!attribute [rw] instance
470
+ # @return [::String]
471
+ # Cloud SQL instance ID. This does not include the project ID.
472
+ # @!attribute [rw] project
473
+ # @return [::String]
474
+ # Project ID of the project that contains the instance.
475
+ # @!attribute [rw] body
476
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance]
477
+ class SqlInstancesUpdateRequest
478
+ include ::Google::Protobuf::MessageExts
479
+ extend ::Google::Protobuf::MessageExts::ClassMethods
480
+ end
481
+
482
+ # Instance reschedule maintenance request.
483
+ # @!attribute [rw] instance
484
+ # @return [::String]
485
+ # Cloud SQL instance ID. This does not include the project ID.
486
+ # @!attribute [rw] project
487
+ # @return [::String]
488
+ # ID of the project that contains the instance.
489
+ # @!attribute [rw] body
490
+ # @return [::Google::Cloud::Sql::V1::SqlInstancesRescheduleMaintenanceRequestBody]
491
+ class SqlInstancesRescheduleMaintenanceRequest
492
+ include ::Google::Protobuf::MessageExts
493
+ extend ::Google::Protobuf::MessageExts::ClassMethods
494
+ end
495
+
496
+ # Instance reencrypt request.
497
+ # @!attribute [rw] instance
498
+ # @return [::String]
499
+ # Cloud SQL instance ID. This does not include the project ID.
500
+ # @!attribute [rw] project
501
+ # @return [::String]
502
+ # ID of the project that contains the instance.
503
+ # @!attribute [rw] body
504
+ # @return [::Google::Cloud::Sql::V1::InstancesReencryptRequest]
505
+ # Reencrypt body that users request
506
+ class SqlInstancesReencryptRequest
507
+ include ::Google::Protobuf::MessageExts
508
+ extend ::Google::Protobuf::MessageExts::ClassMethods
509
+ end
510
+
511
+ # Database Instance reencrypt request.
512
+ # @!attribute [rw] backup_reencryption_config
513
+ # @return [::Google::Cloud::Sql::V1::BackupReencryptionConfig]
514
+ # Configuration specific to backup re-encryption
515
+ class InstancesReencryptRequest
516
+ include ::Google::Protobuf::MessageExts
517
+ extend ::Google::Protobuf::MessageExts::ClassMethods
518
+ end
519
+
520
+ # Backup Reencryption Config
521
+ # @!attribute [rw] backup_limit
522
+ # @return [::Integer]
523
+ # Backup re-encryption limit
524
+ # @!attribute [rw] backup_type
525
+ # @return [::Google::Cloud::Sql::V1::BackupReencryptionConfig::BackupType]
526
+ # Type of backups users want to re-encrypt.
527
+ class BackupReencryptionConfig
528
+ include ::Google::Protobuf::MessageExts
529
+ extend ::Google::Protobuf::MessageExts::ClassMethods
530
+
531
+ # Backup type for re-encryption
532
+ module BackupType
533
+ # Unknown backup type, will be defaulted to AUTOMATIC backup type
534
+ BACKUP_TYPE_UNSPECIFIED = 0
535
+
536
+ # Reencrypt automatic backups
537
+ AUTOMATED = 1
538
+
539
+ # Reencrypt on-demand backups
540
+ ON_DEMAND = 2
541
+ end
542
+ end
543
+
544
+ # The selected object that Cloud SQL migrates.
545
+ # @!attribute [rw] database
546
+ # @return [::String]
547
+ # The name of the database that Cloud SQL migrates.
548
+ class ExternalSyncSelectedObject
549
+ include ::Google::Protobuf::MessageExts
550
+ extend ::Google::Protobuf::MessageExts::ClassMethods
551
+ end
552
+
553
+ # Instance get disk shrink config request.
554
+ # @!attribute [rw] instance
555
+ # @return [::String]
556
+ # Cloud SQL instance ID. This does not include the project ID.
557
+ # @!attribute [rw] project
558
+ # @return [::String]
559
+ # Project ID of the project that contains the instance.
560
+ class SqlInstancesGetDiskShrinkConfigRequest
561
+ include ::Google::Protobuf::MessageExts
562
+ extend ::Google::Protobuf::MessageExts::ClassMethods
563
+ end
564
+
565
+ # Instance verify external sync settings request.
566
+ # @!attribute [rw] instance
567
+ # @return [::String]
568
+ # Cloud SQL instance ID. This does not include the project ID.
569
+ # @!attribute [rw] project
570
+ # @return [::String]
571
+ # Project ID of the project that contains the instance.
572
+ # @!attribute [rw] verify_connection_only
573
+ # @return [::Boolean]
574
+ # Flag to enable verifying connection only
575
+ # @!attribute [rw] sync_mode
576
+ # @return [::Google::Cloud::Sql::V1::SqlInstancesVerifyExternalSyncSettingsRequest::ExternalSyncMode]
577
+ # External sync mode
578
+ # @!attribute [rw] verify_replication_only
579
+ # @return [::Boolean]
580
+ # Optional. Flag to verify settings required by replication setup only
581
+ # @!attribute [rw] mysql_sync_config
582
+ # @return [::Google::Cloud::Sql::V1::MySqlSyncConfig]
583
+ # Optional. MySQL-specific settings for start external sync.
584
+ # @!attribute [rw] migration_type
585
+ # @return [::Google::Cloud::Sql::V1::SqlInstancesVerifyExternalSyncSettingsRequest::MigrationType]
586
+ # Optional. MigrationType configures the migration to use physical files or
587
+ # logical dump files. If not set, then the logical dump file configuration is
588
+ # used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.
589
+ # @!attribute [rw] sync_parallel_level
590
+ # @return [::Google::Cloud::Sql::V1::ExternalSyncParallelLevel]
591
+ # Optional. Parallel level for initial data sync. Only applicable for
592
+ # PostgreSQL.
593
+ # @!attribute [rw] selected_objects
594
+ # @return [::Array<::Google::Cloud::Sql::V1::ExternalSyncSelectedObject>]
595
+ # Optional. Migrate only the specified objects from the source instance. If
596
+ # this field is empty, then migrate all objects.
597
+ class SqlInstancesVerifyExternalSyncSettingsRequest
598
+ include ::Google::Protobuf::MessageExts
599
+ extend ::Google::Protobuf::MessageExts::ClassMethods
600
+
601
+ module ExternalSyncMode
602
+ # Unknown external sync mode, will be defaulted to ONLINE mode
603
+ EXTERNAL_SYNC_MODE_UNSPECIFIED = 0
604
+
605
+ # Online external sync will set up replication after initial data external
606
+ # sync
607
+ ONLINE = 1
608
+
609
+ # Offline external sync only dumps and loads a one-time snapshot of
610
+ # the primary instance's data
611
+ OFFLINE = 2
612
+ end
613
+
614
+ # MigrationType determines whether the migration is a physical file-based
615
+ # migration or a logical dump file-based migration.
616
+ module MigrationType
617
+ # Default value is a logical dump file-based migration
618
+ MIGRATION_TYPE_UNSPECIFIED = 0
619
+
620
+ # Logical dump file-based migration
621
+ LOGICAL = 1
622
+
623
+ # Physical file-based migration
624
+ PHYSICAL = 2
625
+ end
626
+ end
627
+
628
+ # Instance start external sync request.
629
+ # @!attribute [rw] instance
630
+ # @return [::String]
631
+ # Cloud SQL instance ID. This does not include the project ID.
632
+ # @!attribute [rw] project
633
+ # @return [::String]
634
+ # ID of the project that contains the instance.
635
+ # @!attribute [rw] sync_mode
636
+ # @return [::Google::Cloud::Sql::V1::SqlInstancesVerifyExternalSyncSettingsRequest::ExternalSyncMode]
637
+ # External sync mode.
638
+ # @!attribute [rw] skip_verification
639
+ # @return [::Boolean]
640
+ # Whether to skip the verification step (VESS).
641
+ # @!attribute [rw] mysql_sync_config
642
+ # @return [::Google::Cloud::Sql::V1::MySqlSyncConfig]
643
+ # MySQL-specific settings for start external sync.
644
+ # @!attribute [rw] sync_parallel_level
645
+ # @return [::Google::Cloud::Sql::V1::ExternalSyncParallelLevel]
646
+ # Optional. Parallel level for initial data sync. Currently only applicable
647
+ # for MySQL.
648
+ # @!attribute [rw] migration_type
649
+ # @return [::Google::Cloud::Sql::V1::SqlInstancesVerifyExternalSyncSettingsRequest::MigrationType]
650
+ # Optional. MigrationType configures the migration to use physical files or
651
+ # logical dump files. If not set, then the logical dump file configuration is
652
+ # used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.
653
+ # @!attribute [rw] replica_overwrite_enabled
654
+ # @return [::Boolean]
655
+ # Optional. MySQL only. True if end-user has confirmed that this SES call
656
+ # will wipe replica databases overlapping with the proposed selected_objects.
657
+ # If this field is not set and there are both overlapping and additional
658
+ # databases proposed, an error will be returned.
659
+ class SqlInstancesStartExternalSyncRequest
660
+ include ::Google::Protobuf::MessageExts
661
+ extend ::Google::Protobuf::MessageExts::ClassMethods
662
+ end
663
+
664
+ # Instance reset replica size request.
665
+ # @!attribute [rw] instance
666
+ # @return [::String]
667
+ # Cloud SQL read replica instance name.
668
+ # @!attribute [rw] project
669
+ # @return [::String]
670
+ # ID of the project that contains the read replica.
671
+ class SqlInstancesResetReplicaSizeRequest
672
+ include ::Google::Protobuf::MessageExts
673
+ extend ::Google::Protobuf::MessageExts::ClassMethods
674
+ end
675
+
676
+ # Instance create ephemeral certificate request.
677
+ # @!attribute [rw] instance
678
+ # @return [::String]
679
+ # Cloud SQL instance ID. This does not include the project ID.
680
+ # @!attribute [rw] project
681
+ # @return [::String]
682
+ # Project ID of the Cloud SQL project.
683
+ # @!attribute [rw] body
684
+ # @return [::Google::Cloud::Sql::V1::SslCertsCreateEphemeralRequest]
685
+ class SqlInstancesCreateEphemeralCertRequest
686
+ include ::Google::Protobuf::MessageExts
687
+ extend ::Google::Protobuf::MessageExts::ClassMethods
688
+ end
689
+
690
+ # Database instance clone request.
691
+ # @!attribute [rw] clone_context
692
+ # @return [::Google::Cloud::Sql::V1::CloneContext]
693
+ # Required. Contains details about the clone operation.
694
+ class InstancesCloneRequest
695
+ include ::Google::Protobuf::MessageExts
696
+ extend ::Google::Protobuf::MessageExts::ClassMethods
697
+ end
698
+
699
+ # Database demote primary instance request.
700
+ # @!attribute [rw] demote_master_context
701
+ # @return [::Google::Cloud::Sql::V1::DemoteMasterContext]
702
+ # Contains details about the demoteMaster operation.
703
+ class InstancesDemoteMasterRequest
704
+ include ::Google::Protobuf::MessageExts
705
+ extend ::Google::Protobuf::MessageExts::ClassMethods
706
+ end
707
+
708
+ # This request is used to demote an existing standalone instance to be a
709
+ # Cloud SQL read replica for an external database server.
710
+ # @!attribute [rw] demote_context
711
+ # @return [::Google::Cloud::Sql::V1::DemoteContext]
712
+ # Required. Contains details about the demote operation.
713
+ class InstancesDemoteRequest
714
+ include ::Google::Protobuf::MessageExts
715
+ extend ::Google::Protobuf::MessageExts::ClassMethods
716
+ end
717
+
718
+ # Database instance export request.
719
+ # @!attribute [rw] export_context
720
+ # @return [::Google::Cloud::Sql::V1::ExportContext]
721
+ # Contains details about the export operation.
722
+ class InstancesExportRequest
723
+ include ::Google::Protobuf::MessageExts
724
+ extend ::Google::Protobuf::MessageExts::ClassMethods
725
+ end
726
+
727
+ # Instance failover request.
728
+ # @!attribute [rw] failover_context
729
+ # @return [::Google::Cloud::Sql::V1::FailoverContext]
730
+ # Failover Context.
731
+ class InstancesFailoverRequest
732
+ include ::Google::Protobuf::MessageExts
733
+ extend ::Google::Protobuf::MessageExts::ClassMethods
734
+ end
735
+
736
+ # SslCerts create ephemeral certificate request.
737
+ # @!attribute [rw] public_key
738
+ # @return [::String]
739
+ # PEM encoded public key to include in the signed certificate.
740
+ # @!attribute [rw] access_token
741
+ # @return [::String]
742
+ # Access token to include in the signed certificate.
743
+ class SslCertsCreateEphemeralRequest
744
+ include ::Google::Protobuf::MessageExts
745
+ extend ::Google::Protobuf::MessageExts::ClassMethods
746
+ end
747
+
748
+ # Database instance import request.
749
+ # @!attribute [rw] import_context
750
+ # @return [::Google::Cloud::Sql::V1::ImportContext]
751
+ # Contains details about the import operation.
752
+ class InstancesImportRequest
753
+ include ::Google::Protobuf::MessageExts
754
+ extend ::Google::Protobuf::MessageExts::ClassMethods
755
+ end
756
+
757
+ # Request for Pre-checks for MVU
758
+ # @!attribute [rw] pre_check_major_version_upgrade_context
759
+ # @return [::Google::Cloud::Sql::V1::PreCheckMajorVersionUpgradeContext]
760
+ # Required. Contains details about the pre-check major version upgrade
761
+ # operation.
762
+ class InstancesPreCheckMajorVersionUpgradeRequest
763
+ include ::Google::Protobuf::MessageExts
764
+ extend ::Google::Protobuf::MessageExts::ClassMethods
765
+ end
766
+
767
+ # Database instances list response.
768
+ # @!attribute [rw] kind
769
+ # @return [::String]
770
+ # This is always `sql#instancesList`.
771
+ # @!attribute [rw] warnings
772
+ # @return [::Array<::Google::Cloud::Sql::V1::ApiWarning>]
773
+ # List of warnings that occurred while handling the request.
774
+ # @!attribute [rw] items
775
+ # @return [::Array<::Google::Cloud::Sql::V1::DatabaseInstance>]
776
+ # List of database instance resources.
777
+ # @!attribute [rw] next_page_token
778
+ # @return [::String]
779
+ # The continuation token, used to page through large result sets. Provide
780
+ # this value in a subsequent request to return the next page of results.
781
+ class InstancesListResponse
782
+ include ::Google::Protobuf::MessageExts
783
+ extend ::Google::Protobuf::MessageExts::ClassMethods
784
+ end
785
+
786
+ # Instances ListServerCas response.
787
+ # @!attribute [rw] certs
788
+ # @return [::Array<::Google::Cloud::Sql::V1::SslCert>]
789
+ # List of server CA certificates for the instance.
790
+ # @!attribute [rw] active_version
791
+ # @return [::String]
792
+ # @!attribute [rw] kind
793
+ # @return [::String]
794
+ # This is always `sql#instancesListServerCas`.
795
+ class InstancesListServerCasResponse
796
+ include ::Google::Protobuf::MessageExts
797
+ extend ::Google::Protobuf::MessageExts::ClassMethods
798
+ end
799
+
800
+ # Instances ListServerCertificates response.
801
+ # @!attribute [rw] ca_certs
802
+ # @return [::Array<::Google::Cloud::Sql::V1::SslCert>]
803
+ # List of server CA certificates for the instance.
804
+ # @!attribute [rw] server_certs
805
+ # @return [::Array<::Google::Cloud::Sql::V1::SslCert>]
806
+ # List of server certificates for the instance, signed by the corresponding
807
+ # CA from the `ca_certs` list.
808
+ # @!attribute [rw] active_version
809
+ # @return [::String]
810
+ # The `sha1_fingerprint` of the active certificate from `server_certs`.
811
+ # @!attribute [rw] kind
812
+ # @return [::String]
813
+ # This is always `sql#instancesListServerCertificates`.
814
+ class InstancesListServerCertificatesResponse
815
+ include ::Google::Protobuf::MessageExts
816
+ extend ::Google::Protobuf::MessageExts::ClassMethods
817
+ end
818
+
819
+ # Instances ListEntraIdCertificates response.
820
+ # @!attribute [rw] certs
821
+ # @return [::Array<::Google::Cloud::Sql::V1::SslCert>]
822
+ # List of Entra ID certificates for the instance.
823
+ # @!attribute [rw] active_version
824
+ # @return [::String]
825
+ # The `sha1_fingerprint` of the active certificate from `certs`.
826
+ # @!attribute [rw] kind
827
+ # @return [::String]
828
+ # This is always `sql#instancesListEntraIdCertificates`.
829
+ class InstancesListEntraIdCertificatesResponse
830
+ include ::Google::Protobuf::MessageExts
831
+ extend ::Google::Protobuf::MessageExts::ClassMethods
832
+ end
833
+
834
+ # Database instance restore backup request.
835
+ # @!attribute [rw] restore_backup_context
836
+ # @return [::Google::Cloud::Sql::V1::RestoreBackupContext]
837
+ # Parameters required to perform the restore backup operation.
838
+ # @!attribute [rw] backup
839
+ # @return [::String]
840
+ # The name of the backup that's used to restore a Cloud SQL instance:
841
+ # Format: projects/\\{project-id}/backups/\\{backup-uid}. Only one of
842
+ # restore_backup_context, backup, backupdr_backup can be passed to the input.
843
+ # @!attribute [rw] backupdr_backup
844
+ # @return [::String]
845
+ # The name of the backup that's used to restore a Cloud SQL instance:
846
+ # Format:
847
+ # "projects/\\{project-id}/locations/\\{location}/backupVaults/\\{backupvault}/dataSources/\\{datasource}/backups/\\{backup-uid}".
848
+ # Only one of restore_backup_context, backup, backupdr_backup can be
849
+ # passed to the input.
850
+ # @!attribute [rw] restore_instance_settings
851
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance]
852
+ # Optional. By using this parameter, Cloud SQL overrides any instance
853
+ # settings stored in the backup you are restoring from. You can't change the
854
+ # instance's major database version and you can only increase the disk size.
855
+ # You can use this field to restore new instances only. This field is not
856
+ # applicable for restore to existing instances.
857
+ # @!attribute [rw] restore_instance_clear_overrides_field_names
858
+ # @return [::Array<::String>]
859
+ # Optional. This field has the same purpose as restore_instance_settings,
860
+ # changes any instance settings stored in the backup you are restoring from.
861
+ # With the difference that these fields are cleared in the settings.
862
+ class InstancesRestoreBackupRequest
863
+ include ::Google::Protobuf::MessageExts
864
+ extend ::Google::Protobuf::MessageExts::ClassMethods
865
+ end
866
+
867
+ # Rotate server CA request.
868
+ # @!attribute [rw] rotate_server_ca_context
869
+ # @return [::Google::Cloud::Sql::V1::RotateServerCaContext]
870
+ # Contains details about the rotate server CA operation.
871
+ class InstancesRotateServerCaRequest
872
+ include ::Google::Protobuf::MessageExts
873
+ extend ::Google::Protobuf::MessageExts::ClassMethods
874
+ end
875
+
876
+ # Rotate server certificate request.
877
+ # @!attribute [rw] rotate_server_certificate_context
878
+ # @return [::Google::Cloud::Sql::V1::RotateServerCertificateContext]
879
+ # Optional. Contains details about the rotate server certificate operation.
880
+ class InstancesRotateServerCertificateRequest
881
+ include ::Google::Protobuf::MessageExts
882
+ extend ::Google::Protobuf::MessageExts::ClassMethods
883
+ end
884
+
885
+ # Rotate Entra ID certificate request.
886
+ # @!attribute [rw] rotate_entra_id_certificate_context
887
+ # @return [::Google::Cloud::Sql::V1::RotateEntraIdCertificateContext]
888
+ # Optional. Contains details about the rotate server certificate operation.
889
+ class InstancesRotateEntraIdCertificateRequest
890
+ include ::Google::Protobuf::MessageExts
891
+ extend ::Google::Protobuf::MessageExts::ClassMethods
892
+ end
893
+
894
+ # Instance truncate log request.
895
+ # @!attribute [rw] truncate_log_context
896
+ # @return [::Google::Cloud::Sql::V1::TruncateLogContext]
897
+ # Contains details about the truncate log operation.
898
+ class InstancesTruncateLogRequest
899
+ include ::Google::Protobuf::MessageExts
900
+ extend ::Google::Protobuf::MessageExts::ClassMethods
901
+ end
902
+
903
+ # Request to acquire a lease for SSRS.
904
+ # @!attribute [rw] acquire_ssrs_lease_context
905
+ # @return [::Google::Cloud::Sql::V1::AcquireSsrsLeaseContext]
906
+ # Contains details about the acquire SSRS lease operation.
907
+ class InstancesAcquireSsrsLeaseRequest
908
+ include ::Google::Protobuf::MessageExts
909
+ extend ::Google::Protobuf::MessageExts::ClassMethods
910
+ end
911
+
912
+ # Request for Pre-checks for MVU
913
+ # @!attribute [rw] instance
914
+ # @return [::String]
915
+ # Required. Cloud SQL instance ID. This does not include the project ID.
916
+ # @!attribute [rw] project
917
+ # @return [::String]
918
+ # Required. Project ID of the project that contains the instance.
919
+ # @!attribute [rw] body
920
+ # @return [::Google::Cloud::Sql::V1::InstancesPreCheckMajorVersionUpgradeRequest]
921
+ # Required. The context for request to perform the pre-check major version
922
+ # upgrade operation.
923
+ class SqlInstancesPreCheckMajorVersionUpgradeRequest
924
+ include ::Google::Protobuf::MessageExts
925
+ extend ::Google::Protobuf::MessageExts::ClassMethods
926
+ end
927
+
928
+ # Instance verify external sync settings response.
929
+ # @!attribute [rw] kind
930
+ # @return [::String]
931
+ # This is always `sql#migrationSettingErrorList`.
932
+ # @!attribute [rw] errors
933
+ # @return [::Array<::Google::Cloud::Sql::V1::SqlExternalSyncSettingError>]
934
+ # List of migration violations.
935
+ # @!attribute [rw] warnings
936
+ # @return [::Array<::Google::Cloud::Sql::V1::SqlExternalSyncSettingError>]
937
+ # List of migration warnings.
938
+ class SqlInstancesVerifyExternalSyncSettingsResponse
939
+ include ::Google::Protobuf::MessageExts
940
+ extend ::Google::Protobuf::MessageExts::ClassMethods
941
+ end
942
+
943
+ # Instance get disk shrink config response.
944
+ # @!attribute [rw] kind
945
+ # @return [::String]
946
+ # This is always `sql#getDiskShrinkConfig`.
947
+ # @!attribute [rw] minimal_target_size_gb
948
+ # @return [::Integer]
949
+ # The minimum size to which a disk can be shrunk in GigaBytes.
950
+ # @!attribute [rw] message
951
+ # @return [::String]
952
+ # Additional message to customers.
953
+ class SqlInstancesGetDiskShrinkConfigResponse
954
+ include ::Google::Protobuf::MessageExts
955
+ extend ::Google::Protobuf::MessageExts::ClassMethods
956
+ end
957
+
958
+ # Instance get latest recovery time request.
959
+ # @!attribute [rw] instance
960
+ # @return [::String]
961
+ # Cloud SQL instance ID. This does not include the project ID.
962
+ # @!attribute [rw] project
963
+ # @return [::String]
964
+ # Project ID of the project that contains the instance.
965
+ # @!attribute [rw] source_instance_deletion_time
966
+ # @return [::Google::Protobuf::Timestamp]
967
+ # The timestamp used to identify the time when the source instance is
968
+ # deleted. If this instance is deleted, then you must set the timestamp.
969
+ class SqlInstancesGetLatestRecoveryTimeRequest
970
+ include ::Google::Protobuf::MessageExts
971
+ extend ::Google::Protobuf::MessageExts::ClassMethods
972
+ end
973
+
974
+ # Instance get latest recovery time response.
975
+ # @!attribute [rw] kind
976
+ # @return [::String]
977
+ # This is always `sql#getLatestRecoveryTime`.
978
+ # @!attribute [rw] latest_recovery_time
979
+ # @return [::Google::Protobuf::Timestamp]
980
+ # Timestamp, identifies the latest recovery time of the source instance.
981
+ # @!attribute [rw] earliest_recovery_time
982
+ # @return [::Google::Protobuf::Timestamp]
983
+ # Timestamp, identifies the earliest recovery time of the source instance.
984
+ class SqlInstancesGetLatestRecoveryTimeResponse
985
+ include ::Google::Protobuf::MessageExts
986
+ extend ::Google::Protobuf::MessageExts::ClassMethods
987
+ end
988
+
989
+ # Database instance clone context.
990
+ # @!attribute [rw] kind
991
+ # @return [::String]
992
+ # This is always `sql#cloneContext`.
993
+ # @!attribute [rw] pitr_timestamp_ms
994
+ # @return [::Integer]
995
+ # Reserved for future use.
996
+ # @!attribute [rw] destination_instance_name
997
+ # @return [::String]
998
+ # Required. Name of the Cloud SQL instance to be created as a clone.
999
+ # @!attribute [rw] bin_log_coordinates
1000
+ # @return [::Google::Cloud::Sql::V1::BinLogCoordinates]
1001
+ # Binary log coordinates, if specified, identify the position up to which the
1002
+ # source instance is cloned. If not specified, the source instance is
1003
+ # cloned up to the most recent binary log coordinates.
1004
+ # @!attribute [rw] point_in_time
1005
+ # @return [::Google::Protobuf::Timestamp]
1006
+ # Timestamp, if specified, identifies the time to which the source instance
1007
+ # is cloned.
1008
+ # @!attribute [rw] allocated_ip_range
1009
+ # @return [::String]
1010
+ # The name of the allocated ip range for the private ip Cloud SQL instance.
1011
+ # For example: "google-managed-services-default". If set, the cloned instance
1012
+ # ip will be created in the allocated range. The range name must comply with
1013
+ # [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name
1014
+ # must be 1-63 characters long and match the regular expression
1015
+ # [a-z]([-a-z0-9]*[a-z0-9])?.
1016
+ # Reserved for future use.
1017
+ # @!attribute [rw] database_names
1018
+ # @return [::Array<::String>]
1019
+ # (SQL Server only) Clone only the specified databases from the source
1020
+ # instance. Clone all databases if empty.
1021
+ # @!attribute [rw] preferred_zone
1022
+ # @return [::String]
1023
+ # Optional. Copy clone and point-in-time recovery clone of an instance to the
1024
+ # specified zone. If no zone is specified, clone to the same primary zone as
1025
+ # the source instance. This field applies to all DB types.
1026
+ # @!attribute [rw] preferred_secondary_zone
1027
+ # @return [::String]
1028
+ # Optional. Copy clone and point-in-time recovery clone of a regional
1029
+ # instance in the specified zones. If not specified, clone to the same
1030
+ # secondary zone as the source instance. This value cannot be the same as the
1031
+ # preferred_zone field. This field applies to all DB types.
1032
+ # @!attribute [rw] source_instance_deletion_time
1033
+ # @return [::Google::Protobuf::Timestamp]
1034
+ # The timestamp used to identify the time when the source instance is
1035
+ # deleted. If this instance is deleted, then you must set the timestamp.
1036
+ # @!attribute [rw] destination_project
1037
+ # @return [::String]
1038
+ # Optional. The project ID of the destination project where the cloned
1039
+ # instance will be created. To perform a cross-project clone, this field is
1040
+ # required. If not specified, the clone is created in the same project
1041
+ # as the source instance.
1042
+ # @!attribute [rw] destination_network
1043
+ # @return [::String]
1044
+ # Optional. The fully qualified URI of the VPC network to which the cloned
1045
+ # instance will be connected via Private Services Access for private IP. For
1046
+ # example:`projects/my-network-project/global/networks/my-network`. This
1047
+ # field is only required for cross-project cloning.
1048
+ class CloneContext
1049
+ include ::Google::Protobuf::MessageExts
1050
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1051
+ end
1052
+
1053
+ # The context to perform a point-in-time recovery of an instance managed by
1054
+ # Backup and Disaster Recovery (DR) Service.
1055
+ # @!attribute [rw] datasource
1056
+ # @return [::String]
1057
+ # The Backup and Disaster Recovery (DR) Service Datasource URI.
1058
+ # Format:
1059
+ # projects/\\{project}/locations/\\{region}/backupVaults/\\{backupvault}/dataSources/\\{datasource}.
1060
+ # @!attribute [rw] point_in_time
1061
+ # @return [::Google::Protobuf::Timestamp]
1062
+ # Required. The date and time to which you want to restore the instance.
1063
+ # @!attribute [rw] target_instance
1064
+ # @return [::String]
1065
+ # Target instance name.
1066
+ # @!attribute [rw] private_network
1067
+ # @return [::String]
1068
+ # Optional. The resource link for the VPC network from which the Cloud SQL
1069
+ # instance is accessible for private IP. For example,
1070
+ # `/projects/myProject/global/networks/default`.
1071
+ # @!attribute [rw] allocated_ip_range
1072
+ # @return [::String]
1073
+ # Optional. The name of the allocated IP range for the internal IP Cloud SQL
1074
+ # instance. For example: "google-managed-services-default". If you set this,
1075
+ # then Cloud SQL creates the IP address for the cloned instance in the
1076
+ # allocated range. This range must comply with [RFC
1077
+ # 1035](https://tools.ietf.org/html/rfc1035) standards. Specifically, the
1078
+ # name must be 1-63 characters long and match the regular expression
1079
+ # [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use.
1080
+ # @!attribute [rw] preferred_zone
1081
+ # @return [::String]
1082
+ # Optional. Point-in-time recovery of an instance to the specified zone. If
1083
+ # no zone is specified, then clone to the same primary zone as the source
1084
+ # instance.
1085
+ # @!attribute [rw] preferred_secondary_zone
1086
+ # @return [::String]
1087
+ # Optional. Point-in-time recovery of a regional instance in the specified
1088
+ # zones. If not specified, clone to the same secondary zone as the source
1089
+ # instance. This value cannot be the same as the preferred_zone field.
1090
+ # @!attribute [rw] target_instance_settings
1091
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance]
1092
+ # Optional. Specifies the instance settings that will be overridden from the
1093
+ # source instance. This field is only applicable for cross project PITRs.
1094
+ # @!attribute [rw] target_instance_clear_settings_field_names
1095
+ # @return [::Array<::String>]
1096
+ # Optional. Specifies the instance settings that will be cleared from the
1097
+ # source instance. This field is only applicable for cross project PITRs.
1098
+ # @!attribute [rw] region
1099
+ # @return [::String]
1100
+ # Optional. The region of the target instance where the datasource will be
1101
+ # restored. For example: "us-central1".
1102
+ class PointInTimeRestoreContext
1103
+ include ::Google::Protobuf::MessageExts
1104
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1105
+ end
1106
+
1107
+ # Binary log coordinates.
1108
+ # @!attribute [rw] bin_log_file_name
1109
+ # @return [::String]
1110
+ # Name of the binary log file for a Cloud SQL instance.
1111
+ # @!attribute [rw] bin_log_position
1112
+ # @return [::Integer]
1113
+ # Position (offset) within the binary log file.
1114
+ # @!attribute [rw] kind
1115
+ # @return [::String]
1116
+ # This is always `sql#binLogCoordinates`.
1117
+ class BinLogCoordinates
1118
+ include ::Google::Protobuf::MessageExts
1119
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1120
+ end
1121
+
1122
+ # A Cloud SQL instance resource.
1123
+ # @!attribute [rw] kind
1124
+ # @return [::String]
1125
+ # This is always `sql#instance`.
1126
+ # @!attribute [rw] state
1127
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance::SqlInstanceState]
1128
+ # The current serving state of the Cloud SQL instance.
1129
+ # @!attribute [rw] database_version
1130
+ # @return [::Google::Cloud::Sql::V1::SqlDatabaseVersion]
1131
+ # The database engine type and version. The `databaseVersion` field cannot
1132
+ # be changed after instance creation.
1133
+ # @!attribute [rw] settings
1134
+ # @return [::Google::Cloud::Sql::V1::Settings]
1135
+ # The user settings.
1136
+ # @!attribute [rw] etag
1137
+ # @return [::String]
1138
+ # This field is deprecated and will be removed from a future version of the
1139
+ # API. Use the `settings.settingsVersion` field instead.
1140
+ # @!attribute [rw] failover_replica
1141
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance::SqlFailoverReplica]
1142
+ # The name and status of the failover replica.
1143
+ # @!attribute [rw] master_instance_name
1144
+ # @return [::String]
1145
+ # The name of the instance which will act as primary in the replication
1146
+ # setup.
1147
+ # @!attribute [rw] replica_names
1148
+ # @return [::Array<::String>]
1149
+ # The replicas of the instance.
1150
+ # @!attribute [rw] max_disk_size
1151
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1152
+ # @return [::Google::Protobuf::Int64Value]
1153
+ # The maximum disk size of the instance in bytes.
1154
+ # @!attribute [rw] current_disk_size
1155
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1156
+ # @return [::Google::Protobuf::Int64Value]
1157
+ # The current disk usage of the instance in bytes. This property has been
1158
+ # deprecated. Use the
1159
+ # "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud
1160
+ # Monitoring API instead. Please see [this
1161
+ # announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ)
1162
+ # for details.
1163
+ # @!attribute [rw] ip_addresses
1164
+ # @return [::Array<::Google::Cloud::Sql::V1::IpMapping>]
1165
+ # The assigned IP addresses for the instance.
1166
+ # @!attribute [rw] server_ca_cert
1167
+ # @return [::Google::Cloud::Sql::V1::SslCert]
1168
+ # SSL configuration.
1169
+ # @!attribute [rw] instance_type
1170
+ # @return [::Google::Cloud::Sql::V1::SqlInstanceType]
1171
+ # The instance type.
1172
+ # @!attribute [rw] project
1173
+ # @return [::String]
1174
+ # The project ID of the project containing the Cloud SQL instance. The Google
1175
+ # apps domain is prefixed if applicable.
1176
+ # @!attribute [rw] ipv6_address
1177
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1178
+ # @return [::String]
1179
+ # The IPv6 address assigned to the instance.
1180
+ # (Deprecated) This property was applicable only
1181
+ # to First Generation instances.
1182
+ # @!attribute [rw] service_account_email_address
1183
+ # @return [::String]
1184
+ # The service account email address assigned to the instance.\This
1185
+ # property is read-only.
1186
+ # @!attribute [rw] on_premises_configuration
1187
+ # @return [::Google::Cloud::Sql::V1::OnPremisesConfiguration]
1188
+ # Configuration specific to on-premises instances.
1189
+ # @!attribute [rw] replica_configuration
1190
+ # @return [::Google::Cloud::Sql::V1::ReplicaConfiguration]
1191
+ # Configuration specific to failover replicas and read replicas.
1192
+ # @!attribute [rw] backend_type
1193
+ # @return [::Google::Cloud::Sql::V1::SqlBackendType]
1194
+ # The backend type.
1195
+ # `SECOND_GEN`: Cloud SQL database instance.
1196
+ # `EXTERNAL`: A database server that is not managed by Google.
1197
+ #
1198
+ # This property is read-only; use the `tier` property in the `settings`
1199
+ # object to determine the database type.
1200
+ # @!attribute [rw] self_link
1201
+ # @return [::String]
1202
+ # The URI of this resource.
1203
+ # @!attribute [rw] suspension_reason
1204
+ # @return [::Array<::Google::Cloud::Sql::V1::SqlSuspensionReason>]
1205
+ # If the instance state is SUSPENDED, the reason for the suspension.
1206
+ # @!attribute [rw] connection_name
1207
+ # @return [::String]
1208
+ # Connection name of the Cloud SQL instance used in connection strings.
1209
+ # @!attribute [rw] name
1210
+ # @return [::String]
1211
+ # Name of the Cloud SQL instance. This does not include the project ID.
1212
+ # @!attribute [rw] region
1213
+ # @return [::String]
1214
+ # The geographical region of the Cloud SQL instance.
1215
+ #
1216
+ # It can be one of the
1217
+ # [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r)
1218
+ # where Cloud SQL operates:
1219
+ #
1220
+ # For example, `asia-east1`, `europe-west1`, and `us-central1`.
1221
+ # The default value is `us-central1`.
1222
+ # @!attribute [rw] gce_zone
1223
+ # @return [::String]
1224
+ # The Compute Engine zone that the instance is currently serving from. This
1225
+ # value could be different from the zone that was specified when the instance
1226
+ # was created if the instance has failed over to its secondary zone. WARNING:
1227
+ # Changing this might restart the instance.
1228
+ # @!attribute [rw] secondary_gce_zone
1229
+ # @return [::String]
1230
+ # The Compute Engine zone that the failover instance is currently serving
1231
+ # from for a regional instance. This value could be different
1232
+ # from the zone that was specified when the instance
1233
+ # was created if the instance has failed over to its secondary/failover zone.
1234
+ # @!attribute [rw] disk_encryption_configuration
1235
+ # @return [::Google::Cloud::Sql::V1::DiskEncryptionConfiguration]
1236
+ # Disk encryption configuration specific to an instance.
1237
+ # @!attribute [rw] disk_encryption_status
1238
+ # @return [::Google::Cloud::Sql::V1::DiskEncryptionStatus]
1239
+ # Disk encryption status specific to an instance.
1240
+ # @!attribute [rw] root_password
1241
+ # @return [::String]
1242
+ # Initial root password. Use only on creation. You must set root passwords
1243
+ # before you can connect to PostgreSQL instances.
1244
+ # @!attribute [rw] scheduled_maintenance
1245
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance::SqlScheduledMaintenance]
1246
+ # The start time of any upcoming scheduled maintenance for this instance.
1247
+ # @!attribute [rw] satisfies_pzs
1248
+ # @return [::Google::Protobuf::BoolValue]
1249
+ # This status indicates whether the instance satisfies PZS.
1250
+ #
1251
+ # The status is reserved for future use.
1252
+ # @!attribute [r] database_installed_version
1253
+ # @return [::String]
1254
+ # Output only. Stores the current database version running on the instance
1255
+ # including minor version such as `MYSQL_8_0_18`.
1256
+ # @!attribute [rw] out_of_disk_report
1257
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance::SqlOutOfDiskReport]
1258
+ # This field represents the report generated by the proactive database
1259
+ # wellness job for OutOfDisk issues.
1260
+ # * Writers:
1261
+ # * the proactive database wellness job for OOD.
1262
+ # * Readers:
1263
+ # * the proactive database wellness job
1264
+ # @!attribute [r] create_time
1265
+ # @return [::Google::Protobuf::Timestamp]
1266
+ # Output only. The time when the instance was created in
1267
+ # [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example
1268
+ # `2012-11-15T16:19:00.094Z`.
1269
+ # @!attribute [r] available_maintenance_versions
1270
+ # @return [::Array<::String>]
1271
+ # Output only. List all maintenance versions applicable on the instance
1272
+ # @!attribute [rw] maintenance_version
1273
+ # @return [::String]
1274
+ # The current software version on the instance.
1275
+ # @!attribute [r] upgradable_database_versions
1276
+ # @return [::Array<::Google::Cloud::Sql::V1::AvailableDatabaseVersion>]
1277
+ # Output only. All database versions that are available for upgrade.
1278
+ # @!attribute [rw] sql_network_architecture
1279
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance::SqlNetworkArchitecture]
1280
+ # @!attribute [r] psc_service_attachment_link
1281
+ # @return [::String]
1282
+ # Output only. The link to service attachment of PSC instance.
1283
+ # @!attribute [r] dns_name
1284
+ # @return [::String]
1285
+ # Output only. The dns name of the instance.
1286
+ # @!attribute [r] primary_dns_name
1287
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1288
+ # @return [::String]
1289
+ # Output only. DEPRECATED: please use write_endpoint instead.
1290
+ # @!attribute [r] write_endpoint
1291
+ # @return [::String]
1292
+ # Output only. The dns name of the primary instance in a replication group.
1293
+ # @!attribute [rw] replication_cluster
1294
+ # @return [::Google::Cloud::Sql::V1::ReplicationCluster]
1295
+ # Optional. A primary instance and disaster recovery (DR) replica pair.
1296
+ # A DR replica is a cross-region replica that you designate
1297
+ # for failover in the event that the primary instance
1298
+ # experiences regional failure.
1299
+ # Applicable to MySQL and PostgreSQL.
1300
+ # @!attribute [rw] gemini_config
1301
+ # @return [::Google::Cloud::Sql::V1::GeminiInstanceConfig]
1302
+ # Gemini instance configuration.
1303
+ # @!attribute [r] satisfies_pzi
1304
+ # @return [::Google::Protobuf::BoolValue]
1305
+ # Output only. This status indicates whether the instance satisfies PZI.
1306
+ #
1307
+ # The status is reserved for future use.
1308
+ # @!attribute [rw] switch_transaction_logs_to_cloud_storage_enabled
1309
+ # @return [::Google::Protobuf::BoolValue]
1310
+ # Input only. Whether Cloud SQL is enabled to switch storing point-in-time
1311
+ # recovery log files from a data disk to Cloud Storage.
1312
+ # @!attribute [rw] include_replicas_for_major_version_upgrade
1313
+ # @return [::Google::Protobuf::BoolValue]
1314
+ # Input only. Determines whether an in-place major version upgrade of
1315
+ # replicas happens when an in-place major version upgrade of a primary
1316
+ # instance is initiated.
1317
+ # @!attribute [rw] tags
1318
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1319
+ # Optional. Input only. Immutable. Tag keys and tag values that are bound to
1320
+ # this instance. You must represent each item in the map as:
1321
+ # `"<tag-key-namespaced-name>" : "<tag-value-short-name>"`.
1322
+ #
1323
+ # For example, a single resource can have the following tags:
1324
+ # ```
1325
+ # "123/environment": "production",
1326
+ # "123/costCenter": "marketing",
1327
+ # ```
1328
+ #
1329
+ # For more information on tag creation and management, see
1330
+ # https://cloud.google.com/resource-manager/docs/tags/tags-overview.
1331
+ # @!attribute [rw] node_count
1332
+ # @return [::Integer]
1333
+ # The number of read pool nodes in a read pool.
1334
+ # @!attribute [r] nodes
1335
+ # @return [::Array<::Google::Cloud::Sql::V1::DatabaseInstance::PoolNodeConfig>]
1336
+ # Output only. Entries containing information about each read pool node of
1337
+ # the read pool.
1338
+ # @!attribute [r] dns_names
1339
+ # @return [::Array<::Google::Cloud::Sql::V1::DnsNameMapping>]
1340
+ # Output only. The list of DNS names used by this instance.
1341
+ class DatabaseInstance
1342
+ include ::Google::Protobuf::MessageExts
1343
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1344
+
1345
+ # @!attribute [rw] name
1346
+ # @return [::String]
1347
+ # The name of the failover replica. If specified at instance creation, a
1348
+ # failover replica is created for the instance. The name
1349
+ # doesn't include the project ID.
1350
+ # @!attribute [rw] available
1351
+ # @return [::Google::Protobuf::BoolValue]
1352
+ # The availability status of the failover replica. A false status indicates
1353
+ # that the failover replica is out of sync. The primary instance can only
1354
+ # failover to the failover replica when the status is true.
1355
+ class SqlFailoverReplica
1356
+ include ::Google::Protobuf::MessageExts
1357
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1358
+ end
1359
+
1360
+ # Any scheduled maintenance for this instance.
1361
+ # @!attribute [rw] start_time
1362
+ # @return [::Google::Protobuf::Timestamp]
1363
+ # The start time of any upcoming scheduled maintenance for this instance.
1364
+ # @!attribute [rw] can_defer
1365
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1366
+ # @return [::Boolean]
1367
+ # @!attribute [rw] can_reschedule
1368
+ # @return [::Boolean]
1369
+ # If the scheduled maintenance can be rescheduled.
1370
+ # @!attribute [rw] schedule_deadline_time
1371
+ # @return [::Google::Protobuf::Timestamp]
1372
+ # Maintenance cannot be rescheduled to start beyond this deadline.
1373
+ class SqlScheduledMaintenance
1374
+ include ::Google::Protobuf::MessageExts
1375
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1376
+ end
1377
+
1378
+ # This message wraps up the information written by out-of-disk detection job.
1379
+ # @!attribute [rw] sql_out_of_disk_state
1380
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance::SqlOutOfDiskReport::SqlOutOfDiskState]
1381
+ # This field represents the state generated by the proactive database
1382
+ # wellness job for OutOfDisk issues.
1383
+ # * Writers:
1384
+ # * the proactive database wellness job for OOD.
1385
+ # * Readers:
1386
+ # * the proactive database wellness job
1387
+ # @!attribute [rw] sql_min_recommended_increase_size_gb
1388
+ # @return [::Integer]
1389
+ # The minimum recommended increase size in GigaBytes
1390
+ # This field is consumed by the frontend
1391
+ # * Writers:
1392
+ # * the proactive database wellness job for OOD.
1393
+ # * Readers:
1394
+ class SqlOutOfDiskReport
1395
+ include ::Google::Protobuf::MessageExts
1396
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1397
+
1398
+ # This enum lists all possible states regarding out-of-disk issues.
1399
+ module SqlOutOfDiskState
1400
+ # Unspecified state
1401
+ SQL_OUT_OF_DISK_STATE_UNSPECIFIED = 0
1402
+
1403
+ # The instance has plenty space on data disk
1404
+ NORMAL = 1
1405
+
1406
+ # Data disk is almost used up. It is shutdown to prevent data
1407
+ # corruption.
1408
+ SOFT_SHUTDOWN = 2
1409
+ end
1410
+ end
1411
+
1412
+ # Details of a single read pool node of a read pool.
1413
+ # @!attribute [r] name
1414
+ # @return [::String]
1415
+ # Output only. The name of the read pool node, to be used for retrieving
1416
+ # metrics and logs.
1417
+ # @!attribute [r] gce_zone
1418
+ # @return [::String]
1419
+ # Output only. The zone of the read pool node.
1420
+ # @!attribute [r] ip_addresses
1421
+ # @return [::Array<::Google::Cloud::Sql::V1::IpMapping>]
1422
+ # Output only. Mappings containing IP addresses that can be used to connect
1423
+ # to the read pool node.
1424
+ # @!attribute [r] dns_name
1425
+ # @return [::String]
1426
+ # Output only. The DNS name of the read pool node.
1427
+ # @!attribute [r] state
1428
+ # @return [::Google::Cloud::Sql::V1::DatabaseInstance::SqlInstanceState]
1429
+ # Output only. The current state of the read pool node.
1430
+ # @!attribute [r] dns_names
1431
+ # @return [::Array<::Google::Cloud::Sql::V1::DnsNameMapping>]
1432
+ # Output only. The list of DNS names used by this read pool node.
1433
+ # @!attribute [r] psc_service_attachment_link
1434
+ # @return [::String]
1435
+ # Output only. The Private Service Connect (PSC) service attachment of the
1436
+ # read pool node.
1437
+ # @!attribute [r] psc_auto_connections
1438
+ # @return [::Array<::Google::Cloud::Sql::V1::PscAutoConnectionConfig>]
1439
+ # Output only. The list of settings for requested automatically-setup
1440
+ # Private Service Connect (PSC) consumer endpoints that can be used to
1441
+ # connect to this read pool node.
1442
+ class PoolNodeConfig
1443
+ include ::Google::Protobuf::MessageExts
1444
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1445
+ end
1446
+
1447
+ # @!attribute [rw] key
1448
+ # @return [::String]
1449
+ # @!attribute [rw] value
1450
+ # @return [::String]
1451
+ class TagsEntry
1452
+ include ::Google::Protobuf::MessageExts
1453
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1454
+ end
1455
+
1456
+ # The current serving state of the database instance.
1457
+ module SqlInstanceState
1458
+ # The state of the instance is unknown.
1459
+ SQL_INSTANCE_STATE_UNSPECIFIED = 0
1460
+
1461
+ # The instance is running, or has been stopped by owner.
1462
+ RUNNABLE = 1
1463
+
1464
+ # The instance is not available, for example due to problems with billing.
1465
+ SUSPENDED = 2
1466
+
1467
+ # The instance is being deleted.
1468
+ PENDING_DELETE = 3
1469
+
1470
+ # The instance is being created.
1471
+ PENDING_CREATE = 4
1472
+
1473
+ # The instance is down for maintenance.
1474
+ MAINTENANCE = 5
1475
+
1476
+ # The creation of the instance failed or a fatal error occurred during
1477
+ # maintenance.
1478
+ FAILED = 6
1479
+
1480
+ # Deprecated
1481
+ ONLINE_MAINTENANCE = 7
1482
+
1483
+ # (Applicable to read pool nodes only.) The read pool node needs to be
1484
+ # repaired. The database might be unavailable.
1485
+ REPAIRING = 8
1486
+ end
1487
+
1488
+ # The SQL network architecture for the instance.
1489
+ module SqlNetworkArchitecture
1490
+ SQL_NETWORK_ARCHITECTURE_UNSPECIFIED = 0
1491
+
1492
+ # The instance uses the new network architecture.
1493
+ NEW_NETWORK_ARCHITECTURE = 1
1494
+
1495
+ # The instance uses the old network architecture.
1496
+ OLD_NETWORK_ARCHITECTURE = 2
1497
+ end
1498
+ end
1499
+
1500
+ # Gemini instance configuration.
1501
+ # @!attribute [r] entitled
1502
+ # @return [::Boolean]
1503
+ # Output only. Whether Gemini is enabled.
1504
+ # @!attribute [r] google_vacuum_mgmt_enabled
1505
+ # @return [::Boolean]
1506
+ # Output only. Whether the vacuum management is enabled.
1507
+ # @!attribute [r] oom_session_cancel_enabled
1508
+ # @return [::Boolean]
1509
+ # Output only. Whether canceling the out-of-memory (OOM) session is enabled.
1510
+ # @!attribute [r] active_query_enabled
1511
+ # @return [::Boolean]
1512
+ # Output only. Whether the active query is enabled.
1513
+ # @!attribute [r] index_advisor_enabled
1514
+ # @return [::Boolean]
1515
+ # Output only. Whether the index advisor is enabled.
1516
+ # @!attribute [r] flag_recommender_enabled
1517
+ # @return [::Boolean]
1518
+ # Output only. Whether the flag recommender is enabled.
1519
+ class GeminiInstanceConfig
1520
+ include ::Google::Protobuf::MessageExts
1521
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1522
+ end
1523
+
1524
+ # A primary instance and disaster recovery (DR) replica pair.
1525
+ # A DR replica is a cross-region replica that you designate for failover in
1526
+ # the event that the primary instance experiences regional failure.
1527
+ # Applicable to MySQL and PostgreSQL.
1528
+ # @!attribute [r] psa_write_endpoint
1529
+ # @return [::String]
1530
+ # Output only. If set, this field indicates this instance has a private
1531
+ # service access (PSA) DNS endpoint that is pointing to the primary instance
1532
+ # of the cluster. If this instance is the primary, then the DNS endpoint
1533
+ # points to this instance. After a switchover or replica failover operation,
1534
+ # this DNS endpoint points to the promoted instance. This is a read-only
1535
+ # field, returned to the user as information. This field can exist even if a
1536
+ # standalone instance doesn't have a DR replica yet or the DR replica is
1537
+ # deleted.
1538
+ # @!attribute [rw] failover_dr_replica_name
1539
+ # @return [::String]
1540
+ # Optional. If the instance is a primary instance, then this field identifies
1541
+ # the disaster recovery (DR) replica. A DR replica is an optional
1542
+ # configuration for Enterprise Plus edition instances. If the instance is a
1543
+ # read replica, then the field is not set. Set this field to a replica name
1544
+ # to designate a DR replica for a primary instance. Remove the replica name
1545
+ # to remove the DR replica designation.
1546
+ # @!attribute [r] dr_replica
1547
+ # @return [::Boolean]
1548
+ # Output only. Read-only field that indicates whether the replica is a DR
1549
+ # replica. This field is not set if the instance is a primary instance.
1550
+ class ReplicationCluster
1551
+ include ::Google::Protobuf::MessageExts
1552
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1553
+ end
1554
+
1555
+ # An available database version. It can be a major or a minor version.
1556
+ # @!attribute [rw] major_version
1557
+ # @return [::String]
1558
+ # The version's major version name.
1559
+ # @!attribute [rw] name
1560
+ # @return [::String]
1561
+ # The database version name. For MySQL 8.0, this string provides the database
1562
+ # major and minor version.
1563
+ # @!attribute [rw] display_name
1564
+ # @return [::String]
1565
+ # The database version's display name.
1566
+ class AvailableDatabaseVersion
1567
+ include ::Google::Protobuf::MessageExts
1568
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1569
+ end
1570
+
1571
+ # Reschedule options for maintenance windows.
1572
+ # @!attribute [rw] reschedule
1573
+ # @return [::Google::Cloud::Sql::V1::SqlInstancesRescheduleMaintenanceRequestBody::Reschedule]
1574
+ # Required. The type of the reschedule the user wants.
1575
+ class SqlInstancesRescheduleMaintenanceRequestBody
1576
+ include ::Google::Protobuf::MessageExts
1577
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1578
+
1579
+ # @!attribute [rw] reschedule_type
1580
+ # @return [::Google::Cloud::Sql::V1::SqlInstancesRescheduleMaintenanceRequestBody::RescheduleType]
1581
+ # Required. The type of the reschedule.
1582
+ # @!attribute [rw] schedule_time
1583
+ # @return [::Google::Protobuf::Timestamp]
1584
+ # Optional. Timestamp when the maintenance shall be rescheduled to if
1585
+ # reschedule_type=SPECIFIC_TIME, in
1586
+ # [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example
1587
+ # `2012-11-15T16:19:00.094Z`.
1588
+ class Reschedule
1589
+ include ::Google::Protobuf::MessageExts
1590
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1591
+ end
1592
+
1593
+ module RescheduleType
1594
+ RESCHEDULE_TYPE_UNSPECIFIED = 0
1595
+
1596
+ # Reschedules maintenance to happen now (within 5 minutes).
1597
+ IMMEDIATE = 1
1598
+
1599
+ # Reschedules maintenance to occur within one week from the originally
1600
+ # scheduled day and time.
1601
+ NEXT_AVAILABLE_WINDOW = 2
1602
+
1603
+ # Reschedules maintenance to a specific time and day.
1604
+ SPECIFIC_TIME = 3
1605
+ end
1606
+ end
1607
+
1608
+ # Database instance demote primary instance context.
1609
+ # @!attribute [rw] kind
1610
+ # @return [::String]
1611
+ # This is always `sql#demoteMasterContext`.
1612
+ # @!attribute [rw] verify_gtid_consistency
1613
+ # @return [::Google::Protobuf::BoolValue]
1614
+ # Verify the GTID consistency for demote operation. Default value:
1615
+ # `True`. Setting this flag to `false` enables you to bypass the GTID
1616
+ # consistency check between on-premises primary instance and Cloud SQL
1617
+ # instance during the demotion operation but also exposes you to the risk of
1618
+ # future replication failures. Change the value only if you know the reason
1619
+ # for the GTID divergence and are confident that doing so will not cause any
1620
+ # replication issues.
1621
+ # @!attribute [rw] master_instance_name
1622
+ # @return [::String]
1623
+ # The name of the instance which will act as on-premises primary instance
1624
+ # in the replication setup.
1625
+ # @!attribute [rw] replica_configuration
1626
+ # @return [::Google::Cloud::Sql::V1::DemoteMasterConfiguration]
1627
+ # Configuration specific to read-replicas replicating from the on-premises
1628
+ # primary instance.
1629
+ # @!attribute [rw] skip_replication_setup
1630
+ # @return [::Boolean]
1631
+ # Flag to skip replication setup on the instance.
1632
+ class DemoteMasterContext
1633
+ include ::Google::Protobuf::MessageExts
1634
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1635
+ end
1636
+
1637
+ # This context is used to demote an existing standalone instance to be
1638
+ # a Cloud SQL read replica for an external database server.
1639
+ # @!attribute [rw] kind
1640
+ # @return [::String]
1641
+ # This is always `sql#demoteContext`.
1642
+ # @!attribute [rw] source_representative_instance_name
1643
+ # @return [::String]
1644
+ # Required. The name of the instance which acts as the on-premises primary
1645
+ # instance in the replication setup.
1646
+ class DemoteContext
1647
+ include ::Google::Protobuf::MessageExts
1648
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1649
+ end
1650
+
1651
+ # Database instance failover context.
1652
+ # @!attribute [rw] settings_version
1653
+ # @return [::Integer]
1654
+ # The current settings version of this instance. Request will be rejected if
1655
+ # this version doesn't match the current settings version.
1656
+ # @!attribute [rw] kind
1657
+ # @return [::String]
1658
+ # This is always `sql#failoverContext`.
1659
+ class FailoverContext
1660
+ include ::Google::Protobuf::MessageExts
1661
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1662
+ end
1663
+
1664
+ # Database instance restore from backup context.
1665
+ # Backup context contains source instance id and project id.
1666
+ # @!attribute [rw] kind
1667
+ # @return [::String]
1668
+ # This is always `sql#restoreBackupContext`.
1669
+ # @!attribute [rw] backup_run_id
1670
+ # @return [::Integer]
1671
+ # The ID of the backup run to restore from.
1672
+ # @!attribute [rw] instance_id
1673
+ # @return [::String]
1674
+ # The ID of the instance that the backup was taken from.
1675
+ # @!attribute [rw] project
1676
+ # @return [::String]
1677
+ # The full project ID of the source instance.
1678
+ class RestoreBackupContext
1679
+ include ::Google::Protobuf::MessageExts
1680
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1681
+ end
1682
+
1683
+ # Instance rotate server CA context.
1684
+ # @!attribute [rw] kind
1685
+ # @return [::String]
1686
+ # This is always `sql#rotateServerCaContext`.
1687
+ # @!attribute [rw] next_version
1688
+ # @return [::String]
1689
+ # The fingerprint of the next version to be rotated to. If left unspecified,
1690
+ # will be rotated to the most recently added server CA version.
1691
+ class RotateServerCaContext
1692
+ include ::Google::Protobuf::MessageExts
1693
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1694
+ end
1695
+
1696
+ # Instance rotate server certificate context.
1697
+ # @!attribute [rw] kind
1698
+ # @return [::String]
1699
+ # Optional. This is always `sql#rotateServerCertificateContext`.
1700
+ # @!attribute [rw] next_version
1701
+ # @return [::String]
1702
+ # The fingerprint of the next version to be rotated to. If left unspecified,
1703
+ # will be rotated to the most recently added server certificate version.
1704
+ class RotateServerCertificateContext
1705
+ include ::Google::Protobuf::MessageExts
1706
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1707
+ end
1708
+
1709
+ # Instance rotate Entra ID certificate context.
1710
+ # @!attribute [rw] kind
1711
+ # @return [::String]
1712
+ # Optional. This is always `sql#rotateEntraIdCertificateContext`.
1713
+ # @!attribute [rw] next_version
1714
+ # @return [::String]
1715
+ # Optional. The fingerprint of the next version to be rotated to. If left
1716
+ # unspecified, will be rotated to the most recently added server certificate
1717
+ # version.
1718
+ class RotateEntraIdCertificateContext
1719
+ include ::Google::Protobuf::MessageExts
1720
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1721
+ end
1722
+
1723
+ # Database Instance truncate log context.
1724
+ # @!attribute [rw] kind
1725
+ # @return [::String]
1726
+ # This is always `sql#truncateLogContext`.
1727
+ # @!attribute [rw] log_type
1728
+ # @return [::String]
1729
+ # The type of log to truncate. Valid values are `MYSQL_GENERAL_TABLE` and
1730
+ # `MYSQL_SLOW_TABLE`.
1731
+ class TruncateLogContext
1732
+ include ::Google::Protobuf::MessageExts
1733
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1734
+ end
1735
+
1736
+ # External primary instance migration setting error/warning.
1737
+ # @!attribute [rw] kind
1738
+ # @return [::String]
1739
+ # Can be `sql#externalSyncSettingError` or
1740
+ # `sql#externalSyncSettingWarning`.
1741
+ # @!attribute [rw] type
1742
+ # @return [::Google::Cloud::Sql::V1::SqlExternalSyncSettingError::SqlExternalSyncSettingErrorType]
1743
+ # Identifies the specific error that occurred.
1744
+ # @!attribute [rw] detail
1745
+ # @return [::String]
1746
+ # Additional information about the error encountered.
1747
+ class SqlExternalSyncSettingError
1748
+ include ::Google::Protobuf::MessageExts
1749
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1750
+
1751
+ module SqlExternalSyncSettingErrorType
1752
+ SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED = 0
1753
+
1754
+ CONNECTION_FAILURE = 1
1755
+
1756
+ BINLOG_NOT_ENABLED = 2
1757
+
1758
+ INCOMPATIBLE_DATABASE_VERSION = 3
1759
+
1760
+ REPLICA_ALREADY_SETUP = 4
1761
+
1762
+ # The replication user is missing privileges that are required.
1763
+ INSUFFICIENT_PRIVILEGE = 5
1764
+
1765
+ # Unsupported migration type.
1766
+ UNSUPPORTED_MIGRATION_TYPE = 6
1767
+
1768
+ # No pglogical extension installed on databases, applicable for postgres.
1769
+ NO_PGLOGICAL_INSTALLED = 7
1770
+
1771
+ # pglogical node already exists on databases, applicable for postgres.
1772
+ PGLOGICAL_NODE_ALREADY_EXISTS = 8
1773
+
1774
+ # The value of parameter wal_level is not set to logical.
1775
+ INVALID_WAL_LEVEL = 9
1776
+
1777
+ # The value of parameter shared_preload_libraries does not include
1778
+ # pglogical.
1779
+ INVALID_SHARED_PRELOAD_LIBRARY = 10
1780
+
1781
+ # The value of parameter max_replication_slots is not sufficient.
1782
+ INSUFFICIENT_MAX_REPLICATION_SLOTS = 11
1783
+
1784
+ # The value of parameter max_wal_senders is not sufficient.
1785
+ INSUFFICIENT_MAX_WAL_SENDERS = 12
1786
+
1787
+ # The value of parameter max_worker_processes is not sufficient.
1788
+ INSUFFICIENT_MAX_WORKER_PROCESSES = 13
1789
+
1790
+ # Extensions installed are either not supported or having unsupported
1791
+ # versions.
1792
+ UNSUPPORTED_EXTENSIONS = 14
1793
+
1794
+ # The value of parameter rds.logical_replication is not set to 1.
1795
+ INVALID_RDS_LOGICAL_REPLICATION = 15
1796
+
1797
+ # The primary instance logging setup doesn't allow EM sync.
1798
+ INVALID_LOGGING_SETUP = 16
1799
+
1800
+ # The primary instance database parameter setup doesn't allow EM sync.
1801
+ INVALID_DB_PARAM = 17
1802
+
1803
+ # The gtid_mode is not supported, applicable for MySQL.
1804
+ UNSUPPORTED_GTID_MODE = 18
1805
+
1806
+ # SQL Server Agent is not running.
1807
+ SQLSERVER_AGENT_NOT_RUNNING = 19
1808
+
1809
+ # The table definition is not support due to missing primary key or replica
1810
+ # identity, applicable for postgres. Note that this is a warning and won't
1811
+ # block the migration.
1812
+ UNSUPPORTED_TABLE_DEFINITION = 20
1813
+
1814
+ # The customer has a definer that will break EM setup.
1815
+ UNSUPPORTED_DEFINER = 21
1816
+
1817
+ # SQL Server @@SERVERNAME does not match actual host name.
1818
+ SQLSERVER_SERVERNAME_MISMATCH = 22
1819
+
1820
+ # The primary instance has been setup and will fail the setup.
1821
+ PRIMARY_ALREADY_SETUP = 23
1822
+
1823
+ # The primary instance has unsupported binary log format.
1824
+ UNSUPPORTED_BINLOG_FORMAT = 24
1825
+
1826
+ # The primary instance's binary log retention setting.
1827
+ BINLOG_RETENTION_SETTING = 25
1828
+
1829
+ # The primary instance has tables with unsupported storage engine.
1830
+ UNSUPPORTED_STORAGE_ENGINE = 26
1831
+
1832
+ # Source has tables with limited support
1833
+ # eg: PostgreSQL tables without primary keys.
1834
+ LIMITED_SUPPORT_TABLES = 27
1835
+
1836
+ # The replica instance contains existing data.
1837
+ EXISTING_DATA_IN_REPLICA = 28
1838
+
1839
+ # The replication user is missing privileges that are optional.
1840
+ MISSING_OPTIONAL_PRIVILEGES = 29
1841
+
1842
+ # Additional BACKUP_ADMIN privilege is granted to the replication user
1843
+ # which may lock source MySQL 8 instance for DDLs during initial sync.
1844
+ RISKY_BACKUP_ADMIN_PRIVILEGE = 30
1845
+
1846
+ # The Cloud Storage bucket is missing necessary permissions.
1847
+ INSUFFICIENT_GCS_PERMISSIONS = 31
1848
+
1849
+ # The Cloud Storage bucket has an error in the file or contains invalid
1850
+ # file information.
1851
+ INVALID_FILE_INFO = 32
1852
+
1853
+ # The source instance has unsupported database settings for migration.
1854
+ UNSUPPORTED_DATABASE_SETTINGS = 33
1855
+
1856
+ # The replication user is missing parallel import specific privileges.
1857
+ # (e.g. LOCK TABLES) for MySQL.
1858
+ MYSQL_PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE = 34
1859
+
1860
+ # The global variable local_infile is off on external server replica.
1861
+ LOCAL_INFILE_OFF = 35
1862
+
1863
+ # This code instructs customers to turn on point-in-time recovery manually
1864
+ # for the instance after promoting the Cloud SQL for PostgreSQL instance.
1865
+ TURN_ON_PITR_AFTER_PROMOTE = 36
1866
+
1867
+ # The minor version of replica database is incompatible with the source.
1868
+ INCOMPATIBLE_DATABASE_MINOR_VERSION = 37
1869
+
1870
+ # This warning message indicates that Cloud SQL uses the maximum number of
1871
+ # subscriptions to migrate data from the source to the destination.
1872
+ SOURCE_MAX_SUBSCRIPTIONS = 38
1873
+
1874
+ # Unable to verify definers on the source for MySQL.
1875
+ UNABLE_TO_VERIFY_DEFINERS = 39
1876
+
1877
+ # If a time out occurs while the subscription counts are calculated, then
1878
+ # this value is set to 1. Otherwise, this value is set to 2.
1879
+ SUBSCRIPTION_CALCULATION_STATUS = 40
1880
+
1881
+ # Count of subscriptions needed to sync source data for PostgreSQL
1882
+ # database.
1883
+ PG_SUBSCRIPTION_COUNT = 41
1884
+
1885
+ # Final parallel level that is used to do migration.
1886
+ PG_SYNC_PARALLEL_LEVEL = 42
1887
+
1888
+ # The disk size of the replica instance is smaller than the data size of
1889
+ # the source instance.
1890
+ INSUFFICIENT_DISK_SIZE = 43
1891
+
1892
+ # The data size of the source instance is greater than 1 TB, the number of
1893
+ # cores of the replica instance is less than 8, and the memory of the
1894
+ # replica is less than 32 GB.
1895
+ INSUFFICIENT_MACHINE_TIER = 44
1896
+
1897
+ # The warning message indicates the unsupported extensions will not be
1898
+ # migrated to the destination.
1899
+ UNSUPPORTED_EXTENSIONS_NOT_MIGRATED = 45
1900
+
1901
+ # The warning message indicates the pg_cron extension and settings will not
1902
+ # be migrated to the destination.
1903
+ EXTENSIONS_NOT_MIGRATED = 46
1904
+
1905
+ # The error message indicates that pg_cron flags are enabled on the
1906
+ # destination which is not supported during the migration.
1907
+ PG_CRON_FLAG_ENABLED_IN_REPLICA = 47
1908
+
1909
+ # This error message indicates that the specified extensions are not
1910
+ # enabled on destination instance. For example, before you can migrate
1911
+ # data to the destination instance, you must enable the PGAudit extension
1912
+ # on the instance.
1913
+ EXTENSIONS_NOT_ENABLED_IN_REPLICA = 48
1914
+
1915
+ # The source database has generated columns that can't be migrated. Please
1916
+ # change them to regular columns before migration.
1917
+ UNSUPPORTED_COLUMNS = 49
1918
+
1919
+ # The source database has users that aren't created in the replica.
1920
+ # First, create all users, which are in the pg_user_mappings table
1921
+ # of the source database, in the destination instance. Then, perform the
1922
+ # migration.
1923
+ USERS_NOT_CREATED_IN_REPLICA = 50
1924
+
1925
+ # The selected objects include system objects that aren't supported for
1926
+ # migration.
1927
+ UNSUPPORTED_SYSTEM_OBJECTS = 51
1928
+
1929
+ # The source database has tables with the FULL or NOTHING replica identity.
1930
+ # Before starting your migration, either remove the identity or change it
1931
+ # to DEFAULT. Note that this is an error and will block the migration.
1932
+ UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY = 52
1933
+
1934
+ # The selected objects don't exist on the source instance.
1935
+ SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE = 53
1936
+
1937
+ # PSC only destination instance does not have a network attachment URI.
1938
+ PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI = 54
1939
+
1940
+ # Selected objects reference unselected objects. Based on their object type
1941
+ # (foreign key constraint or view), selected objects will fail during
1942
+ # migration.
1943
+ SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS = 55
1944
+
1945
+ # The migration will delete existing data in the replica; set
1946
+ # {::Google::Cloud::Sql::V1::SqlInstancesStartExternalSyncRequest#replica_overwrite_enabled replica_overwrite_enabled}
1947
+ # in the request to acknowledge this. This is an error. MySQL only.
1948
+ PROMPT_DELETE_EXISTING = 56
1949
+
1950
+ # The migration will delete existing data in the replica;
1951
+ # {::Google::Cloud::Sql::V1::SqlInstancesStartExternalSyncRequest#replica_overwrite_enabled replica_overwrite_enabled}
1952
+ # was set in the request acknowledging this. This is a warning rather than
1953
+ # an error. MySQL only.
1954
+ WILL_DELETE_EXISTING = 57
1955
+
1956
+ # The replication user is missing specific privileges to setup DDL
1957
+ # replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL.
1958
+ PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE = 58
1959
+ end
1960
+ end
1961
+
1962
+ # A list of objects that the user selects for replication from an external
1963
+ # source instance.
1964
+ # @!attribute [rw] database
1965
+ # @return [::String]
1966
+ # Required. The name of the database to migrate.
1967
+ class SelectedObjects
1968
+ include ::Google::Protobuf::MessageExts
1969
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1970
+ end
1971
+
1972
+ # On-premises instance configuration.
1973
+ # @!attribute [rw] host_port
1974
+ # @return [::String]
1975
+ # The host and port of the on-premises instance in host:port format
1976
+ # @!attribute [rw] kind
1977
+ # @return [::String]
1978
+ # This is always `sql#onPremisesConfiguration`.
1979
+ # @!attribute [rw] username
1980
+ # @return [::String]
1981
+ # The username for connecting to on-premises instance.
1982
+ # @!attribute [rw] password
1983
+ # @return [::String]
1984
+ # The password for connecting to on-premises instance.
1985
+ # @!attribute [rw] ca_certificate
1986
+ # @return [::String]
1987
+ # PEM representation of the trusted CA's x509 certificate.
1988
+ # @!attribute [rw] client_certificate
1989
+ # @return [::String]
1990
+ # PEM representation of the replica's x509 certificate.
1991
+ # @!attribute [rw] client_key
1992
+ # @return [::String]
1993
+ # PEM representation of the replica's private key. The corresponding public
1994
+ # key is encoded in the client's certificate.
1995
+ # @!attribute [rw] dump_file_path
1996
+ # @return [::String]
1997
+ # The dump file to create the Cloud SQL replica.
1998
+ # @!attribute [rw] source_instance
1999
+ # @return [::Google::Cloud::Sql::V1::InstanceReference]
2000
+ # The reference to Cloud SQL instance if the source is Cloud SQL.
2001
+ # @!attribute [rw] selected_objects
2002
+ # @return [::Array<::Google::Cloud::Sql::V1::SelectedObjects>]
2003
+ # Optional. A list of objects that the user selects for replication from an
2004
+ # external source instance.
2005
+ # @!attribute [rw] ssl_option
2006
+ # @return [::Google::Cloud::Sql::V1::OnPremisesConfiguration::SslOption]
2007
+ # Optional. SSL option for replica connection to the on-premises source.
2008
+ class OnPremisesConfiguration
2009
+ include ::Google::Protobuf::MessageExts
2010
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2011
+
2012
+ # SslOption defines the SSL mode to be used for replica connection to the
2013
+ # on-premises source.
2014
+ module SslOption
2015
+ # Unknown SSL option i.e. SSL option not specified by user.
2016
+ SSL_OPTION_UNSPECIFIED = 0
2017
+
2018
+ # SSL is not used for replica connection to the on-premises source.
2019
+ DISABLE = 1
2020
+
2021
+ # SSL is required for replica connection to the on-premises source.
2022
+ REQUIRE = 2
2023
+
2024
+ # Verify CA is required for replica connection to the on-premises source.
2025
+ VERIFY_CA = 3
2026
+ end
2027
+ end
2028
+
2029
+ # Read-replica configuration for connecting to the primary instance.
2030
+ # @!attribute [rw] kind
2031
+ # @return [::String]
2032
+ # This is always `sql#replicaConfiguration`.
2033
+ # @!attribute [rw] mysql_replica_configuration
2034
+ # @return [::Google::Cloud::Sql::V1::MySqlReplicaConfiguration]
2035
+ # MySQL specific configuration when replicating from a MySQL on-premises
2036
+ # primary instance. Replication configuration information such as the
2037
+ # username, password, certificates, and keys are not stored in the instance
2038
+ # metadata. The configuration information is used only to set up the
2039
+ # replication connection and is stored by MySQL in a file named
2040
+ # `master.info` in the data directory.
2041
+ # @!attribute [rw] failover_target
2042
+ # @return [::Google::Protobuf::BoolValue]
2043
+ # Specifies if the replica is the failover target. If the field is set to
2044
+ # `true`, the replica will be designated as a failover replica. In case the
2045
+ # primary instance fails, the replica instance will be promoted as the new
2046
+ # primary instance. Only one replica can be specified as failover target, and
2047
+ # the replica has to be in different zone with the primary instance.
2048
+ # @!attribute [rw] cascadable_replica
2049
+ # @return [::Google::Protobuf::BoolValue]
2050
+ # Optional. Specifies if a SQL Server replica is a cascadable replica. A
2051
+ # cascadable replica is a SQL Server cross region replica that supports
2052
+ # replica(s) under it.
2053
+ class ReplicaConfiguration
2054
+ include ::Google::Protobuf::MessageExts
2055
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2056
+ end
2057
+
2058
+ # Execute SQL statements request.
2059
+ # @!attribute [rw] instance
2060
+ # @return [::String]
2061
+ # Required. Database instance ID. This does not include the project ID.
2062
+ # @!attribute [rw] project
2063
+ # @return [::String]
2064
+ # Required. Project ID of the project that contains the instance.
2065
+ # @!attribute [rw] body
2066
+ # @return [::Google::Cloud::Sql::V1::ExecuteSqlPayload]
2067
+ # The request body.
2068
+ class SqlInstancesExecuteSqlRequest
2069
+ include ::Google::Protobuf::MessageExts
2070
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2071
+ end
2072
+
2073
+ # The request payload used to execute SQL statements.
2074
+ # @!attribute [rw] user
2075
+ # @return [::String]
2076
+ # Optional. The name of an existing database user to connect to the database.
2077
+ # When `auto_iam_authn` is set to true, this field is ignored and the API
2078
+ # caller's IAM user is used.
2079
+ # @!attribute [rw] sql_statement
2080
+ # @return [::String]
2081
+ # Required. SQL statements to run on the database. It can be a single
2082
+ # statement or a sequence of statements separated by semicolons.
2083
+ # @!attribute [rw] database
2084
+ # @return [::String]
2085
+ # Optional. Name of the database on which the statement will be executed.
2086
+ # @!attribute [rw] auto_iam_authn
2087
+ # @return [::Boolean]
2088
+ # Optional. When set to `true`, the API caller identity associated with the
2089
+ # request is used for database authentication. The API caller must be an
2090
+ # IAM user in the database.
2091
+ # @!attribute [rw] row_limit
2092
+ # @return [::Integer]
2093
+ # Optional. The maximum number of rows returned per SQL statement.
2094
+ # @!attribute [rw] partial_result_mode
2095
+ # @return [::Google::Cloud::Sql::V1::ExecuteSqlPayload::PartialResultMode]
2096
+ # Optional. Controls how the API should respond when the SQL execution result
2097
+ # is incomplete due to the size limit or another error. The default mode is
2098
+ # to throw an error.
2099
+ # @!attribute [rw] application
2100
+ # @return [::String]
2101
+ # Optional. Specifies the name of the application that is making the request.
2102
+ # This field is used for telemetry. Only alphanumeric characters, dashes, and
2103
+ # underscores are allowed. The maximum length is 32 characters.
2104
+ class ExecuteSqlPayload
2105
+ include ::Google::Protobuf::MessageExts
2106
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2107
+
2108
+ # Controls how the API should respond when the SQL execution result exceeds
2109
+ # 10 MB.
2110
+ module PartialResultMode
2111
+ # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
2112
+ PARTIAL_RESULT_MODE_UNSPECIFIED = 0
2113
+
2114
+ # Throw an error if the result exceeds 10 MB or if only a partial result
2115
+ # can be retrieved. Don't return the result.
2116
+ FAIL_PARTIAL_RESULT = 1
2117
+
2118
+ # Return a truncated result and set `partial_result` to true if the result
2119
+ # exceeds 10 MB or if only a partial result can be retrieved due to error.
2120
+ # Don't throw an error.
2121
+ ALLOW_PARTIAL_RESULT = 2
2122
+ end
2123
+ end
2124
+
2125
+ # Execute SQL statements response.
2126
+ # @!attribute [rw] messages
2127
+ # @return [::Array<::Google::Cloud::Sql::V1::SqlInstancesExecuteSqlResponse::Message>]
2128
+ # A list of notices and warnings generated during query execution.
2129
+ # For PostgreSQL, this includes all notices and warnings.
2130
+ # For MySQL, this includes warnings generated by the last executed statement.
2131
+ # To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must
2132
+ # be executed after each statement.
2133
+ # @!attribute [rw] metadata
2134
+ # @return [::Google::Cloud::Sql::V1::Metadata]
2135
+ # The additional metadata information regarding the execution of the SQL
2136
+ # statements.
2137
+ # @!attribute [rw] results
2138
+ # @return [::Array<::Google::Cloud::Sql::V1::QueryResult>]
2139
+ # The list of results after executing all the SQL statements.
2140
+ # @!attribute [rw] status
2141
+ # @return [::Google::Rpc::Status]
2142
+ # Contains the error from the database if the SQL execution failed.
2143
+ class SqlInstancesExecuteSqlResponse
2144
+ include ::Google::Protobuf::MessageExts
2145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2146
+
2147
+ # Represents a notice or warning message from the database.
2148
+ # @!attribute [rw] message
2149
+ # @return [::String]
2150
+ # The full message string.
2151
+ # For PostgreSQL, this is a formatted string that may include severity,
2152
+ # code, and the notice/warning message.
2153
+ # For MySQL, this contains the warning message.
2154
+ # @!attribute [rw] severity
2155
+ # @return [::String]
2156
+ # The severity of the message (e.g., "NOTICE" for PostgreSQL, "WARNING" for
2157
+ # MySQL).
2158
+ class Message
2159
+ include ::Google::Protobuf::MessageExts
2160
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2161
+ end
2162
+ end
2163
+
2164
+ # QueryResult contains the result of executing a single SQL statement.
2165
+ # @!attribute [rw] columns
2166
+ # @return [::Array<::Google::Cloud::Sql::V1::Column>]
2167
+ # List of columns included in the result. This also includes the data type
2168
+ # of the column.
2169
+ # @!attribute [rw] rows
2170
+ # @return [::Array<::Google::Cloud::Sql::V1::Row>]
2171
+ # Rows returned by the SQL statement.
2172
+ # @!attribute [rw] message
2173
+ # @return [::String]
2174
+ # Message related to the SQL execution result.
2175
+ # @!attribute [rw] partial_result
2176
+ # @return [::Boolean]
2177
+ # Set to true if the SQL execution's result is truncated due to size limits
2178
+ # or an error retrieving results.
2179
+ # @!attribute [rw] status
2180
+ # @return [::Google::Rpc::Status]
2181
+ # If results were truncated due to an error, details of that error.
2182
+ class QueryResult
2183
+ include ::Google::Protobuf::MessageExts
2184
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2185
+ end
2186
+
2187
+ # Contains the name and datatype of a column.
2188
+ # @!attribute [rw] name
2189
+ # @return [::String]
2190
+ # Name of the column.
2191
+ # @!attribute [rw] type
2192
+ # @return [::String]
2193
+ # Datatype of the column.
2194
+ class Column
2195
+ include ::Google::Protobuf::MessageExts
2196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2197
+ end
2198
+
2199
+ # Contains the values for a row.
2200
+ # @!attribute [rw] values
2201
+ # @return [::Array<::Google::Cloud::Sql::V1::Value>]
2202
+ # The values for the row.
2203
+ class Row
2204
+ include ::Google::Protobuf::MessageExts
2205
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2206
+ end
2207
+
2208
+ # The cell value of the table.
2209
+ # @!attribute [rw] value
2210
+ # @return [::String]
2211
+ # The cell value in string format.
2212
+ # @!attribute [rw] null_value
2213
+ # @return [::Boolean]
2214
+ # If cell value is null, then this flag will be set to true.
2215
+ class Value
2216
+ include ::Google::Protobuf::MessageExts
2217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2218
+ end
2219
+
2220
+ # The additional metadata information regarding the execution of the SQL
2221
+ # statements.
2222
+ # @!attribute [rw] sql_statement_execution_time
2223
+ # @return [::Google::Protobuf::Duration]
2224
+ # The time taken to execute the SQL statements.
2225
+ class Metadata
2226
+ include ::Google::Protobuf::MessageExts
2227
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2228
+ end
2229
+
2230
+ # Request to acquire a lease for SSRS.
2231
+ # @!attribute [rw] instance
2232
+ # @return [::String]
2233
+ # Required. Cloud SQL instance ID. This doesn't include the project ID. It's
2234
+ # composed of lowercase letters, numbers, and hyphens, and it must start with
2235
+ # a letter. The total length must be 98 characters or less (Example:
2236
+ # instance-id).
2237
+ # @!attribute [rw] project
2238
+ # @return [::String]
2239
+ # Required. Project ID of the project that contains the instance (Example:
2240
+ # project-id).
2241
+ # @!attribute [rw] body
2242
+ # @return [::Google::Cloud::Sql::V1::InstancesAcquireSsrsLeaseRequest]
2243
+ # Required. The request body.
2244
+ class SqlInstancesAcquireSsrsLeaseRequest
2245
+ include ::Google::Protobuf::MessageExts
2246
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2247
+ end
2248
+
2249
+ # Response for the acquire SSRS lease request.
2250
+ # @!attribute [rw] operation_id
2251
+ # @return [::String]
2252
+ # The unique identifier for this operation.
2253
+ class SqlInstancesAcquireSsrsLeaseResponse
2254
+ include ::Google::Protobuf::MessageExts
2255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2256
+ end
2257
+
2258
+ # Request to release a lease for SSRS.
2259
+ # @!attribute [rw] instance
2260
+ # @return [::String]
2261
+ # Required. The Cloud SQL instance ID. This doesn't include the project ID.
2262
+ # The instance ID contains lowercase letters, numbers, and hyphens, and it
2263
+ # must start with a letter. This ID can have a maximum length of 98
2264
+ # characters.
2265
+ # @!attribute [rw] project
2266
+ # @return [::String]
2267
+ # Required. The project ID that contains the instance.
2268
+ class SqlInstancesReleaseSsrsLeaseRequest
2269
+ include ::Google::Protobuf::MessageExts
2270
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2271
+ end
2272
+
2273
+ # Response for the release SSRS lease request.
2274
+ # @!attribute [rw] operation_id
2275
+ # @return [::String]
2276
+ # The unique identifier for this operation.
2277
+ class SqlInstancesReleaseSsrsLeaseResponse
2278
+ include ::Google::Protobuf::MessageExts
2279
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2280
+ end
2281
+
2282
+ # Request to perform a point in time restore on a Google Cloud Backup and
2283
+ # Disaster Recovery managed instance.
2284
+ # @!attribute [rw] parent
2285
+ # @return [::String]
2286
+ # Required. The parent resource where you created this instance.
2287
+ # Format: projects/\\{project}
2288
+ # @!attribute [rw] context
2289
+ # @return [::Google::Cloud::Sql::V1::PointInTimeRestoreContext]
2290
+ # Required. The context for request to perform a PITR on a Google Cloud
2291
+ # Backup and Disaster Recovery managed instance.
2292
+ class SqlInstancesPointInTimeRestoreRequest
2293
+ include ::Google::Protobuf::MessageExts
2294
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2295
+ end
2296
+
2297
+ # External Sync parallel level.
2298
+ module ExternalSyncParallelLevel
2299
+ # Unknown sync parallel level. Will be defaulted to OPTIMAL.
2300
+ EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED = 0
2301
+
2302
+ # Minimal parallel level.
2303
+ MIN = 1
2304
+
2305
+ # Optimal parallel level.
2306
+ OPTIMAL = 2
2307
+
2308
+ # Maximum parallel level.
2309
+ MAX = 3
2310
+ end
2311
+
2312
+ module SqlInstanceType
2313
+ # This is an unknown Cloud SQL instance type.
2314
+ SQL_INSTANCE_TYPE_UNSPECIFIED = 0
2315
+
2316
+ # A regular Cloud SQL instance that is not replicating from a primary
2317
+ # instance.
2318
+ CLOUD_SQL_INSTANCE = 1
2319
+
2320
+ # An instance running on the customer's premises that is not managed by
2321
+ # Cloud SQL.
2322
+ ON_PREMISES_INSTANCE = 2
2323
+
2324
+ # A Cloud SQL instance acting as a read-replica.
2325
+ READ_REPLICA_INSTANCE = 3
2326
+
2327
+ # A Cloud SQL read pool.
2328
+ READ_POOL_INSTANCE = 5
2329
+ end
2330
+
2331
+ # The suspension reason of the database instance if the state is SUSPENDED.
2332
+ module SqlSuspensionReason
2333
+ # This is an unknown suspension reason.
2334
+ SQL_SUSPENSION_REASON_UNSPECIFIED = 0
2335
+
2336
+ # The instance is suspended due to billing issues (for example:, account
2337
+ # issue)
2338
+ BILLING_ISSUE = 2
2339
+
2340
+ # The instance is suspended due to illegal content (for example:, child
2341
+ # pornography, copyrighted material, etc.).
2342
+ LEGAL_ISSUE = 3
2343
+
2344
+ # The instance is causing operational issues (for example:, causing the
2345
+ # database to crash).
2346
+ OPERATIONAL_ISSUE = 4
2347
+
2348
+ # The KMS key used by the instance is either revoked or denied access to
2349
+ KMS_KEY_ISSUE = 5
2350
+
2351
+ # The project is suspended due to abuse detected by Ares.
2352
+ PROJECT_ABUSE = 8
2353
+ end
2354
+ end
2355
+ end
2356
+ end
2357
+ end