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