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,48 @@
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 "googleauth"
20
+
21
+ module Google
22
+ module Cloud
23
+ module Sql
24
+ module V1beta4
25
+ module SqlOperationsService
26
+ # Credentials for the SqlOperationsService API.
27
+ class Credentials < ::Google::Auth::Credentials
28
+ self.scope = [
29
+ "https://www.googleapis.com/auth/cloud-platform",
30
+ "https://www.googleapis.com/auth/sqlservice.admin"
31
+ ]
32
+ self.env_vars = [
33
+ "GOOGLE_CLOUD_CREDENTIALS",
34
+ "GOOGLE_CLOUD_KEYFILE",
35
+ "GCLOUD_KEYFILE",
36
+ "GOOGLE_CLOUD_CREDENTIALS_JSON",
37
+ "GOOGLE_CLOUD_KEYFILE_JSON",
38
+ "GCLOUD_KEYFILE_JSON"
39
+ ]
40
+ self.paths = [
41
+ "~/.config/google_cloud/application_default_credentials.json"
42
+ ]
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,629 @@
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_operations_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 SqlOperationsService
29
+ module Rest
30
+ ##
31
+ # REST client for the SqlOperationsService 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_operations_service_stub
42
+
43
+ ##
44
+ # Configure the SqlOperationsService Client class.
45
+ #
46
+ # See {::Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client::Configuration}
47
+ # for a description of the configuration fields.
48
+ #
49
+ # @example
50
+ #
51
+ # # Modify the configuration for all SqlOperationsService clients
52
+ # ::Google::Cloud::Sql::V1beta4::SqlOperationsService::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 SqlOperationsService 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::SqlOperationsService::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_operations_service_stub.universe_domain
107
+ end
108
+
109
+ ##
110
+ # Create a new SqlOperationsService REST client object.
111
+ #
112
+ # @example
113
+ #
114
+ # # Create a client using the default configuration
115
+ # client = ::Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client.new
116
+ #
117
+ # # Create a client using a custom configuration
118
+ # client = ::Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client.new do |config|
119
+ # config.timeout = 10.0
120
+ # end
121
+ #
122
+ # @yield [config] Configure the SqlOperationsService 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_operations_service_stub = ::Google::Cloud::Sql::V1beta4::SqlOperationsService::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_operations_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_operations_service_stub.endpoint
170
+ config.universe_domain = @sql_operations_service_stub.universe_domain
171
+ config.logger = @sql_operations_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_operations_service_stub.logger
189
+ end
190
+
191
+ # Service calls
192
+
193
+ ##
194
+ # Retrieves an instance operation that has been performed on an instance.
195
+ #
196
+ # @overload get(request, options = nil)
197
+ # Pass arguments to `get` via a request object, either of type
198
+ # {::Google::Cloud::Sql::V1beta4::SqlOperationsGetRequest} or an equivalent Hash.
199
+ #
200
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlOperationsGetRequest, ::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 get(operation: nil, project: nil, location: nil)
207
+ # Pass arguments to `get` 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 operation [::String]
212
+ # Instance operation ID.
213
+ # @param project [::String]
214
+ # Project ID of the project that contains the instance.
215
+ # @param location [::String]
216
+ # Optional. Region of the Cloud SQL instance.
217
+ # @yield [result, operation] Access the result along with the TransportOperation object
218
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::Operation]
219
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
220
+ #
221
+ # @return [::Google::Cloud::Sql::V1beta4::Operation]
222
+ #
223
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
224
+ #
225
+ # @example Basic example
226
+ # require "google/cloud/sql/v1beta4"
227
+ #
228
+ # # Create a client object. The client can be reused for multiple calls.
229
+ # client = Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client.new
230
+ #
231
+ # # Create a request. To set request fields, pass in keyword arguments.
232
+ # request = Google::Cloud::Sql::V1beta4::SqlOperationsGetRequest.new
233
+ #
234
+ # # Call the get method.
235
+ # result = client.get request
236
+ #
237
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::Operation.
238
+ # p result
239
+ #
240
+ def get request, options = nil
241
+ raise ::ArgumentError, "request must be provided" if request.nil?
242
+
243
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlOperationsGetRequest
244
+
245
+ # Converts hash and nil to an options object
246
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
247
+
248
+ # Customize the options with defaults
249
+ call_metadata = @config.rpcs.get.metadata.to_h
250
+
251
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
252
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
253
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
254
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
255
+ transports_version_send: [:rest]
256
+
257
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
258
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
259
+
260
+ options.apply_defaults timeout: @config.rpcs.get.timeout,
261
+ metadata: call_metadata,
262
+ retry_policy: @config.rpcs.get.retry_policy
263
+
264
+ options.apply_defaults timeout: @config.timeout,
265
+ metadata: @config.metadata,
266
+ retry_policy: @config.retry_policy
267
+
268
+ @sql_operations_service_stub.get request, options do |result, operation|
269
+ yield result, operation if block_given?
270
+ end
271
+ rescue ::Gapic::Rest::Error => e
272
+ raise ::Google::Cloud::Error.from_error(e)
273
+ end
274
+
275
+ ##
276
+ # Lists all instance operations that have been performed on the given Cloud
277
+ # SQL instance in the reverse chronological order of the start time.
278
+ #
279
+ # @overload list(request, options = nil)
280
+ # Pass arguments to `list` via a request object, either of type
281
+ # {::Google::Cloud::Sql::V1beta4::SqlOperationsListRequest} or an equivalent Hash.
282
+ #
283
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlOperationsListRequest, ::Hash]
284
+ # A request object representing the call parameters. Required. To specify no
285
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
286
+ # @param options [::Gapic::CallOptions, ::Hash]
287
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
288
+ #
289
+ # @overload list(instance: nil, max_results: nil, page_token: nil, project: nil, location: nil)
290
+ # Pass arguments to `list` via keyword arguments. Note that at
291
+ # least one keyword argument is required. To specify no parameters, or to keep all
292
+ # the default parameter values, pass an empty Hash as a request object (see above).
293
+ #
294
+ # @param instance [::String]
295
+ # Cloud SQL instance ID. This does not include the project ID.
296
+ # @param max_results [::Integer]
297
+ # Maximum number of operations per response.
298
+ # @param page_token [::String]
299
+ # A previously-returned page token representing part of the larger set of
300
+ # results to view.
301
+ # @param project [::String]
302
+ # Project ID of the project that contains the instance.
303
+ # @param location [::String]
304
+ # Optional. Region of the Cloud SQL instance.
305
+ # @yield [result, operation] Access the result along with the TransportOperation object
306
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::OperationsListResponse]
307
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
308
+ #
309
+ # @return [::Google::Cloud::Sql::V1beta4::OperationsListResponse]
310
+ #
311
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
312
+ #
313
+ # @example Basic example
314
+ # require "google/cloud/sql/v1beta4"
315
+ #
316
+ # # Create a client object. The client can be reused for multiple calls.
317
+ # client = Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client.new
318
+ #
319
+ # # Create a request. To set request fields, pass in keyword arguments.
320
+ # request = Google::Cloud::Sql::V1beta4::SqlOperationsListRequest.new
321
+ #
322
+ # # Call the list method.
323
+ # result = client.list request
324
+ #
325
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::OperationsListResponse.
326
+ # p result
327
+ #
328
+ def list request, options = nil
329
+ raise ::ArgumentError, "request must be provided" if request.nil?
330
+
331
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlOperationsListRequest
332
+
333
+ # Converts hash and nil to an options object
334
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
335
+
336
+ # Customize the options with defaults
337
+ call_metadata = @config.rpcs.list.metadata.to_h
338
+
339
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
340
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
341
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
342
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
343
+ transports_version_send: [:rest]
344
+
345
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
346
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
347
+
348
+ options.apply_defaults timeout: @config.rpcs.list.timeout,
349
+ metadata: call_metadata,
350
+ retry_policy: @config.rpcs.list.retry_policy
351
+
352
+ options.apply_defaults timeout: @config.timeout,
353
+ metadata: @config.metadata,
354
+ retry_policy: @config.retry_policy
355
+
356
+ @sql_operations_service_stub.list request, options do |result, operation|
357
+ yield result, operation if block_given?
358
+ end
359
+ rescue ::Gapic::Rest::Error => e
360
+ raise ::Google::Cloud::Error.from_error(e)
361
+ end
362
+
363
+ ##
364
+ # Cancels an instance operation that has been performed on an instance.
365
+ # Ordinarily, this method name should be `CancelSqlOperation`.
366
+ #
367
+ # @overload cancel(request, options = nil)
368
+ # Pass arguments to `cancel` via a request object, either of type
369
+ # {::Google::Cloud::Sql::V1beta4::SqlOperationsCancelRequest} or an equivalent Hash.
370
+ #
371
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlOperationsCancelRequest, ::Hash]
372
+ # A request object representing the call parameters. Required. To specify no
373
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
374
+ # @param options [::Gapic::CallOptions, ::Hash]
375
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
376
+ #
377
+ # @overload cancel(operation: nil, project: nil, location: nil)
378
+ # Pass arguments to `cancel` via keyword arguments. Note that at
379
+ # least one keyword argument is required. To specify no parameters, or to keep all
380
+ # the default parameter values, pass an empty Hash as a request object (see above).
381
+ #
382
+ # @param operation [::String]
383
+ # Instance operation ID.
384
+ # @param project [::String]
385
+ # Project ID of the project that contains the instance.
386
+ # @param location [::String]
387
+ # Optional. Region of the Cloud SQL instance.
388
+ # @yield [result, operation] Access the result along with the TransportOperation object
389
+ # @yieldparam result [::Google::Protobuf::Empty]
390
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
391
+ #
392
+ # @return [::Google::Protobuf::Empty]
393
+ #
394
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
395
+ #
396
+ # @example Basic example
397
+ # require "google/cloud/sql/v1beta4"
398
+ #
399
+ # # Create a client object. The client can be reused for multiple calls.
400
+ # client = Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client.new
401
+ #
402
+ # # Create a request. To set request fields, pass in keyword arguments.
403
+ # request = Google::Cloud::Sql::V1beta4::SqlOperationsCancelRequest.new
404
+ #
405
+ # # Call the cancel method.
406
+ # result = client.cancel request
407
+ #
408
+ # # The returned object is of type Google::Protobuf::Empty.
409
+ # p result
410
+ #
411
+ def cancel request, options = nil
412
+ raise ::ArgumentError, "request must be provided" if request.nil?
413
+
414
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlOperationsCancelRequest
415
+
416
+ # Converts hash and nil to an options object
417
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
418
+
419
+ # Customize the options with defaults
420
+ call_metadata = @config.rpcs.cancel.metadata.to_h
421
+
422
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
423
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
424
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
425
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
426
+ transports_version_send: [:rest]
427
+
428
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
429
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
430
+
431
+ options.apply_defaults timeout: @config.rpcs.cancel.timeout,
432
+ metadata: call_metadata,
433
+ retry_policy: @config.rpcs.cancel.retry_policy
434
+
435
+ options.apply_defaults timeout: @config.timeout,
436
+ metadata: @config.metadata,
437
+ retry_policy: @config.retry_policy
438
+
439
+ @sql_operations_service_stub.cancel request, options do |result, operation|
440
+ yield result, operation if block_given?
441
+ end
442
+ rescue ::Gapic::Rest::Error => e
443
+ raise ::Google::Cloud::Error.from_error(e)
444
+ end
445
+
446
+ ##
447
+ # Configuration class for the SqlOperationsService REST API.
448
+ #
449
+ # This class represents the configuration for SqlOperationsService REST,
450
+ # providing control over timeouts, retry behavior, logging, transport
451
+ # parameters, and other low-level controls. Certain parameters can also be
452
+ # applied individually to specific RPCs. See
453
+ # {::Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client::Configuration::Rpcs}
454
+ # for a list of RPCs that can be configured independently.
455
+ #
456
+ # Configuration can be applied globally to all clients, or to a single client
457
+ # on construction.
458
+ #
459
+ # @example
460
+ #
461
+ # # Modify the global config, setting the timeout for
462
+ # # get to 20 seconds,
463
+ # # and all remaining timeouts to 10 seconds.
464
+ # ::Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client.configure do |config|
465
+ # config.timeout = 10.0
466
+ # config.rpcs.get.timeout = 20.0
467
+ # end
468
+ #
469
+ # # Apply the above configuration only to a new client.
470
+ # client = ::Google::Cloud::Sql::V1beta4::SqlOperationsService::Rest::Client.new do |config|
471
+ # config.timeout = 10.0
472
+ # config.rpcs.get.timeout = 20.0
473
+ # end
474
+ #
475
+ # @!attribute [rw] endpoint
476
+ # A custom service endpoint, as a hostname or hostname:port. The default is
477
+ # nil, indicating to use the default endpoint in the current universe domain.
478
+ # @return [::String,nil]
479
+ # @!attribute [rw] credentials
480
+ # Credentials to send with calls. You may provide any of the following types:
481
+ # * (`String`) The path to a service account key file in JSON format
482
+ # * (`Hash`) A service account key as a Hash
483
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
484
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
485
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
486
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
487
+ # * (`nil`) indicating no credentials
488
+ #
489
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
490
+ # external source for authentication to Google Cloud, you must validate it before
491
+ # providing it to a Google API client library. Providing an unvalidated credential
492
+ # configuration to Google APIs can compromise the security of your systems and data.
493
+ # For more information, refer to [Validate credential configurations from external
494
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
495
+ # @return [::Object]
496
+ # @!attribute [rw] scope
497
+ # The OAuth scopes
498
+ # @return [::Array<::String>]
499
+ # @!attribute [rw] lib_name
500
+ # The library name as recorded in instrumentation and logging
501
+ # @return [::String]
502
+ # @!attribute [rw] lib_version
503
+ # The library version as recorded in instrumentation and logging
504
+ # @return [::String]
505
+ # @!attribute [rw] timeout
506
+ # The call timeout in seconds.
507
+ # @return [::Numeric]
508
+ # @!attribute [rw] metadata
509
+ # Additional headers to be sent with the call.
510
+ # @return [::Hash{::Symbol=>::String}]
511
+ # @!attribute [rw] retry_policy
512
+ # The retry policy. The value is a hash with the following keys:
513
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
514
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
515
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
516
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
517
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
518
+ # trigger a retry.
519
+ # @return [::Hash]
520
+ # @!attribute [rw] quota_project
521
+ # A separate project against which to charge quota.
522
+ # @return [::String]
523
+ # @!attribute [rw] universe_domain
524
+ # The universe domain within which to make requests. This determines the
525
+ # default endpoint URL. The default value of nil uses the environment
526
+ # universe (usually the default "googleapis.com" universe).
527
+ # @return [::String,nil]
528
+ # @!attribute [rw] logger
529
+ # A custom logger to use for request/response debug logging, or the value
530
+ # `:default` (the default) to construct a default logger, or `nil` to
531
+ # explicitly disable logging.
532
+ # @return [::Logger,:default,nil]
533
+ #
534
+ class Configuration
535
+ extend ::Gapic::Config
536
+
537
+ # @private
538
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
539
+ DEFAULT_ENDPOINT = "sqladmin.googleapis.com"
540
+
541
+ config_attr :endpoint, nil, ::String, nil
542
+ config_attr :credentials, nil do |value|
543
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
544
+ allowed.any? { |klass| klass === value }
545
+ end
546
+ config_attr :scope, nil, ::String, ::Array, nil
547
+ config_attr :lib_name, nil, ::String, nil
548
+ config_attr :lib_version, nil, ::String, nil
549
+ config_attr :timeout, nil, ::Numeric, nil
550
+ config_attr :metadata, nil, ::Hash, nil
551
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
552
+ config_attr :quota_project, nil, ::String, nil
553
+ config_attr :universe_domain, nil, ::String, nil
554
+ config_attr :logger, :default, ::Logger, nil, :default
555
+
556
+ # @private
557
+ def initialize parent_config = nil
558
+ @parent_config = parent_config unless parent_config.nil?
559
+
560
+ yield self if block_given?
561
+ end
562
+
563
+ ##
564
+ # Configurations for individual RPCs
565
+ # @return [Rpcs]
566
+ #
567
+ def rpcs
568
+ @rpcs ||= begin
569
+ parent_rpcs = nil
570
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
571
+ Rpcs.new parent_rpcs
572
+ end
573
+ end
574
+
575
+ ##
576
+ # Configuration RPC class for the SqlOperationsService API.
577
+ #
578
+ # Includes fields providing the configuration for each RPC in this service.
579
+ # Each configuration object is of type `Gapic::Config::Method` and includes
580
+ # the following configuration fields:
581
+ #
582
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
583
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
584
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
585
+ # include the following keys:
586
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
587
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
588
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
589
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
590
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
591
+ # trigger a retry.
592
+ #
593
+ class Rpcs
594
+ ##
595
+ # RPC-specific configuration for `get`
596
+ # @return [::Gapic::Config::Method]
597
+ #
598
+ attr_reader :get
599
+ ##
600
+ # RPC-specific configuration for `list`
601
+ # @return [::Gapic::Config::Method]
602
+ #
603
+ attr_reader :list
604
+ ##
605
+ # RPC-specific configuration for `cancel`
606
+ # @return [::Gapic::Config::Method]
607
+ #
608
+ attr_reader :cancel
609
+
610
+ # @private
611
+ def initialize parent_rpcs = nil
612
+ get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
613
+ @get = ::Gapic::Config::Method.new get_config
614
+ list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
615
+ @list = ::Gapic::Config::Method.new list_config
616
+ cancel_config = parent_rpcs.cancel if parent_rpcs.respond_to? :cancel
617
+ @cancel = ::Gapic::Config::Method.new cancel_config
618
+
619
+ yield self if block_given?
620
+ end
621
+ end
622
+ end
623
+ end
624
+ end
625
+ end
626
+ end
627
+ end
628
+ end
629
+ end