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