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