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,718 @@
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
+ require "google/cloud/errors"
20
+ require "google/cloud/sql/v1beta4/cloud_sql_pb"
21
+ require "google/cloud/sql/v1beta4/sql_backup_runs_service/rest/service_stub"
22
+ require "google/cloud/location/rest"
23
+
24
+ module Google
25
+ module Cloud
26
+ module Sql
27
+ module V1beta4
28
+ module SqlBackupRunsService
29
+ module Rest
30
+ ##
31
+ # REST client for the SqlBackupRunsService service.
32
+ #
33
+ class Client
34
+ # @private
35
+ API_VERSION = ""
36
+
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "sqladmin.$UNIVERSE_DOMAIN$"
39
+
40
+ # @private
41
+ attr_reader :sql_backup_runs_service_stub
42
+
43
+ ##
44
+ # Configure the SqlBackupRunsService Client class.
45
+ #
46
+ # See {::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client::Configuration}
47
+ # for a description of the configuration fields.
48
+ #
49
+ # @example
50
+ #
51
+ # # Modify the configuration for all SqlBackupRunsService clients
52
+ # ::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.configure do |config|
53
+ # config.timeout = 10.0
54
+ # end
55
+ #
56
+ # @yield [config] Configure the Client client.
57
+ # @yieldparam config [Client::Configuration]
58
+ #
59
+ # @return [Client::Configuration]
60
+ #
61
+ def self.configure
62
+ @configure ||= begin
63
+ namespace = ["Google", "Cloud", "Sql", "V1beta4"]
64
+ parent_config = while namespace.any?
65
+ parent_name = namespace.join "::"
66
+ parent_const = const_get parent_name
67
+ break parent_const.configure if parent_const.respond_to? :configure
68
+ namespace.pop
69
+ end
70
+ default_config = Client::Configuration.new parent_config
71
+
72
+ default_config.timeout = 60.0
73
+
74
+ default_config
75
+ end
76
+ yield @configure if block_given?
77
+ @configure
78
+ end
79
+
80
+ ##
81
+ # Configure the SqlBackupRunsService Client instance.
82
+ #
83
+ # The configuration is set to the derived mode, meaning that values can be changed,
84
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
85
+ # should be made on {Client.configure}.
86
+ #
87
+ # See {::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client::Configuration}
88
+ # for a description of the configuration fields.
89
+ #
90
+ # @yield [config] Configure the Client client.
91
+ # @yieldparam config [Client::Configuration]
92
+ #
93
+ # @return [Client::Configuration]
94
+ #
95
+ def configure
96
+ yield @config if block_given?
97
+ @config
98
+ end
99
+
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @sql_backup_runs_service_stub.universe_domain
107
+ end
108
+
109
+ ##
110
+ # Create a new SqlBackupRunsService REST client object.
111
+ #
112
+ # @example
113
+ #
114
+ # # Create a client using the default configuration
115
+ # client = ::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.new
116
+ #
117
+ # # Create a client using a custom configuration
118
+ # client = ::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.new do |config|
119
+ # config.timeout = 10.0
120
+ # end
121
+ #
122
+ # @yield [config] Configure the SqlBackupRunsService client.
123
+ # @yieldparam config [Client::Configuration]
124
+ #
125
+ def initialize
126
+ # Create the configuration object
127
+ @config = Configuration.new Client.configure
128
+
129
+ # Yield the configuration if needed
130
+ yield @config if block_given?
131
+
132
+ # Create credentials
133
+ credentials = @config.credentials
134
+ # Use self-signed JWT if the endpoint is unchanged from default,
135
+ # but only if the default endpoint does not have a region prefix.
136
+ enable_self_signed_jwt = @config.endpoint.nil? ||
137
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
138
+ !@config.endpoint.split(".").first.include?("-"))
139
+ credentials ||= Credentials.default scope: @config.scope,
140
+ enable_self_signed_jwt: enable_self_signed_jwt
141
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
142
+ credentials = Credentials.new credentials, scope: @config.scope
143
+ end
144
+
145
+ @quota_project_id = @config.quota_project
146
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
147
+
148
+ @sql_backup_runs_service_stub = ::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::ServiceStub.new(
149
+ endpoint: @config.endpoint,
150
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
151
+ universe_domain: @config.universe_domain,
152
+ credentials: credentials,
153
+ logger: @config.logger
154
+ )
155
+
156
+ @sql_backup_runs_service_stub.logger(stub: true)&.info do |entry|
157
+ entry.set_system_name
158
+ entry.set_service
159
+ entry.message = "Created client for #{entry.service}"
160
+ entry.set_credentials_fields credentials
161
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
162
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
163
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
164
+ end
165
+
166
+ @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
167
+ config.credentials = credentials
168
+ config.quota_project = @quota_project_id
169
+ config.endpoint = @sql_backup_runs_service_stub.endpoint
170
+ config.universe_domain = @sql_backup_runs_service_stub.universe_domain
171
+ config.logger = @sql_backup_runs_service_stub.logger if config.respond_to? :logger=
172
+ end
173
+ end
174
+
175
+ ##
176
+ # Get the associated client for mix-in of the Locations.
177
+ #
178
+ # @return [Google::Cloud::Location::Locations::Rest::Client]
179
+ #
180
+ attr_reader :location_client
181
+
182
+ ##
183
+ # The logger used for request/response debug logging.
184
+ #
185
+ # @return [Logger]
186
+ #
187
+ def logger
188
+ @sql_backup_runs_service_stub.logger
189
+ end
190
+
191
+ # Service calls
192
+
193
+ ##
194
+ # Deletes the backup taken by a backup run.
195
+ #
196
+ # @overload delete(request, options = nil)
197
+ # Pass arguments to `delete` via a request object, either of type
198
+ # {::Google::Cloud::Sql::V1beta4::SqlBackupRunsDeleteRequest} or an equivalent Hash.
199
+ #
200
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlBackupRunsDeleteRequest, ::Hash]
201
+ # A request object representing the call parameters. Required. To specify no
202
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
203
+ # @param options [::Gapic::CallOptions, ::Hash]
204
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
205
+ #
206
+ # @overload delete(id: nil, instance: nil, project: nil)
207
+ # Pass arguments to `delete` via keyword arguments. Note that at
208
+ # least one keyword argument is required. To specify no parameters, or to keep all
209
+ # the default parameter values, pass an empty Hash as a request object (see above).
210
+ #
211
+ # @param id [::Integer]
212
+ # The ID of the backup run to delete. To find a backup run ID, use the
213
+ # [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/backupRuns/list)
214
+ # method.
215
+ # @param instance [::String]
216
+ # Cloud SQL instance ID. This does not include the project ID.
217
+ # @param project [::String]
218
+ # Project ID of the project that contains the instance.
219
+ # @yield [result, operation] Access the result along with the TransportOperation object
220
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::Operation]
221
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
222
+ #
223
+ # @return [::Google::Cloud::Sql::V1beta4::Operation]
224
+ #
225
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
226
+ #
227
+ # @example Basic example
228
+ # require "google/cloud/sql/v1beta4"
229
+ #
230
+ # # Create a client object. The client can be reused for multiple calls.
231
+ # client = Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.new
232
+ #
233
+ # # Create a request. To set request fields, pass in keyword arguments.
234
+ # request = Google::Cloud::Sql::V1beta4::SqlBackupRunsDeleteRequest.new
235
+ #
236
+ # # Call the delete method.
237
+ # result = client.delete request
238
+ #
239
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::Operation.
240
+ # p result
241
+ #
242
+ def delete request, options = nil
243
+ raise ::ArgumentError, "request must be provided" if request.nil?
244
+
245
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlBackupRunsDeleteRequest
246
+
247
+ # Converts hash and nil to an options object
248
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
249
+
250
+ # Customize the options with defaults
251
+ call_metadata = @config.rpcs.delete.metadata.to_h
252
+
253
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
254
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
255
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
256
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
257
+ transports_version_send: [:rest]
258
+
259
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
260
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
261
+
262
+ options.apply_defaults timeout: @config.rpcs.delete.timeout,
263
+ metadata: call_metadata,
264
+ retry_policy: @config.rpcs.delete.retry_policy
265
+
266
+ options.apply_defaults timeout: @config.timeout,
267
+ metadata: @config.metadata,
268
+ retry_policy: @config.retry_policy
269
+
270
+ @sql_backup_runs_service_stub.delete request, options do |result, operation|
271
+ yield result, operation if block_given?
272
+ end
273
+ rescue ::Gapic::Rest::Error => e
274
+ raise ::Google::Cloud::Error.from_error(e)
275
+ end
276
+
277
+ ##
278
+ # Retrieves a resource containing information about a backup run.
279
+ #
280
+ # @overload get(request, options = nil)
281
+ # Pass arguments to `get` via a request object, either of type
282
+ # {::Google::Cloud::Sql::V1beta4::SqlBackupRunsGetRequest} or an equivalent Hash.
283
+ #
284
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlBackupRunsGetRequest, ::Hash]
285
+ # A request object representing the call parameters. Required. To specify no
286
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
287
+ # @param options [::Gapic::CallOptions, ::Hash]
288
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
289
+ #
290
+ # @overload get(id: nil, instance: nil, project: nil)
291
+ # Pass arguments to `get` via keyword arguments. Note that at
292
+ # least one keyword argument is required. To specify no parameters, or to keep all
293
+ # the default parameter values, pass an empty Hash as a request object (see above).
294
+ #
295
+ # @param id [::Integer]
296
+ # The ID of this backup run.
297
+ # @param instance [::String]
298
+ # Cloud SQL instance ID. This does not include the project ID.
299
+ # @param project [::String]
300
+ # Project ID of the project that contains the instance.
301
+ # @yield [result, operation] Access the result along with the TransportOperation object
302
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::BackupRun]
303
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
304
+ #
305
+ # @return [::Google::Cloud::Sql::V1beta4::BackupRun]
306
+ #
307
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
308
+ #
309
+ # @example Basic example
310
+ # require "google/cloud/sql/v1beta4"
311
+ #
312
+ # # Create a client object. The client can be reused for multiple calls.
313
+ # client = Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.new
314
+ #
315
+ # # Create a request. To set request fields, pass in keyword arguments.
316
+ # request = Google::Cloud::Sql::V1beta4::SqlBackupRunsGetRequest.new
317
+ #
318
+ # # Call the get method.
319
+ # result = client.get request
320
+ #
321
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::BackupRun.
322
+ # p result
323
+ #
324
+ def get request, options = nil
325
+ raise ::ArgumentError, "request must be provided" if request.nil?
326
+
327
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlBackupRunsGetRequest
328
+
329
+ # Converts hash and nil to an options object
330
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
331
+
332
+ # Customize the options with defaults
333
+ call_metadata = @config.rpcs.get.metadata.to_h
334
+
335
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
336
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
337
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
338
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
339
+ transports_version_send: [:rest]
340
+
341
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
342
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
343
+
344
+ options.apply_defaults timeout: @config.rpcs.get.timeout,
345
+ metadata: call_metadata,
346
+ retry_policy: @config.rpcs.get.retry_policy
347
+
348
+ options.apply_defaults timeout: @config.timeout,
349
+ metadata: @config.metadata,
350
+ retry_policy: @config.retry_policy
351
+
352
+ @sql_backup_runs_service_stub.get request, options do |result, operation|
353
+ yield result, operation if block_given?
354
+ end
355
+ rescue ::Gapic::Rest::Error => e
356
+ raise ::Google::Cloud::Error.from_error(e)
357
+ end
358
+
359
+ ##
360
+ # Creates a new backup run on demand.
361
+ #
362
+ # @overload insert(request, options = nil)
363
+ # Pass arguments to `insert` via a request object, either of type
364
+ # {::Google::Cloud::Sql::V1beta4::SqlBackupRunsInsertRequest} or an equivalent Hash.
365
+ #
366
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlBackupRunsInsertRequest, ::Hash]
367
+ # A request object representing the call parameters. Required. To specify no
368
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
369
+ # @param options [::Gapic::CallOptions, ::Hash]
370
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
371
+ #
372
+ # @overload insert(instance: nil, project: nil, body: nil)
373
+ # Pass arguments to `insert` via keyword arguments. Note that at
374
+ # least one keyword argument is required. To specify no parameters, or to keep all
375
+ # the default parameter values, pass an empty Hash as a request object (see above).
376
+ #
377
+ # @param instance [::String]
378
+ # Cloud SQL instance ID. This does not include the project ID.
379
+ # @param project [::String]
380
+ # Project ID of the project that contains the instance.
381
+ # @param body [::Google::Cloud::Sql::V1beta4::BackupRun, ::Hash]
382
+ # @yield [result, operation] Access the result along with the TransportOperation object
383
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::Operation]
384
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
385
+ #
386
+ # @return [::Google::Cloud::Sql::V1beta4::Operation]
387
+ #
388
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
389
+ #
390
+ # @example Basic example
391
+ # require "google/cloud/sql/v1beta4"
392
+ #
393
+ # # Create a client object. The client can be reused for multiple calls.
394
+ # client = Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.new
395
+ #
396
+ # # Create a request. To set request fields, pass in keyword arguments.
397
+ # request = Google::Cloud::Sql::V1beta4::SqlBackupRunsInsertRequest.new
398
+ #
399
+ # # Call the insert method.
400
+ # result = client.insert request
401
+ #
402
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::Operation.
403
+ # p result
404
+ #
405
+ def insert request, options = nil
406
+ raise ::ArgumentError, "request must be provided" if request.nil?
407
+
408
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlBackupRunsInsertRequest
409
+
410
+ # Converts hash and nil to an options object
411
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
412
+
413
+ # Customize the options with defaults
414
+ call_metadata = @config.rpcs.insert.metadata.to_h
415
+
416
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
417
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
418
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
419
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
420
+ transports_version_send: [:rest]
421
+
422
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
423
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
424
+
425
+ options.apply_defaults timeout: @config.rpcs.insert.timeout,
426
+ metadata: call_metadata,
427
+ retry_policy: @config.rpcs.insert.retry_policy
428
+
429
+ options.apply_defaults timeout: @config.timeout,
430
+ metadata: @config.metadata,
431
+ retry_policy: @config.retry_policy
432
+
433
+ @sql_backup_runs_service_stub.insert request, options do |result, operation|
434
+ yield result, operation if block_given?
435
+ end
436
+ rescue ::Gapic::Rest::Error => e
437
+ raise ::Google::Cloud::Error.from_error(e)
438
+ end
439
+
440
+ ##
441
+ # Lists all backup runs associated with the project or a given instance and
442
+ # configuration in the reverse chronological order of the backup initiation
443
+ # time.
444
+ #
445
+ # @overload list(request, options = nil)
446
+ # Pass arguments to `list` via a request object, either of type
447
+ # {::Google::Cloud::Sql::V1beta4::SqlBackupRunsListRequest} or an equivalent Hash.
448
+ #
449
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlBackupRunsListRequest, ::Hash]
450
+ # A request object representing the call parameters. Required. To specify no
451
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
452
+ # @param options [::Gapic::CallOptions, ::Hash]
453
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
454
+ #
455
+ # @overload list(instance: nil, max_results: nil, page_token: nil, project: nil)
456
+ # Pass arguments to `list` via keyword arguments. Note that at
457
+ # least one keyword argument is required. To specify no parameters, or to keep all
458
+ # the default parameter values, pass an empty Hash as a request object (see above).
459
+ #
460
+ # @param instance [::String]
461
+ # Cloud SQL instance ID, or "-" for all instances. This does not include
462
+ # the project ID.
463
+ # @param max_results [::Integer]
464
+ # Maximum number of backup runs per response.
465
+ # @param page_token [::String]
466
+ # A previously-returned page token representing part of the larger set of
467
+ # results to view.
468
+ # @param project [::String]
469
+ # Project ID of the project that contains the instance.
470
+ # @yield [result, operation] Access the result along with the TransportOperation object
471
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::BackupRunsListResponse]
472
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
473
+ #
474
+ # @return [::Google::Cloud::Sql::V1beta4::BackupRunsListResponse]
475
+ #
476
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
477
+ #
478
+ # @example Basic example
479
+ # require "google/cloud/sql/v1beta4"
480
+ #
481
+ # # Create a client object. The client can be reused for multiple calls.
482
+ # client = Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.new
483
+ #
484
+ # # Create a request. To set request fields, pass in keyword arguments.
485
+ # request = Google::Cloud::Sql::V1beta4::SqlBackupRunsListRequest.new
486
+ #
487
+ # # Call the list method.
488
+ # result = client.list request
489
+ #
490
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::BackupRunsListResponse.
491
+ # p result
492
+ #
493
+ def list request, options = nil
494
+ raise ::ArgumentError, "request must be provided" if request.nil?
495
+
496
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlBackupRunsListRequest
497
+
498
+ # Converts hash and nil to an options object
499
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
500
+
501
+ # Customize the options with defaults
502
+ call_metadata = @config.rpcs.list.metadata.to_h
503
+
504
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
505
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
506
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
507
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
508
+ transports_version_send: [:rest]
509
+
510
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
511
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
512
+
513
+ options.apply_defaults timeout: @config.rpcs.list.timeout,
514
+ metadata: call_metadata,
515
+ retry_policy: @config.rpcs.list.retry_policy
516
+
517
+ options.apply_defaults timeout: @config.timeout,
518
+ metadata: @config.metadata,
519
+ retry_policy: @config.retry_policy
520
+
521
+ @sql_backup_runs_service_stub.list request, options do |result, operation|
522
+ yield result, operation if block_given?
523
+ end
524
+ rescue ::Gapic::Rest::Error => e
525
+ raise ::Google::Cloud::Error.from_error(e)
526
+ end
527
+
528
+ ##
529
+ # Configuration class for the SqlBackupRunsService REST API.
530
+ #
531
+ # This class represents the configuration for SqlBackupRunsService REST,
532
+ # providing control over timeouts, retry behavior, logging, transport
533
+ # parameters, and other low-level controls. Certain parameters can also be
534
+ # applied individually to specific RPCs. See
535
+ # {::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client::Configuration::Rpcs}
536
+ # for a list of RPCs that can be configured independently.
537
+ #
538
+ # Configuration can be applied globally to all clients, or to a single client
539
+ # on construction.
540
+ #
541
+ # @example
542
+ #
543
+ # # Modify the global config, setting the timeout for
544
+ # # delete to 20 seconds,
545
+ # # and all remaining timeouts to 10 seconds.
546
+ # ::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.configure do |config|
547
+ # config.timeout = 10.0
548
+ # config.rpcs.delete.timeout = 20.0
549
+ # end
550
+ #
551
+ # # Apply the above configuration only to a new client.
552
+ # client = ::Google::Cloud::Sql::V1beta4::SqlBackupRunsService::Rest::Client.new do |config|
553
+ # config.timeout = 10.0
554
+ # config.rpcs.delete.timeout = 20.0
555
+ # end
556
+ #
557
+ # @!attribute [rw] endpoint
558
+ # A custom service endpoint, as a hostname or hostname:port. The default is
559
+ # nil, indicating to use the default endpoint in the current universe domain.
560
+ # @return [::String,nil]
561
+ # @!attribute [rw] credentials
562
+ # Credentials to send with calls. You may provide any of the following types:
563
+ # * (`String`) The path to a service account key file in JSON format
564
+ # * (`Hash`) A service account key as a Hash
565
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
566
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
567
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
568
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
569
+ # * (`nil`) indicating no credentials
570
+ #
571
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
572
+ # external source for authentication to Google Cloud, you must validate it before
573
+ # providing it to a Google API client library. Providing an unvalidated credential
574
+ # configuration to Google APIs can compromise the security of your systems and data.
575
+ # For more information, refer to [Validate credential configurations from external
576
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
577
+ # @return [::Object]
578
+ # @!attribute [rw] scope
579
+ # The OAuth scopes
580
+ # @return [::Array<::String>]
581
+ # @!attribute [rw] lib_name
582
+ # The library name as recorded in instrumentation and logging
583
+ # @return [::String]
584
+ # @!attribute [rw] lib_version
585
+ # The library version as recorded in instrumentation and logging
586
+ # @return [::String]
587
+ # @!attribute [rw] timeout
588
+ # The call timeout in seconds.
589
+ # @return [::Numeric]
590
+ # @!attribute [rw] metadata
591
+ # Additional headers to be sent with the call.
592
+ # @return [::Hash{::Symbol=>::String}]
593
+ # @!attribute [rw] retry_policy
594
+ # The retry policy. The value is a hash with the following keys:
595
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
596
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
597
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
598
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
599
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
600
+ # trigger a retry.
601
+ # @return [::Hash]
602
+ # @!attribute [rw] quota_project
603
+ # A separate project against which to charge quota.
604
+ # @return [::String]
605
+ # @!attribute [rw] universe_domain
606
+ # The universe domain within which to make requests. This determines the
607
+ # default endpoint URL. The default value of nil uses the environment
608
+ # universe (usually the default "googleapis.com" universe).
609
+ # @return [::String,nil]
610
+ # @!attribute [rw] logger
611
+ # A custom logger to use for request/response debug logging, or the value
612
+ # `:default` (the default) to construct a default logger, or `nil` to
613
+ # explicitly disable logging.
614
+ # @return [::Logger,:default,nil]
615
+ #
616
+ class Configuration
617
+ extend ::Gapic::Config
618
+
619
+ # @private
620
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
621
+ DEFAULT_ENDPOINT = "sqladmin.googleapis.com"
622
+
623
+ config_attr :endpoint, nil, ::String, nil
624
+ config_attr :credentials, nil do |value|
625
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
626
+ allowed.any? { |klass| klass === value }
627
+ end
628
+ config_attr :scope, nil, ::String, ::Array, nil
629
+ config_attr :lib_name, nil, ::String, nil
630
+ config_attr :lib_version, nil, ::String, nil
631
+ config_attr :timeout, nil, ::Numeric, nil
632
+ config_attr :metadata, nil, ::Hash, nil
633
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
634
+ config_attr :quota_project, nil, ::String, nil
635
+ config_attr :universe_domain, nil, ::String, nil
636
+ config_attr :logger, :default, ::Logger, nil, :default
637
+
638
+ # @private
639
+ def initialize parent_config = nil
640
+ @parent_config = parent_config unless parent_config.nil?
641
+
642
+ yield self if block_given?
643
+ end
644
+
645
+ ##
646
+ # Configurations for individual RPCs
647
+ # @return [Rpcs]
648
+ #
649
+ def rpcs
650
+ @rpcs ||= begin
651
+ parent_rpcs = nil
652
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
653
+ Rpcs.new parent_rpcs
654
+ end
655
+ end
656
+
657
+ ##
658
+ # Configuration RPC class for the SqlBackupRunsService API.
659
+ #
660
+ # Includes fields providing the configuration for each RPC in this service.
661
+ # Each configuration object is of type `Gapic::Config::Method` and includes
662
+ # the following configuration fields:
663
+ #
664
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
665
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
666
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
667
+ # include the following keys:
668
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
669
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
670
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
671
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
672
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
673
+ # trigger a retry.
674
+ #
675
+ class Rpcs
676
+ ##
677
+ # RPC-specific configuration for `delete`
678
+ # @return [::Gapic::Config::Method]
679
+ #
680
+ attr_reader :delete
681
+ ##
682
+ # RPC-specific configuration for `get`
683
+ # @return [::Gapic::Config::Method]
684
+ #
685
+ attr_reader :get
686
+ ##
687
+ # RPC-specific configuration for `insert`
688
+ # @return [::Gapic::Config::Method]
689
+ #
690
+ attr_reader :insert
691
+ ##
692
+ # RPC-specific configuration for `list`
693
+ # @return [::Gapic::Config::Method]
694
+ #
695
+ attr_reader :list
696
+
697
+ # @private
698
+ def initialize parent_rpcs = nil
699
+ delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
700
+ @delete = ::Gapic::Config::Method.new delete_config
701
+ get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
702
+ @get = ::Gapic::Config::Method.new get_config
703
+ insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
704
+ @insert = ::Gapic::Config::Method.new insert_config
705
+ list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
706
+ @list = ::Gapic::Config::Method.new list_config
707
+
708
+ yield self if block_given?
709
+ end
710
+ end
711
+ end
712
+ end
713
+ end
714
+ end
715
+ end
716
+ end
717
+ end
718
+ end