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