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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +153 -8
  5. data/lib/google/cloud/sql/v1beta4/cloud_sql_connect_pb.rb +35 -0
  6. data/lib/google/cloud/sql/v1beta4/cloud_sql_connect_services_pb.rb +53 -0
  7. data/lib/google/cloud/sql/v1beta4/cloud_sql_data_pb.rb +35 -0
  8. data/lib/google/cloud/sql/v1beta4/cloud_sql_data_services_pb.rb +80 -0
  9. data/lib/google/cloud/sql/v1beta4/cloud_sql_iam_policies_pb.rb +23 -0
  10. data/lib/google/cloud/sql/v1beta4/cloud_sql_iam_policies_services_pb.rb +29 -0
  11. data/lib/google/cloud/sql/v1beta4/cloud_sql_pb.rb +117 -0
  12. data/lib/google/cloud/sql/v1beta4/cloud_sql_resources_pb.rb +192 -0
  13. data/lib/google/cloud/sql/v1beta4/cloud_sql_services_pb.rb +325 -0
  14. data/lib/google/cloud/sql/v1beta4/cloud_sql_tiers_pb.rb +26 -0
  15. data/lib/google/cloud/sql/v1beta4/cloud_sql_tiers_services_pb.rb +46 -0
  16. data/lib/google/cloud/sql/v1beta4/cloud_sql_users_pb.rb +40 -0
  17. data/lib/google/cloud/sql/v1beta4/cloud_sql_users_services_pb.rb +52 -0
  18. data/lib/google/cloud/sql/v1beta4/rest.rb +46 -0
  19. data/lib/google/cloud/sql/v1beta4/sql_backup_runs_service/client.rb +807 -0
  20. data/lib/google/cloud/sql/v1beta4/sql_backup_runs_service/credentials.rb +48 -0
  21. data/lib/google/cloud/sql/v1beta4/sql_backup_runs_service/rest/client.rb +718 -0
  22. data/lib/google/cloud/sql/v1beta4/sql_backup_runs_service/rest/service_stub.rb +332 -0
  23. data/lib/google/cloud/sql/v1beta4/sql_backup_runs_service/rest.rb +49 -0
  24. data/lib/google/cloud/sql/v1beta4/sql_backup_runs_service.rb +52 -0
  25. data/lib/google/cloud/sql/v1beta4/sql_backups_service/client.rb +896 -0
  26. data/lib/google/cloud/sql/v1beta4/sql_backups_service/credentials.rb +48 -0
  27. data/lib/google/cloud/sql/v1beta4/sql_backups_service/paths.rb +83 -0
  28. data/lib/google/cloud/sql/v1beta4/sql_backups_service/rest/client.rb +818 -0
  29. data/lib/google/cloud/sql/v1beta4/sql_backups_service/rest/service_stub.rb +388 -0
  30. data/lib/google/cloud/sql/v1beta4/sql_backups_service/rest.rb +50 -0
  31. data/lib/google/cloud/sql/v1beta4/sql_backups_service.rb +53 -0
  32. data/lib/google/cloud/sql/v1beta4/sql_connect_service/client.rb +705 -0
  33. data/lib/google/cloud/sql/v1beta4/sql_connect_service/credentials.rb +48 -0
  34. data/lib/google/cloud/sql/v1beta4/sql_connect_service/rest/client.rb +632 -0
  35. data/lib/google/cloud/sql/v1beta4/sql_connect_service/rest/service_stub.rb +268 -0
  36. data/lib/google/cloud/sql/v1beta4/sql_connect_service/rest.rb +51 -0
  37. data/lib/google/cloud/sql/v1beta4/sql_connect_service.rb +54 -0
  38. data/lib/google/cloud/sql/v1beta4/sql_data_service/client.rb +520 -0
  39. data/lib/google/cloud/sql/v1beta4/sql_data_service/credentials.rb +48 -0
  40. data/lib/google/cloud/sql/v1beta4/sql_data_service/paths.rb +50 -0
  41. data/lib/google/cloud/sql/v1beta4/sql_data_service.rb +49 -0
  42. data/lib/google/cloud/sql/v1beta4/sql_databases_service/client.rb +1009 -0
  43. data/lib/google/cloud/sql/v1beta4/sql_databases_service/credentials.rb +48 -0
  44. data/lib/google/cloud/sql/v1beta4/sql_databases_service/rest/client.rb +894 -0
  45. data/lib/google/cloud/sql/v1beta4/sql_databases_service/rest/service_stub.rb +460 -0
  46. data/lib/google/cloud/sql/v1beta4/sql_databases_service/rest.rb +49 -0
  47. data/lib/google/cloud/sql/v1beta4/sql_databases_service.rb +52 -0
  48. data/lib/google/cloud/sql/v1beta4/sql_flags_service/client.rb +486 -0
  49. data/lib/google/cloud/sql/v1beta4/sql_flags_service/credentials.rb +48 -0
  50. data/lib/google/cloud/sql/v1beta4/sql_flags_service/rest/client.rb +444 -0
  51. data/lib/google/cloud/sql/v1beta4/sql_flags_service/rest/service_stub.rb +140 -0
  52. data/lib/google/cloud/sql/v1beta4/sql_flags_service/rest.rb +49 -0
  53. data/lib/google/cloud/sql/v1beta4/sql_flags_service.rb +52 -0
  54. data/lib/google/cloud/sql/v1beta4/sql_instances_service/client.rb +4745 -0
  55. data/lib/google/cloud/sql/v1beta4/sql_instances_service/credentials.rb +48 -0
  56. data/lib/google/cloud/sql/v1beta4/sql_instances_service/paths.rb +159 -0
  57. data/lib/google/cloud/sql/v1beta4/sql_instances_service/rest/client.rb +4281 -0
  58. data/lib/google/cloud/sql/v1beta4/sql_instances_service/rest/service_stub.rb +2769 -0
  59. data/lib/google/cloud/sql/v1beta4/sql_instances_service/rest.rb +50 -0
  60. data/lib/google/cloud/sql/v1beta4/sql_instances_service.rb +53 -0
  61. data/lib/google/cloud/sql/v1beta4/sql_operations_service/client.rb +699 -0
  62. data/lib/google/cloud/sql/v1beta4/sql_operations_service/credentials.rb +48 -0
  63. data/lib/google/cloud/sql/v1beta4/sql_operations_service/rest/client.rb +629 -0
  64. data/lib/google/cloud/sql/v1beta4/sql_operations_service/rest/service_stub.rb +266 -0
  65. data/lib/google/cloud/sql/v1beta4/sql_operations_service/rest.rb +49 -0
  66. data/lib/google/cloud/sql/v1beta4/sql_operations_service.rb +52 -0
  67. data/lib/google/cloud/sql/v1beta4/sql_ssl_certs_service/client.rb +802 -0
  68. data/lib/google/cloud/sql/v1beta4/sql_ssl_certs_service/credentials.rb +48 -0
  69. data/lib/google/cloud/sql/v1beta4/sql_ssl_certs_service/rest/client.rb +713 -0
  70. data/lib/google/cloud/sql/v1beta4/sql_ssl_certs_service/rest/service_stub.rb +332 -0
  71. data/lib/google/cloud/sql/v1beta4/sql_ssl_certs_service/rest.rb +49 -0
  72. data/lib/google/cloud/sql/v1beta4/sql_ssl_certs_service.rb +52 -0
  73. data/lib/google/cloud/sql/v1beta4/sql_tiers_service/client.rb +493 -0
  74. data/lib/google/cloud/sql/v1beta4/sql_tiers_service/credentials.rb +48 -0
  75. data/lib/google/cloud/sql/v1beta4/sql_tiers_service/rest/client.rb +443 -0
  76. data/lib/google/cloud/sql/v1beta4/sql_tiers_service/rest/service_stub.rb +142 -0
  77. data/lib/google/cloud/sql/v1beta4/sql_tiers_service/rest.rb +51 -0
  78. data/lib/google/cloud/sql/v1beta4/sql_tiers_service.rb +54 -0
  79. data/lib/google/cloud/sql/v1beta4/sql_users_service/client.rb +915 -0
  80. data/lib/google/cloud/sql/v1beta4/sql_users_service/credentials.rb +48 -0
  81. data/lib/google/cloud/sql/v1beta4/sql_users_service/rest/client.rb +819 -0
  82. data/lib/google/cloud/sql/v1beta4/sql_users_service/rest/service_stub.rb +394 -0
  83. data/lib/google/cloud/sql/v1beta4/sql_users_service/rest.rb +49 -0
  84. data/lib/google/cloud/sql/v1beta4/sql_users_service.rb +52 -0
  85. data/lib/google/cloud/sql/v1beta4/version.rb +7 -2
  86. data/lib/google/cloud/sql/v1beta4.rb +56 -0
  87. data/lib/google-cloud-sql-v1beta4.rb +21 -0
  88. data/proto_docs/README.md +4 -0
  89. data/proto_docs/google/api/client.rb +593 -0
  90. data/proto_docs/google/api/field_behavior.rb +85 -0
  91. data/proto_docs/google/api/field_info.rb +88 -0
  92. data/proto_docs/google/api/launch_stage.rb +71 -0
  93. data/proto_docs/google/api/resource.rb +227 -0
  94. data/proto_docs/google/cloud/sql/v1beta4/cloud_sql.rb +1329 -0
  95. data/proto_docs/google/cloud/sql/v1beta4/cloud_sql_connect.rb +207 -0
  96. data/proto_docs/google/cloud/sql/v1beta4/cloud_sql_data.rb +189 -0
  97. data/proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb +4489 -0
  98. data/proto_docs/google/cloud/sql/v1beta4/cloud_sql_tiers.rb +68 -0
  99. data/proto_docs/google/cloud/sql/v1beta4/cloud_sql_users.rb +308 -0
  100. data/proto_docs/google/protobuf/any.rb +145 -0
  101. data/proto_docs/google/protobuf/duration.rb +98 -0
  102. data/proto_docs/google/protobuf/empty.rb +34 -0
  103. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  104. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  105. data/proto_docs/google/protobuf/wrappers.rb +148 -0
  106. data/proto_docs/google/rpc/status.rb +48 -0
  107. data/proto_docs/google/type/interval.rb +45 -0
  108. metadata +153 -9
@@ -0,0 +1,1329 @@
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 V1beta4
24
+ # The request payload to create the backup
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The parent resource where this backup is created.
28
+ # Format: projects/\\{project}
29
+ # @!attribute [rw] backup
30
+ # @return [::Google::Cloud::Sql::V1beta4::Backup]
31
+ # Required. The Backup to create.
32
+ class CreateBackupRequest
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+ end
36
+
37
+ # The request payload to get the backup.
38
+ # @!attribute [rw] name
39
+ # @return [::String]
40
+ # Required. The name of the backup to retrieve.
41
+ # Format: projects/\\{project}/backups/\\{backup}
42
+ class GetBackupRequest
43
+ include ::Google::Protobuf::MessageExts
44
+ extend ::Google::Protobuf::MessageExts::ClassMethods
45
+ end
46
+
47
+ # The request payload to list the backups.
48
+ # @!attribute [rw] parent
49
+ # @return [::String]
50
+ # Required. The parent that owns this collection of backups.
51
+ # Format: projects/\\{project}
52
+ # @!attribute [rw] page_size
53
+ # @return [::Integer]
54
+ # The maximum number of backups to return per response. The service might
55
+ # return fewer backups than this value. If a value for this parameter isn't
56
+ # specified, then, at most, 500 backups are returned. The maximum value is
57
+ # 2,000. Any values that you set, which are greater than 2,000, are changed
58
+ # to 2,000.
59
+ # @!attribute [rw] page_token
60
+ # @return [::String]
61
+ # A page token, received from a previous `ListBackups` call.
62
+ # Provide this to retrieve the subsequent page.
63
+ #
64
+ # When paginating, all other parameters provided to `ListBackups` must match
65
+ # the call that provided the page token.
66
+ # @!attribute [rw] filter
67
+ # @return [::String]
68
+ # Multiple filter queries are separated by spaces. For example,
69
+ # 'instance:abc AND type:FINAL, 'location:us',
70
+ # 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by
71
+ # type, instance, backupInterval.startTime (creation time), or location.
72
+ class ListBackupsRequest
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+ end
76
+
77
+ # The response payload containing a list of the backups.
78
+ # @!attribute [rw] backups
79
+ # @return [::Array<::Google::Cloud::Sql::V1beta4::Backup>]
80
+ # A list of backups.
81
+ # @!attribute [rw] next_page_token
82
+ # @return [::String]
83
+ # A token, which can be sent as `page_token` to retrieve the next page.
84
+ # If this field is omitted, then there aren't subsequent pages.
85
+ # @!attribute [rw] warnings
86
+ # @return [::Array<::Google::Cloud::Sql::V1beta4::ApiWarning>]
87
+ # If a region isn't unavailable or if an unknown error occurs, then a warning
88
+ # message is returned.
89
+ class ListBackupsResponse
90
+ include ::Google::Protobuf::MessageExts
91
+ extend ::Google::Protobuf::MessageExts::ClassMethods
92
+ end
93
+
94
+ # The request payload to update the backup.
95
+ # @!attribute [rw] backup
96
+ # @return [::Google::Cloud::Sql::V1beta4::Backup]
97
+ # Required. The backup to update.
98
+ # The backup’s `name` field is used to identify the backup to update.
99
+ # Format: projects/\\{project}/backups/\\{backup}
100
+ # @!attribute [rw] update_mask
101
+ # @return [::Google::Protobuf::FieldMask]
102
+ # The list of fields that you can update. You can update only the description
103
+ # and retention period of the final backup.
104
+ class UpdateBackupRequest
105
+ include ::Google::Protobuf::MessageExts
106
+ extend ::Google::Protobuf::MessageExts::ClassMethods
107
+ end
108
+
109
+ # The request payload to delete the backup.
110
+ # @!attribute [rw] name
111
+ # @return [::String]
112
+ # Required. The name of the backup to delete.
113
+ # Format: projects/\\{project}/backups/\\{backup}
114
+ class DeleteBackupRequest
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # @!attribute [rw] id
120
+ # @return [::Integer]
121
+ # The ID of the backup run to delete. To find a backup run ID, use the
122
+ # [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/backupRuns/list)
123
+ # method.
124
+ # @!attribute [rw] instance
125
+ # @return [::String]
126
+ # Cloud SQL instance ID. This does not include the project ID.
127
+ # @!attribute [rw] project
128
+ # @return [::String]
129
+ # Project ID of the project that contains the instance.
130
+ class SqlBackupRunsDeleteRequest
131
+ include ::Google::Protobuf::MessageExts
132
+ extend ::Google::Protobuf::MessageExts::ClassMethods
133
+ end
134
+
135
+ # @!attribute [rw] id
136
+ # @return [::Integer]
137
+ # The ID of this backup run.
138
+ # @!attribute [rw] instance
139
+ # @return [::String]
140
+ # Cloud SQL instance ID. This does not include the project ID.
141
+ # @!attribute [rw] project
142
+ # @return [::String]
143
+ # Project ID of the project that contains the instance.
144
+ class SqlBackupRunsGetRequest
145
+ include ::Google::Protobuf::MessageExts
146
+ extend ::Google::Protobuf::MessageExts::ClassMethods
147
+ end
148
+
149
+ # @!attribute [rw] instance
150
+ # @return [::String]
151
+ # Cloud SQL instance ID. This does not include the project ID.
152
+ # @!attribute [rw] project
153
+ # @return [::String]
154
+ # Project ID of the project that contains the instance.
155
+ # @!attribute [rw] body
156
+ # @return [::Google::Cloud::Sql::V1beta4::BackupRun]
157
+ class SqlBackupRunsInsertRequest
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+
162
+ # @!attribute [rw] instance
163
+ # @return [::String]
164
+ # Cloud SQL instance ID, or "-" for all instances. This does not include
165
+ # the project ID.
166
+ # @!attribute [rw] max_results
167
+ # @return [::Integer]
168
+ # Maximum number of backup runs per response.
169
+ # @!attribute [rw] page_token
170
+ # @return [::String]
171
+ # A previously-returned page token representing part of the larger set of
172
+ # results to view.
173
+ # @!attribute [rw] project
174
+ # @return [::String]
175
+ # Project ID of the project that contains the instance.
176
+ class SqlBackupRunsListRequest
177
+ include ::Google::Protobuf::MessageExts
178
+ extend ::Google::Protobuf::MessageExts::ClassMethods
179
+ end
180
+
181
+ # @!attribute [rw] database
182
+ # @return [::String]
183
+ # Name of the database to be deleted in the instance.
184
+ # @!attribute [rw] instance
185
+ # @return [::String]
186
+ # Database instance ID. This does not include the project ID.
187
+ # @!attribute [rw] project
188
+ # @return [::String]
189
+ # Project ID of the project that contains the instance.
190
+ class SqlDatabasesDeleteRequest
191
+ include ::Google::Protobuf::MessageExts
192
+ extend ::Google::Protobuf::MessageExts::ClassMethods
193
+ end
194
+
195
+ # @!attribute [rw] database
196
+ # @return [::String]
197
+ # Name of the database in the instance.
198
+ # @!attribute [rw] instance
199
+ # @return [::String]
200
+ # Database instance ID. This does not include the project ID.
201
+ # @!attribute [rw] project
202
+ # @return [::String]
203
+ # Project ID of the project that contains the instance.
204
+ class SqlDatabasesGetRequest
205
+ include ::Google::Protobuf::MessageExts
206
+ extend ::Google::Protobuf::MessageExts::ClassMethods
207
+ end
208
+
209
+ # @!attribute [rw] instance
210
+ # @return [::String]
211
+ # Database instance ID. This does not include the project ID.
212
+ # @!attribute [rw] project
213
+ # @return [::String]
214
+ # Project ID of the project that contains the instance.
215
+ # @!attribute [rw] body
216
+ # @return [::Google::Cloud::Sql::V1beta4::Database]
217
+ class SqlDatabasesInsertRequest
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+
222
+ # @!attribute [rw] instance
223
+ # @return [::String]
224
+ # Cloud SQL instance ID. This does not include the project ID.
225
+ # @!attribute [rw] project
226
+ # @return [::String]
227
+ # Project ID of the project that contains the instance.
228
+ class SqlDatabasesListRequest
229
+ include ::Google::Protobuf::MessageExts
230
+ extend ::Google::Protobuf::MessageExts::ClassMethods
231
+ end
232
+
233
+ # @!attribute [rw] database
234
+ # @return [::String]
235
+ # Name of the database to be updated in the instance.
236
+ # @!attribute [rw] instance
237
+ # @return [::String]
238
+ # Database instance ID. This does not include the project ID.
239
+ # @!attribute [rw] project
240
+ # @return [::String]
241
+ # Project ID of the project that contains the instance.
242
+ # @!attribute [rw] body
243
+ # @return [::Google::Cloud::Sql::V1beta4::Database]
244
+ class SqlDatabasesUpdateRequest
245
+ include ::Google::Protobuf::MessageExts
246
+ extend ::Google::Protobuf::MessageExts::ClassMethods
247
+ end
248
+
249
+ # @!attribute [rw] database_version
250
+ # @return [::String]
251
+ # Database type and version you want to retrieve flags for. By default, this
252
+ # method returns flags for all database types and versions.
253
+ # @!attribute [rw] flag_scope
254
+ # @return [::Google::Cloud::Sql::V1beta4::SqlFlagScope]
255
+ # Optional. Specify the scope of flags to be returned by SqlFlagsListService.
256
+ # Return list of database flags if unspecified.
257
+ class SqlFlagsListRequest
258
+ include ::Google::Protobuf::MessageExts
259
+ extend ::Google::Protobuf::MessageExts::ClassMethods
260
+ end
261
+
262
+ # @!attribute [rw] instance
263
+ # @return [::String]
264
+ # Cloud SQL instance ID. This does not include the project ID.
265
+ # @!attribute [rw] project
266
+ # @return [::String]
267
+ # Project ID of the project that contains the instance.
268
+ class SqlInstancesAddServerCaRequest
269
+ include ::Google::Protobuf::MessageExts
270
+ extend ::Google::Protobuf::MessageExts::ClassMethods
271
+ end
272
+
273
+ # Request for AddServerCertificate RPC.
274
+ # @!attribute [rw] instance
275
+ # @return [::String]
276
+ # Required. Cloud SQL instance ID. This does not include the project ID.
277
+ # @!attribute [rw] project
278
+ # @return [::String]
279
+ # Required. Project ID of the project that contains the instance.
280
+ class SqlInstancesAddServerCertificateRequest
281
+ include ::Google::Protobuf::MessageExts
282
+ extend ::Google::Protobuf::MessageExts::ClassMethods
283
+ end
284
+
285
+ # Request for AddEntraIdCertificate RPC.
286
+ # @!attribute [rw] instance
287
+ # @return [::String]
288
+ # Required. Cloud SQL instance ID. This does not include the project ID.
289
+ # @!attribute [rw] project
290
+ # @return [::String]
291
+ # Required. Project ID of the project that contains the instance.
292
+ class SqlInstancesAddEntraIdCertificateRequest
293
+ include ::Google::Protobuf::MessageExts
294
+ extend ::Google::Protobuf::MessageExts::ClassMethods
295
+ end
296
+
297
+ # @!attribute [rw] instance
298
+ # @return [::String]
299
+ # The ID of the Cloud SQL instance to be cloned (source). This does not
300
+ # include the project ID.
301
+ # @!attribute [rw] project
302
+ # @return [::String]
303
+ # Project ID of the source Cloud SQL instance.
304
+ # @!attribute [rw] body
305
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesCloneRequest]
306
+ class SqlInstancesCloneRequest
307
+ include ::Google::Protobuf::MessageExts
308
+ extend ::Google::Protobuf::MessageExts::ClassMethods
309
+ end
310
+
311
+ # @!attribute [rw] instance
312
+ # @return [::String]
313
+ # Cloud SQL instance ID. This does not include the project ID.
314
+ # @!attribute [rw] project
315
+ # @return [::String]
316
+ # Project ID of the project that contains the instance to be deleted.
317
+ # @!attribute [rw] enable_final_backup
318
+ # @return [::Boolean]
319
+ # Flag to opt-in for final backup. By default, it is turned off.
320
+ # @!attribute [rw] final_backup_ttl_days
321
+ # @return [::Integer]
322
+ # Optional. Retention period of the final backup.
323
+ #
324
+ # 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.
325
+ # @!attribute [rw] final_backup_expiry_time
326
+ # @return [::Google::Protobuf::Timestamp]
327
+ # Optional. Final Backup expiration time.
328
+ # Timestamp in UTC of when this resource is considered expired.
329
+ #
330
+ # 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.
331
+ # @!attribute [rw] final_backup_description
332
+ # @return [::String]
333
+ # Optional. The description of the final backup.
334
+ class SqlInstancesDeleteRequest
335
+ include ::Google::Protobuf::MessageExts
336
+ extend ::Google::Protobuf::MessageExts::ClassMethods
337
+ end
338
+
339
+ # @!attribute [rw] instance
340
+ # @return [::String]
341
+ # Cloud SQL instance name.
342
+ # @!attribute [rw] project
343
+ # @return [::String]
344
+ # ID of the project that contains the instance.
345
+ # @!attribute [rw] body
346
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesDemoteMasterRequest]
347
+ class SqlInstancesDemoteMasterRequest
348
+ include ::Google::Protobuf::MessageExts
349
+ extend ::Google::Protobuf::MessageExts::ClassMethods
350
+ end
351
+
352
+ # Instance demote request.
353
+ # @!attribute [rw] instance
354
+ # @return [::String]
355
+ # Required. The name of the Cloud SQL instance.
356
+ # @!attribute [rw] project
357
+ # @return [::String]
358
+ # Required. The project ID of the project that contains the instance.
359
+ # @!attribute [rw] body
360
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesDemoteRequest]
361
+ # The request body.
362
+ class SqlInstancesDemoteRequest
363
+ include ::Google::Protobuf::MessageExts
364
+ extend ::Google::Protobuf::MessageExts::ClassMethods
365
+ end
366
+
367
+ # @!attribute [rw] instance
368
+ # @return [::String]
369
+ # The Cloud SQL instance ID. This doesn't include the project ID.
370
+ # @!attribute [rw] project
371
+ # @return [::String]
372
+ # Project ID of the project that contains the instance to be exported.
373
+ # @!attribute [rw] body
374
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesExportRequest]
375
+ class SqlInstancesExportRequest
376
+ include ::Google::Protobuf::MessageExts
377
+ extend ::Google::Protobuf::MessageExts::ClassMethods
378
+ end
379
+
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
+ # ID of the project that contains the read replica.
386
+ # @!attribute [rw] body
387
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesFailoverRequest]
388
+ class SqlInstancesFailoverRequest
389
+ include ::Google::Protobuf::MessageExts
390
+ extend ::Google::Protobuf::MessageExts::ClassMethods
391
+ end
392
+
393
+ # @!attribute [rw] instance
394
+ # @return [::String]
395
+ # Database instance ID. This does not include the project ID.
396
+ # @!attribute [rw] project
397
+ # @return [::String]
398
+ # Project ID of the project that contains the instance.
399
+ class SqlInstancesGetRequest
400
+ include ::Google::Protobuf::MessageExts
401
+ extend ::Google::Protobuf::MessageExts::ClassMethods
402
+ end
403
+
404
+ # @!attribute [rw] instance
405
+ # @return [::String]
406
+ # Cloud SQL instance ID. This does not include the project ID.
407
+ # @!attribute [rw] project
408
+ # @return [::String]
409
+ # Project ID of the project that contains the instance.
410
+ # @!attribute [rw] body
411
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesImportRequest]
412
+ class SqlInstancesImportRequest
413
+ include ::Google::Protobuf::MessageExts
414
+ extend ::Google::Protobuf::MessageExts::ClassMethods
415
+ end
416
+
417
+ # @!attribute [rw] project
418
+ # @return [::String]
419
+ # Project ID of the project to which the newly created Cloud SQL instances
420
+ # should belong.
421
+ # @!attribute [rw] body
422
+ # @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance]
423
+ class SqlInstancesInsertRequest
424
+ include ::Google::Protobuf::MessageExts
425
+ extend ::Google::Protobuf::MessageExts::ClassMethods
426
+ end
427
+
428
+ # @!attribute [rw] filter
429
+ # @return [::String]
430
+ # A filter expression that filters resources listed in the response.
431
+ # The expression is in the form of field:value. For example,
432
+ # 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per
433
+ # their JSON representation, such as 'settings.userLabels.auto_start:true'.
434
+ #
435
+ # Multiple filter queries are space-separated. For example.
436
+ # 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each
437
+ # expression is an AND expression. However, you can include AND and OR
438
+ # expressions explicitly.
439
+ # @!attribute [rw] max_results
440
+ # @return [::Integer]
441
+ # The maximum number of instances to return. The service may return fewer
442
+ # than this value.
443
+ # If unspecified, at most 500 instances are returned.
444
+ # The maximum value is 1000; values above 1000 are coerced to 1000.
445
+ # @!attribute [rw] page_token
446
+ # @return [::String]
447
+ # A previously-returned page token representing part of the larger set of
448
+ # results to view.
449
+ # @!attribute [rw] project
450
+ # @return [::String]
451
+ # Project ID of the project for which to list Cloud SQL instances.
452
+ class SqlInstancesListRequest
453
+ include ::Google::Protobuf::MessageExts
454
+ extend ::Google::Protobuf::MessageExts::ClassMethods
455
+ end
456
+
457
+ # @!attribute [rw] instance
458
+ # @return [::String]
459
+ # Cloud SQL instance ID. This does not include the project ID.
460
+ # @!attribute [rw] project
461
+ # @return [::String]
462
+ # Project ID of the project that contains the instance.
463
+ class SqlInstancesListServerCasRequest
464
+ include ::Google::Protobuf::MessageExts
465
+ extend ::Google::Protobuf::MessageExts::ClassMethods
466
+ end
467
+
468
+ # @!attribute [rw] instance
469
+ # @return [::String]
470
+ # Required. Cloud SQL instance ID. This does not include the project ID.
471
+ # @!attribute [rw] project
472
+ # @return [::String]
473
+ # Required. Project ID of the project that contains the instance.
474
+ class SqlInstancesListServerCertificatesRequest
475
+ include ::Google::Protobuf::MessageExts
476
+ extend ::Google::Protobuf::MessageExts::ClassMethods
477
+ end
478
+
479
+ # Request message for SqlInstancesService.ListEntraIdCertificates.
480
+ # @!attribute [rw] instance
481
+ # @return [::String]
482
+ # Required. Cloud SQL instance ID. This does not include the project ID.
483
+ # @!attribute [rw] project
484
+ # @return [::String]
485
+ # Required. Project ID of the project that contains the instance.
486
+ class SqlInstancesListEntraIdCertificatesRequest
487
+ include ::Google::Protobuf::MessageExts
488
+ extend ::Google::Protobuf::MessageExts::ClassMethods
489
+ end
490
+
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
+ # Project ID of the project that contains the instance.
497
+ # @!attribute [rw] reconcile_psc_networking
498
+ # @return [::Boolean]
499
+ # Optional. Set PSC config to the same value as the existing config to
500
+ # reconcile the PSC networking.
501
+ # @!attribute [rw] reconcile_psc_networking_force
502
+ # @return [::Boolean]
503
+ # Optional. Set PSC config to the same value as the existing config and force
504
+ # reconcile the PSC networking.
505
+ # @!attribute [rw] body
506
+ # @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance]
507
+ class SqlInstancesPatchRequest
508
+ include ::Google::Protobuf::MessageExts
509
+ extend ::Google::Protobuf::MessageExts::ClassMethods
510
+ end
511
+
512
+ # @!attribute [rw] instance
513
+ # @return [::String]
514
+ # Cloud SQL read replica instance name.
515
+ # @!attribute [rw] project
516
+ # @return [::String]
517
+ # ID of the project that contains the read replica.
518
+ # @!attribute [rw] failover
519
+ # @return [::Boolean]
520
+ # Set to true to invoke a replica failover to the DR replica.
521
+ # As part of replica failover, the promote operation attempts
522
+ # to add the original primary instance as a replica of the promoted
523
+ # DR replica when the original primary instance comes back online.
524
+ # If set to false or not specified, then the original primary
525
+ # instance becomes an independent Cloud SQL primary instance.
526
+ class SqlInstancesPromoteReplicaRequest
527
+ include ::Google::Protobuf::MessageExts
528
+ extend ::Google::Protobuf::MessageExts::ClassMethods
529
+ end
530
+
531
+ # Instance switchover request.
532
+ # @!attribute [rw] instance
533
+ # @return [::String]
534
+ # Cloud SQL read replica instance name.
535
+ # @!attribute [rw] project
536
+ # @return [::String]
537
+ # ID of the project that contains the replica.
538
+ # @!attribute [rw] db_timeout
539
+ # @return [::Google::Protobuf::Duration]
540
+ # Optional. (MySQL and PostgreSQL only) Cloud SQL instance operations
541
+ # timeout, which is a sum of all database operations. Default value is 10
542
+ # minutes and can be modified to a maximum value of 24 hours.
543
+ class SqlInstancesSwitchoverRequest
544
+ include ::Google::Protobuf::MessageExts
545
+ extend ::Google::Protobuf::MessageExts::ClassMethods
546
+ end
547
+
548
+ # @!attribute [rw] instance
549
+ # @return [::String]
550
+ # Cloud SQL instance ID. This does not include the project ID.
551
+ # @!attribute [rw] project
552
+ # @return [::String]
553
+ # Project ID of the project that contains the instance.
554
+ # @!attribute [rw] mode
555
+ # @return [::Google::Cloud::Sql::V1beta4::SqlInstancesResetSslConfigRequest::ResetSslMode]
556
+ # Optional. Reset SSL mode to use.
557
+ class SqlInstancesResetSslConfigRequest
558
+ include ::Google::Protobuf::MessageExts
559
+ extend ::Google::Protobuf::MessageExts::ClassMethods
560
+
561
+ # Reset SSL mode to selectively refresh the SSL materials.
562
+ module ResetSslMode
563
+ # Reset SSL mode is not specified.
564
+ RESET_SSL_MODE_UNSPECIFIED = 0
565
+
566
+ # Refresh all TLS configs. This is the default behaviour.
567
+ ALL = 1
568
+
569
+ # Refreshes the replication-related TLS configuration settings provided by
570
+ # the primary instance.
571
+ # Not applicable to on-premises replication instances.
572
+ SYNC_FROM_PRIMARY = 2
573
+ end
574
+ end
575
+
576
+ # @!attribute [rw] instance
577
+ # @return [::String]
578
+ # Cloud SQL instance ID. This does not include the project ID.
579
+ # @!attribute [rw] project
580
+ # @return [::String]
581
+ # Project ID of the project that contains the instance to be restarted.
582
+ class SqlInstancesRestartRequest
583
+ include ::Google::Protobuf::MessageExts
584
+ extend ::Google::Protobuf::MessageExts::ClassMethods
585
+ end
586
+
587
+ # @!attribute [rw] instance
588
+ # @return [::String]
589
+ # Cloud SQL instance ID. This does not include the project ID.
590
+ # @!attribute [rw] project
591
+ # @return [::String]
592
+ # Project ID of the project that contains the instance.
593
+ # @!attribute [rw] body
594
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesRestoreBackupRequest]
595
+ class SqlInstancesRestoreBackupRequest
596
+ include ::Google::Protobuf::MessageExts
597
+ extend ::Google::Protobuf::MessageExts::ClassMethods
598
+ end
599
+
600
+ # @!attribute [rw] instance
601
+ # @return [::String]
602
+ # Cloud SQL instance ID. This does not include the project ID.
603
+ # @!attribute [rw] project
604
+ # @return [::String]
605
+ # Project ID of the project that contains the instance.
606
+ # @!attribute [rw] body
607
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesRotateServerCaRequest]
608
+ class SqlInstancesRotateServerCaRequest
609
+ include ::Google::Protobuf::MessageExts
610
+ extend ::Google::Protobuf::MessageExts::ClassMethods
611
+ end
612
+
613
+ # @!attribute [rw] instance
614
+ # @return [::String]
615
+ # Required. Cloud SQL instance ID. This does not include the project ID.
616
+ # @!attribute [rw] project
617
+ # @return [::String]
618
+ # Required. Project ID of the project that contains the instance.
619
+ # @!attribute [rw] body
620
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesRotateServerCertificateRequest]
621
+ # Required. Rotate server certificate request body.
622
+ class SqlInstancesRotateServerCertificateRequest
623
+ include ::Google::Protobuf::MessageExts
624
+ extend ::Google::Protobuf::MessageExts::ClassMethods
625
+ end
626
+
627
+ # Request message for SqlInstancesService.RotateEntraIdCertificate.
628
+ # @!attribute [rw] instance
629
+ # @return [::String]
630
+ # Required. Cloud SQL instance ID. This does not include the project ID.
631
+ # @!attribute [rw] project
632
+ # @return [::String]
633
+ # Required. Project ID of the project that contains the instance.
634
+ # @!attribute [rw] body
635
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesRotateEntraIdCertificateRequest]
636
+ # Required. Rotate Entra ID certificate request body.
637
+ class SqlInstancesRotateEntraIdCertificateRequest
638
+ include ::Google::Protobuf::MessageExts
639
+ extend ::Google::Protobuf::MessageExts::ClassMethods
640
+ end
641
+
642
+ # @!attribute [rw] instance
643
+ # @return [::String]
644
+ # Cloud SQL read replica instance name.
645
+ # @!attribute [rw] project
646
+ # @return [::String]
647
+ # ID of the project that contains the read replica.
648
+ class SqlInstancesStartReplicaRequest
649
+ include ::Google::Protobuf::MessageExts
650
+ extend ::Google::Protobuf::MessageExts::ClassMethods
651
+ end
652
+
653
+ # @!attribute [rw] instance
654
+ # @return [::String]
655
+ # Cloud SQL read replica instance name.
656
+ # @!attribute [rw] project
657
+ # @return [::String]
658
+ # ID of the project that contains the read replica.
659
+ class SqlInstancesStopReplicaRequest
660
+ include ::Google::Protobuf::MessageExts
661
+ extend ::Google::Protobuf::MessageExts::ClassMethods
662
+ end
663
+
664
+ # @!attribute [rw] instance
665
+ # @return [::String]
666
+ # Cloud SQL instance ID. This does not include the project ID.
667
+ # @!attribute [rw] project
668
+ # @return [::String]
669
+ # Project ID of the Cloud SQL project.
670
+ # @!attribute [rw] body
671
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesTruncateLogRequest]
672
+ class SqlInstancesTruncateLogRequest
673
+ include ::Google::Protobuf::MessageExts
674
+ extend ::Google::Protobuf::MessageExts::ClassMethods
675
+ end
676
+
677
+ # @!attribute [rw] instance
678
+ # @return [::String]
679
+ # Cloud SQL instance ID. This does not include the project ID.
680
+ # @!attribute [rw] project
681
+ # @return [::String]
682
+ # Project ID of the project that contains the instance.
683
+ # @!attribute [rw] body
684
+ # @return [::Google::Cloud::Sql::V1beta4::DatabaseInstance]
685
+ class SqlInstancesUpdateRequest
686
+ include ::Google::Protobuf::MessageExts
687
+ extend ::Google::Protobuf::MessageExts::ClassMethods
688
+ end
689
+
690
+ # Instance reencrypt request.
691
+ # @!attribute [rw] instance
692
+ # @return [::String]
693
+ # Cloud SQL instance ID. This does not include the project ID.
694
+ # @!attribute [rw] project
695
+ # @return [::String]
696
+ # ID of the project that contains the instance.
697
+ # @!attribute [rw] body
698
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesReencryptRequest]
699
+ # Reencrypt body that users request
700
+ class SqlInstancesReencryptRequest
701
+ include ::Google::Protobuf::MessageExts
702
+ extend ::Google::Protobuf::MessageExts::ClassMethods
703
+ end
704
+
705
+ # Database Instance reencrypt request.
706
+ # @!attribute [rw] backup_reencryption_config
707
+ # @return [::Google::Cloud::Sql::V1beta4::BackupReencryptionConfig]
708
+ # Configuration specific to backup re-encryption
709
+ class InstancesReencryptRequest
710
+ include ::Google::Protobuf::MessageExts
711
+ extend ::Google::Protobuf::MessageExts::ClassMethods
712
+ end
713
+
714
+ # Backup Reencryption Config
715
+ # @!attribute [rw] backup_limit
716
+ # @return [::Integer]
717
+ # Backup re-encryption limit
718
+ # @!attribute [rw] backup_type
719
+ # @return [::Google::Cloud::Sql::V1beta4::BackupReencryptionConfig::BackupType]
720
+ # Type of backups users want to re-encrypt.
721
+ class BackupReencryptionConfig
722
+ include ::Google::Protobuf::MessageExts
723
+ extend ::Google::Protobuf::MessageExts::ClassMethods
724
+
725
+ # Backup type for re-encryption
726
+ module BackupType
727
+ # Unknown backup type, will be defaulted to AUTOMATIC backup type
728
+ BACKUP_TYPE_UNSPECIFIED = 0
729
+
730
+ # Reencrypt automatic backups
731
+ AUTOMATED = 1
732
+
733
+ # Reencrypt on-demand backups
734
+ ON_DEMAND = 2
735
+ end
736
+ end
737
+
738
+ # @!attribute [rw] instance
739
+ # @return [::String]
740
+ # Cloud SQL instance ID. This does not include the project ID.
741
+ # @!attribute [rw] project
742
+ # @return [::String]
743
+ # ID of the project that contains the instance.
744
+ # @!attribute [rw] body
745
+ # @return [::Google::Cloud::Sql::V1beta4::SqlInstancesRescheduleMaintenanceRequestBody]
746
+ class SqlInstancesRescheduleMaintenanceRequest
747
+ include ::Google::Protobuf::MessageExts
748
+ extend ::Google::Protobuf::MessageExts::ClassMethods
749
+ end
750
+
751
+ # Instance perform disk shrink request.
752
+ # @!attribute [rw] instance
753
+ # @return [::String]
754
+ # Cloud SQL instance ID. This does not include the project ID.
755
+ # @!attribute [rw] project
756
+ # @return [::String]
757
+ # Project ID of the project that contains the instance.
758
+ # @!attribute [rw] body
759
+ # @return [::Google::Cloud::Sql::V1beta4::PerformDiskShrinkContext]
760
+ # Perform disk shrink context.
761
+ class SqlInstancesPerformDiskShrinkRequest
762
+ include ::Google::Protobuf::MessageExts
763
+ extend ::Google::Protobuf::MessageExts::ClassMethods
764
+ end
765
+
766
+ # The selected object that Cloud SQL migrates.
767
+ # @!attribute [rw] database
768
+ # @return [::String]
769
+ # The name of the database that Cloud SQL migrates.
770
+ class ExternalSyncSelectedObject
771
+ include ::Google::Protobuf::MessageExts
772
+ extend ::Google::Protobuf::MessageExts::ClassMethods
773
+ end
774
+
775
+ # @!attribute [rw] instance
776
+ # @return [::String]
777
+ # Cloud SQL instance ID. This does not include the project ID.
778
+ # @!attribute [rw] project
779
+ # @return [::String]
780
+ # Project ID of the project that contains the instance.
781
+ # @!attribute [rw] verify_connection_only
782
+ # @return [::Boolean]
783
+ # Flag to enable verifying connection only
784
+ # @!attribute [rw] sync_mode
785
+ # @return [::Google::Cloud::Sql::V1beta4::SqlInstancesVerifyExternalSyncSettingsRequest::ExternalSyncMode]
786
+ # External sync mode
787
+ # @!attribute [rw] verify_replication_only
788
+ # @return [::Boolean]
789
+ # Optional. Flag to verify settings required by replication setup only
790
+ # @!attribute [rw] mysql_sync_config
791
+ # @return [::Google::Cloud::Sql::V1beta4::MySqlSyncConfig]
792
+ # Optional. MySQL-specific settings for start external sync.
793
+ # @!attribute [rw] migration_type
794
+ # @return [::Google::Cloud::Sql::V1beta4::SqlInstancesVerifyExternalSyncSettingsRequest::MigrationType]
795
+ # Optional. MigrationType configures the migration to use physical files or
796
+ # logical dump files. If not set, then the logical dump file configuration is
797
+ # used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.
798
+ # @!attribute [rw] sync_parallel_level
799
+ # @return [::Google::Cloud::Sql::V1beta4::ExternalSyncParallelLevel]
800
+ # Optional. Parallel level for initial data sync. Only applicable for
801
+ # PostgreSQL.
802
+ # @!attribute [rw] selected_objects
803
+ # @return [::Array<::Google::Cloud::Sql::V1beta4::ExternalSyncSelectedObject>]
804
+ # Optional. Migrate only the specified objects from the source instance. If
805
+ # this field is empty, then migrate all objects.
806
+ class SqlInstancesVerifyExternalSyncSettingsRequest
807
+ include ::Google::Protobuf::MessageExts
808
+ extend ::Google::Protobuf::MessageExts::ClassMethods
809
+
810
+ module ExternalSyncMode
811
+ # Unknown external sync mode, will be defaulted to ONLINE mode
812
+ EXTERNAL_SYNC_MODE_UNSPECIFIED = 0
813
+
814
+ # Online external sync will set up replication after initial data external
815
+ # sync
816
+ ONLINE = 1
817
+
818
+ # Offline external sync only dumps and loads a one-time snapshot of
819
+ # the primary instance's data
820
+ OFFLINE = 2
821
+ end
822
+
823
+ # MigrationType determines whether the migration is a physical file-based
824
+ # migration or a logical dump file-based migration.
825
+ module MigrationType
826
+ # Default value is a logical dump file-based migration
827
+ MIGRATION_TYPE_UNSPECIFIED = 0
828
+
829
+ # Logical dump file-based migration
830
+ LOGICAL = 1
831
+
832
+ # Physical file-based migration
833
+ PHYSICAL = 2
834
+ end
835
+ end
836
+
837
+ # @!attribute [rw] instance
838
+ # @return [::String]
839
+ # Cloud SQL instance ID. This does not include the project ID.
840
+ # @!attribute [rw] project
841
+ # @return [::String]
842
+ # ID of the project that contains the instance.
843
+ # @!attribute [rw] sync_mode
844
+ # @return [::Google::Cloud::Sql::V1beta4::SqlInstancesVerifyExternalSyncSettingsRequest::ExternalSyncMode]
845
+ # External sync mode.
846
+ # @!attribute [rw] skip_verification
847
+ # @return [::Boolean]
848
+ # Whether to skip the verification step (VESS).
849
+ # @!attribute [rw] mysql_sync_config
850
+ # @return [::Google::Cloud::Sql::V1beta4::MySqlSyncConfig]
851
+ # MySQL-specific settings for start external sync.
852
+ # @!attribute [rw] sync_parallel_level
853
+ # @return [::Google::Cloud::Sql::V1beta4::ExternalSyncParallelLevel]
854
+ # Optional. Parallel level for initial data sync. Currently only applicable
855
+ # for MySQL.
856
+ # @!attribute [rw] migration_type
857
+ # @return [::Google::Cloud::Sql::V1beta4::SqlInstancesVerifyExternalSyncSettingsRequest::MigrationType]
858
+ # Optional. MigrationType configures the migration to use physical files or
859
+ # logical dump files. If not set, then the logical dump file configuration is
860
+ # used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.
861
+ # @!attribute [rw] replica_overwrite_enabled
862
+ # @return [::Boolean]
863
+ # Optional. MySQL only. True if end-user has confirmed that this SES call
864
+ # will wipe replica databases overlapping with the proposed selected_objects.
865
+ # If this field is not set and there are both overlapping and additional
866
+ # databases proposed, an error will be returned.
867
+ class SqlInstancesStartExternalSyncRequest
868
+ include ::Google::Protobuf::MessageExts
869
+ extend ::Google::Protobuf::MessageExts::ClassMethods
870
+ end
871
+
872
+ # Instance reset replica size request.
873
+ # @!attribute [rw] instance
874
+ # @return [::String]
875
+ # Cloud SQL read replica instance name.
876
+ # @!attribute [rw] project
877
+ # @return [::String]
878
+ # ID of the project that contains the read replica.
879
+ class SqlInstancesResetReplicaSizeRequest
880
+ include ::Google::Protobuf::MessageExts
881
+ extend ::Google::Protobuf::MessageExts::ClassMethods
882
+ end
883
+
884
+ # @!attribute [rw] operation
885
+ # @return [::String]
886
+ # Instance operation ID.
887
+ # @!attribute [rw] project
888
+ # @return [::String]
889
+ # Project ID of the project that contains the instance.
890
+ # @!attribute [rw] location
891
+ # @return [::String]
892
+ # Optional. Region of the Cloud SQL instance.
893
+ class SqlOperationsGetRequest
894
+ include ::Google::Protobuf::MessageExts
895
+ extend ::Google::Protobuf::MessageExts::ClassMethods
896
+ end
897
+
898
+ # @!attribute [rw] instance
899
+ # @return [::String]
900
+ # Cloud SQL instance ID. This does not include the project ID.
901
+ # @!attribute [rw] max_results
902
+ # @return [::Integer]
903
+ # Maximum number of operations per response.
904
+ # @!attribute [rw] page_token
905
+ # @return [::String]
906
+ # A previously-returned page token representing part of the larger set of
907
+ # results to view.
908
+ # @!attribute [rw] project
909
+ # @return [::String]
910
+ # Project ID of the project that contains the instance.
911
+ # @!attribute [rw] location
912
+ # @return [::String]
913
+ # Optional. Region of the Cloud SQL instance.
914
+ class SqlOperationsListRequest
915
+ include ::Google::Protobuf::MessageExts
916
+ extend ::Google::Protobuf::MessageExts::ClassMethods
917
+ end
918
+
919
+ # The request payload to cancel an operation.
920
+ # @!attribute [rw] operation
921
+ # @return [::String]
922
+ # Instance operation ID.
923
+ # @!attribute [rw] project
924
+ # @return [::String]
925
+ # Project ID of the project that contains the instance.
926
+ # @!attribute [rw] location
927
+ # @return [::String]
928
+ # Optional. Region of the Cloud SQL instance.
929
+ class SqlOperationsCancelRequest
930
+ include ::Google::Protobuf::MessageExts
931
+ extend ::Google::Protobuf::MessageExts::ClassMethods
932
+ end
933
+
934
+ # @!attribute [rw] instance
935
+ # @return [::String]
936
+ # Cloud SQL instance ID. This does not include the project ID.
937
+ # @!attribute [rw] project
938
+ # @return [::String]
939
+ # Project ID of the Cloud SQL project.
940
+ # @!attribute [rw] body
941
+ # @return [::Google::Cloud::Sql::V1beta4::SslCertsCreateEphemeralRequest]
942
+ class SqlInstancesCreateEphemeralCertRequest
943
+ include ::Google::Protobuf::MessageExts
944
+ extend ::Google::Protobuf::MessageExts::ClassMethods
945
+ end
946
+
947
+ # @!attribute [rw] instance
948
+ # @return [::String]
949
+ # Cloud SQL instance ID. This does not include the project ID.
950
+ # @!attribute [rw] project
951
+ # @return [::String]
952
+ # Project ID of the project that contains the instance.
953
+ # @!attribute [rw] sha1_fingerprint
954
+ # @return [::String]
955
+ # Sha1 FingerPrint.
956
+ class SqlSslCertsDeleteRequest
957
+ include ::Google::Protobuf::MessageExts
958
+ extend ::Google::Protobuf::MessageExts::ClassMethods
959
+ end
960
+
961
+ # @!attribute [rw] instance
962
+ # @return [::String]
963
+ # Cloud SQL instance ID. This does not include the project ID.
964
+ # @!attribute [rw] project
965
+ # @return [::String]
966
+ # Project ID of the project that contains the instance.
967
+ # @!attribute [rw] sha1_fingerprint
968
+ # @return [::String]
969
+ # Sha1 FingerPrint.
970
+ class SqlSslCertsGetRequest
971
+ include ::Google::Protobuf::MessageExts
972
+ extend ::Google::Protobuf::MessageExts::ClassMethods
973
+ end
974
+
975
+ # @!attribute [rw] instance
976
+ # @return [::String]
977
+ # Cloud SQL instance ID. This does not include the project ID.
978
+ # @!attribute [rw] project
979
+ # @return [::String]
980
+ # Project ID of the project that contains the instance.
981
+ # @!attribute [rw] body
982
+ # @return [::Google::Cloud::Sql::V1beta4::SslCertsInsertRequest]
983
+ class SqlSslCertsInsertRequest
984
+ include ::Google::Protobuf::MessageExts
985
+ extend ::Google::Protobuf::MessageExts::ClassMethods
986
+ end
987
+
988
+ # @!attribute [rw] instance
989
+ # @return [::String]
990
+ # Cloud SQL instance ID. This does not include the project ID.
991
+ # @!attribute [rw] project
992
+ # @return [::String]
993
+ # Project ID of the project that contains the instance.
994
+ class SqlSslCertsListRequest
995
+ include ::Google::Protobuf::MessageExts
996
+ extend ::Google::Protobuf::MessageExts::ClassMethods
997
+ end
998
+
999
+ # Instance get disk shrink config request.
1000
+ # @!attribute [rw] instance
1001
+ # @return [::String]
1002
+ # Cloud SQL instance ID. This does not include the project ID.
1003
+ # @!attribute [rw] project
1004
+ # @return [::String]
1005
+ # Project ID of the project that contains the instance.
1006
+ class SqlInstancesGetDiskShrinkConfigRequest
1007
+ include ::Google::Protobuf::MessageExts
1008
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1009
+ end
1010
+
1011
+ # Instance get latest recovery time request.
1012
+ # @!attribute [rw] instance
1013
+ # @return [::String]
1014
+ # Cloud SQL instance ID. This does not include the project ID.
1015
+ # @!attribute [rw] project
1016
+ # @return [::String]
1017
+ # Project ID of the project that contains the instance.
1018
+ # @!attribute [rw] source_instance_deletion_time
1019
+ # @return [::Google::Protobuf::Timestamp]
1020
+ # The timestamp used to identify the time when the source instance is
1021
+ # deleted. If this instance is deleted, then you must set the timestamp.
1022
+ class SqlInstancesGetLatestRecoveryTimeRequest
1023
+ include ::Google::Protobuf::MessageExts
1024
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1025
+ end
1026
+
1027
+ # Instance get latest recovery time response.
1028
+ # @!attribute [rw] kind
1029
+ # @return [::String]
1030
+ # This is always `sql#getLatestRecoveryTime`.
1031
+ # @!attribute [rw] latest_recovery_time
1032
+ # @return [::Google::Protobuf::Timestamp]
1033
+ # Timestamp, identifies the latest recovery time of the source instance.
1034
+ # @!attribute [rw] earliest_recovery_time
1035
+ # @return [::Google::Protobuf::Timestamp]
1036
+ # Timestamp, identifies the earliest recovery time of the source instance.
1037
+ class SqlInstancesGetLatestRecoveryTimeResponse
1038
+ include ::Google::Protobuf::MessageExts
1039
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1040
+ end
1041
+
1042
+ # Execute SQL statements request.
1043
+ # @!attribute [rw] instance
1044
+ # @return [::String]
1045
+ # Required. Database instance ID. This does not include the project ID.
1046
+ # @!attribute [rw] project
1047
+ # @return [::String]
1048
+ # Required. Project ID of the project that contains the instance.
1049
+ # @!attribute [rw] body
1050
+ # @return [::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload]
1051
+ # The request body.
1052
+ class SqlInstancesExecuteSqlRequest
1053
+ include ::Google::Protobuf::MessageExts
1054
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1055
+ end
1056
+
1057
+ # Request to release a lease for SSRS.
1058
+ # @!attribute [rw] instance
1059
+ # @return [::String]
1060
+ # Required. The Cloud SQL instance ID. This doesn't include the project ID.
1061
+ # It's composed of lowercase letters, numbers, and hyphens, and it must start
1062
+ # with a letter. The total length must be 98 characters or less (Example:
1063
+ # instance-id).
1064
+ # @!attribute [rw] project
1065
+ # @return [::String]
1066
+ # Required. The ID of the project that contains the instance (Example:
1067
+ # project-id).
1068
+ class SqlInstancesReleaseSsrsLeaseRequest
1069
+ include ::Google::Protobuf::MessageExts
1070
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1071
+ end
1072
+
1073
+ # The response for the release of the SSRS lease.
1074
+ # @!attribute [rw] operation_id
1075
+ # @return [::String]
1076
+ # The operation ID.
1077
+ class SqlInstancesReleaseSsrsLeaseResponse
1078
+ include ::Google::Protobuf::MessageExts
1079
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1080
+ end
1081
+
1082
+ # The request payload used to execute SQL statements.
1083
+ # @!attribute [rw] user
1084
+ # @return [::String]
1085
+ # Optional. The name of an existing database user to connect to the database.
1086
+ # When `auto_iam_authn` is set to true, this field is ignored and the API
1087
+ # caller's IAM user is used.
1088
+ # @!attribute [rw] sql_statement
1089
+ # @return [::String]
1090
+ # Required. SQL statements to run on the database. It can be a single
1091
+ # statement or a sequence of statements separated by semicolons.
1092
+ # @!attribute [rw] database
1093
+ # @return [::String]
1094
+ # Optional. Name of the database on which the statement will be executed.
1095
+ # @!attribute [rw] password_secret_version
1096
+ # @return [::String]
1097
+ # Optional. The resource name of the Secret Manager secret holding the
1098
+ # password for the user to log into the database. The secret should be
1099
+ # created using the regional endpoint (for API) or from the Regional
1100
+ # Secrets page (for UI), and stored in the same region as the Cloud SQL
1101
+ # instance. The expected resource name format is
1102
+ # `projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}`.
1103
+ # This field is used together with the `user` field.
1104
+ # The secret resource name will not be stored.
1105
+ #
1106
+ # Note: The following fields are mutually exclusive: `password_secret_version`, `auto_iam_authn`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1107
+ # @!attribute [rw] auto_iam_authn
1108
+ # @return [::Boolean]
1109
+ # Optional. When set to true, the API caller identity associated with the
1110
+ # request is used for database authentication. The API caller must be an
1111
+ # IAM user in the database.
1112
+ #
1113
+ # Note: The following fields are mutually exclusive: `auto_iam_authn`, `password_secret_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1114
+ # @!attribute [rw] row_limit
1115
+ # @return [::Integer]
1116
+ # Optional. The maximum number of rows returned per SQL statement.
1117
+ # @!attribute [rw] partial_result_mode
1118
+ # @return [::Google::Cloud::Sql::V1beta4::ExecuteSqlPayload::PartialResultMode]
1119
+ # Optional. Controls how the API should respond when the SQL execution result
1120
+ # is incomplete due to the size limit or another error. The default mode is
1121
+ # to throw an error.
1122
+ # @!attribute [rw] application
1123
+ # @return [::String]
1124
+ # Optional. Specifies the name of the application that is making the request.
1125
+ # This field is used for telemetry. Only alphanumeric characters, dashes, and
1126
+ # underscores are allowed. The maximum length is 32 characters.
1127
+ class ExecuteSqlPayload
1128
+ include ::Google::Protobuf::MessageExts
1129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1130
+
1131
+ # Controls how the API should respond when the SQL execution result exceeds
1132
+ # 10 MB.
1133
+ module PartialResultMode
1134
+ # Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.
1135
+ PARTIAL_RESULT_MODE_UNSPECIFIED = 0
1136
+
1137
+ # Throw an error if the result exceeds 10 MB or if only a partial result
1138
+ # can be retrieved. Don't return the result.
1139
+ FAIL_PARTIAL_RESULT = 1
1140
+
1141
+ # Return a truncated result and set `partial_result` to true if the result
1142
+ # exceeds 10 MB or if only a partial result can be retrieved due to error.
1143
+ # Don't throw an error.
1144
+ ALLOW_PARTIAL_RESULT = 2
1145
+ end
1146
+ end
1147
+
1148
+ # Execute SQL statements response.
1149
+ # @!attribute [rw] messages
1150
+ # @return [::Array<::Google::Cloud::Sql::V1beta4::SqlInstancesExecuteSqlResponse::Message>]
1151
+ # A list of notices and warnings generated during query execution.
1152
+ # For PostgreSQL, this includes all notices and warnings.
1153
+ # For MySQL, this includes warnings generated by the last executed statement.
1154
+ # To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must
1155
+ # be executed after each statement.
1156
+ # @!attribute [rw] metadata
1157
+ # @return [::Google::Cloud::Sql::V1beta4::Metadata]
1158
+ # The additional metadata information regarding the execution of the SQL
1159
+ # statements.
1160
+ # @!attribute [rw] results
1161
+ # @return [::Array<::Google::Cloud::Sql::V1beta4::QueryResult>]
1162
+ # The list of results after executing all the SQL statements.
1163
+ # @!attribute [rw] status
1164
+ # @return [::Google::Rpc::Status]
1165
+ # Contains the error from the database if the SQL execution failed.
1166
+ class SqlInstancesExecuteSqlResponse
1167
+ include ::Google::Protobuf::MessageExts
1168
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1169
+
1170
+ # Represents a notice or warning message from the database.
1171
+ # @!attribute [rw] message
1172
+ # @return [::String]
1173
+ # The full message string.
1174
+ # For PostgreSQL, this is a formatted string that may include severity,
1175
+ # code, and the notice/warning message.
1176
+ # For MySQL, this contains the warning message.
1177
+ # @!attribute [rw] severity
1178
+ # @return [::String]
1179
+ # The severity of the message (e.g., "NOTICE" for PostgreSQL, "WARNING" for
1180
+ # MySQL).
1181
+ class Message
1182
+ include ::Google::Protobuf::MessageExts
1183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1184
+ end
1185
+ end
1186
+
1187
+ # QueryResult contains the result of executing a single SQL statement.
1188
+ # @!attribute [rw] columns
1189
+ # @return [::Array<::Google::Cloud::Sql::V1beta4::Column>]
1190
+ # List of columns included in the result. This also includes the data type
1191
+ # of the column.
1192
+ # @!attribute [rw] rows
1193
+ # @return [::Array<::Google::Cloud::Sql::V1beta4::Row>]
1194
+ # Rows returned by the SQL statement.
1195
+ # @!attribute [rw] message
1196
+ # @return [::String]
1197
+ # Message related to the SQL execution result.
1198
+ # @!attribute [rw] partial_result
1199
+ # @return [::Boolean]
1200
+ # Set to true if the SQL execution's result is truncated due to size limits
1201
+ # or an error retrieving results.
1202
+ # @!attribute [rw] status
1203
+ # @return [::Google::Rpc::Status]
1204
+ # If results were truncated due to an error, details of that error.
1205
+ class QueryResult
1206
+ include ::Google::Protobuf::MessageExts
1207
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1208
+ end
1209
+
1210
+ # Contains the name and datatype of a column.
1211
+ # @!attribute [rw] name
1212
+ # @return [::String]
1213
+ # Name of the column.
1214
+ # @!attribute [rw] type
1215
+ # @return [::String]
1216
+ # Datatype of the column.
1217
+ class Column
1218
+ include ::Google::Protobuf::MessageExts
1219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1220
+ end
1221
+
1222
+ # Contains the values for a row.
1223
+ # @!attribute [rw] values
1224
+ # @return [::Array<::Google::Cloud::Sql::V1beta4::Value>]
1225
+ # The values for the row.
1226
+ class Row
1227
+ include ::Google::Protobuf::MessageExts
1228
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1229
+ end
1230
+
1231
+ # The cell value of the table.
1232
+ # @!attribute [rw] value
1233
+ # @return [::String]
1234
+ # The cell value represented in string format.
1235
+ # @!attribute [rw] null_value
1236
+ # @return [::Boolean]
1237
+ # If cell value is null, then this flag will be set to true.
1238
+ class Value
1239
+ include ::Google::Protobuf::MessageExts
1240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1241
+ end
1242
+
1243
+ # The additional metadata information regarding the execution of the SQL
1244
+ # statements.
1245
+ # @!attribute [rw] sql_statement_execution_time
1246
+ # @return [::Google::Protobuf::Duration]
1247
+ # The time taken to execute the SQL statements.
1248
+ class Metadata
1249
+ include ::Google::Protobuf::MessageExts
1250
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1251
+ end
1252
+
1253
+ # Request to acquire a lease for SSRS.
1254
+ # @!attribute [rw] instance
1255
+ # @return [::String]
1256
+ # Required. Cloud SQL instance ID. This doesn't include the project ID. It's
1257
+ # composed of lowercase letters, numbers, and hyphens, and it must start with
1258
+ # a letter. The total length must be 98 characters or less (Example:
1259
+ # instance-id).
1260
+ # @!attribute [rw] project
1261
+ # @return [::String]
1262
+ # Required. ID of the project that contains the instance (Example:
1263
+ # project-id).
1264
+ # @!attribute [rw] body
1265
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesAcquireSsrsLeaseRequest]
1266
+ # The body for request to acquire an SSRS lease.
1267
+ class SqlInstancesAcquireSsrsLeaseRequest
1268
+ include ::Google::Protobuf::MessageExts
1269
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1270
+ end
1271
+
1272
+ # Request for Pre-checks for MVU
1273
+ # @!attribute [rw] instance
1274
+ # @return [::String]
1275
+ # Required. Cloud SQL instance ID. This does not include the project ID.
1276
+ # @!attribute [rw] project
1277
+ # @return [::String]
1278
+ # Required. Project ID of the project that contains the instance.
1279
+ # @!attribute [rw] body
1280
+ # @return [::Google::Cloud::Sql::V1beta4::InstancesPreCheckMajorVersionUpgradeRequest]
1281
+ # Required. The context for request to perform the pre-check major version
1282
+ # upgrade operation.
1283
+ class SqlInstancesPreCheckMajorVersionUpgradeRequest
1284
+ include ::Google::Protobuf::MessageExts
1285
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1286
+ end
1287
+
1288
+ # Acquire SSRS lease response.
1289
+ # @!attribute [rw] operation_id
1290
+ # @return [::String]
1291
+ # The unique identifier for this operation.
1292
+ class SqlInstancesAcquireSsrsLeaseResponse
1293
+ include ::Google::Protobuf::MessageExts
1294
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1295
+ end
1296
+
1297
+ # Request to perform a point in time restore on a Google Cloud Backup and
1298
+ # Disaster Recovery managed instance.
1299
+ # @!attribute [rw] parent
1300
+ # @return [::String]
1301
+ # Required. The parent resource where you created this instance.
1302
+ # Format: projects/\\{project}
1303
+ # @!attribute [rw] context
1304
+ # @return [::Google::Cloud::Sql::V1beta4::PointInTimeRestoreContext]
1305
+ # Required. The context for request to perform a PITR on a Google Cloud
1306
+ # Backup and Disaster Recovery managed instance.
1307
+ class SqlInstancesPointInTimeRestoreRequest
1308
+ include ::Google::Protobuf::MessageExts
1309
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1310
+ end
1311
+
1312
+ # External Sync parallel level.
1313
+ module ExternalSyncParallelLevel
1314
+ # Unknown sync parallel level. Will be defaulted to OPTIMAL.
1315
+ EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED = 0
1316
+
1317
+ # Minimal parallel level.
1318
+ MIN = 1
1319
+
1320
+ # Optimal parallel level.
1321
+ OPTIMAL = 2
1322
+
1323
+ # Maximum parallel level.
1324
+ MAX = 3
1325
+ end
1326
+ end
1327
+ end
1328
+ end
1329
+ end