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,819 @@
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_users_pb"
21
+ require "google/cloud/sql/v1beta4/sql_users_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 SqlUsersService
29
+ module Rest
30
+ ##
31
+ # REST client for the SqlUsersService 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_users_service_stub
42
+
43
+ ##
44
+ # Configure the SqlUsersService Client class.
45
+ #
46
+ # See {::Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client::Configuration}
47
+ # for a description of the configuration fields.
48
+ #
49
+ # @example
50
+ #
51
+ # # Modify the configuration for all SqlUsersService clients
52
+ # ::Google::Cloud::Sql::V1beta4::SqlUsersService::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 SqlUsersService 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::SqlUsersService::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_users_service_stub.universe_domain
107
+ end
108
+
109
+ ##
110
+ # Create a new SqlUsersService REST client object.
111
+ #
112
+ # @example
113
+ #
114
+ # # Create a client using the default configuration
115
+ # client = ::Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.new
116
+ #
117
+ # # Create a client using a custom configuration
118
+ # client = ::Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.new do |config|
119
+ # config.timeout = 10.0
120
+ # end
121
+ #
122
+ # @yield [config] Configure the SqlUsersService 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_users_service_stub = ::Google::Cloud::Sql::V1beta4::SqlUsersService::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_users_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_users_service_stub.endpoint
170
+ config.universe_domain = @sql_users_service_stub.universe_domain
171
+ config.logger = @sql_users_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_users_service_stub.logger
189
+ end
190
+
191
+ # Service calls
192
+
193
+ ##
194
+ # Deletes a user from a Cloud SQL instance.
195
+ #
196
+ # @overload delete(request, options = nil)
197
+ # Pass arguments to `delete` via a request object, either of type
198
+ # {::Google::Cloud::Sql::V1beta4::SqlUsersDeleteRequest} or an equivalent Hash.
199
+ #
200
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlUsersDeleteRequest, ::Hash]
201
+ # A request object representing the call parameters. Required. To specify no
202
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
203
+ # @param options [::Gapic::CallOptions, ::Hash]
204
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
205
+ #
206
+ # @overload delete(host: nil, instance: nil, name: nil, project: nil)
207
+ # Pass arguments to `delete` via keyword arguments. Note that at
208
+ # least one keyword argument is required. To specify no parameters, or to keep all
209
+ # the default parameter values, pass an empty Hash as a request object (see above).
210
+ #
211
+ # @param host [::String]
212
+ # Host of the user in the instance.
213
+ # @param instance [::String]
214
+ # Database instance ID. This does not include the project ID.
215
+ # @param name [::String]
216
+ # Name of the user in the instance.
217
+ # @param project [::String]
218
+ # Project ID of the project that contains the instance.
219
+ # @yield [result, operation] Access the result along with the TransportOperation object
220
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::Operation]
221
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
222
+ #
223
+ # @return [::Google::Cloud::Sql::V1beta4::Operation]
224
+ #
225
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
226
+ #
227
+ # @example Basic example
228
+ # require "google/cloud/sql/v1beta4"
229
+ #
230
+ # # Create a client object. The client can be reused for multiple calls.
231
+ # client = Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.new
232
+ #
233
+ # # Create a request. To set request fields, pass in keyword arguments.
234
+ # request = Google::Cloud::Sql::V1beta4::SqlUsersDeleteRequest.new
235
+ #
236
+ # # Call the delete method.
237
+ # result = client.delete request
238
+ #
239
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::Operation.
240
+ # p result
241
+ #
242
+ def delete request, options = nil
243
+ raise ::ArgumentError, "request must be provided" if request.nil?
244
+
245
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlUsersDeleteRequest
246
+
247
+ # Converts hash and nil to an options object
248
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
249
+
250
+ # Customize the options with defaults
251
+ call_metadata = @config.rpcs.delete.metadata.to_h
252
+
253
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
254
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
255
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
256
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
257
+ transports_version_send: [:rest]
258
+
259
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
260
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
261
+
262
+ options.apply_defaults timeout: @config.rpcs.delete.timeout,
263
+ metadata: call_metadata,
264
+ retry_policy: @config.rpcs.delete.retry_policy
265
+
266
+ options.apply_defaults timeout: @config.timeout,
267
+ metadata: @config.metadata,
268
+ retry_policy: @config.retry_policy
269
+
270
+ @sql_users_service_stub.delete request, options do |result, operation|
271
+ yield result, operation if block_given?
272
+ end
273
+ rescue ::Gapic::Rest::Error => e
274
+ raise ::Google::Cloud::Error.from_error(e)
275
+ end
276
+
277
+ ##
278
+ # Retrieves a resource containing information about a user.
279
+ #
280
+ # @overload get(request, options = nil)
281
+ # Pass arguments to `get` via a request object, either of type
282
+ # {::Google::Cloud::Sql::V1beta4::SqlUsersGetRequest} or an equivalent Hash.
283
+ #
284
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlUsersGetRequest, ::Hash]
285
+ # A request object representing the call parameters. Required. To specify no
286
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
287
+ # @param options [::Gapic::CallOptions, ::Hash]
288
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
289
+ #
290
+ # @overload get(instance: nil, name: nil, project: nil, host: nil)
291
+ # Pass arguments to `get` via keyword arguments. Note that at
292
+ # least one keyword argument is required. To specify no parameters, or to keep all
293
+ # the default parameter values, pass an empty Hash as a request object (see above).
294
+ #
295
+ # @param instance [::String]
296
+ # Database instance ID. This does not include the project ID.
297
+ # @param name [::String]
298
+ # User of the instance.
299
+ # @param project [::String]
300
+ # Project ID of the project that contains the instance.
301
+ # @param host [::String]
302
+ # Host of a user of the instance.
303
+ # @yield [result, operation] Access the result along with the TransportOperation object
304
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::User]
305
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
306
+ #
307
+ # @return [::Google::Cloud::Sql::V1beta4::User]
308
+ #
309
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
310
+ #
311
+ # @example Basic example
312
+ # require "google/cloud/sql/v1beta4"
313
+ #
314
+ # # Create a client object. The client can be reused for multiple calls.
315
+ # client = Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.new
316
+ #
317
+ # # Create a request. To set request fields, pass in keyword arguments.
318
+ # request = Google::Cloud::Sql::V1beta4::SqlUsersGetRequest.new
319
+ #
320
+ # # Call the get method.
321
+ # result = client.get request
322
+ #
323
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::User.
324
+ # p result
325
+ #
326
+ def get request, options = nil
327
+ raise ::ArgumentError, "request must be provided" if request.nil?
328
+
329
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlUsersGetRequest
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.get.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::V1beta4::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.get.timeout,
347
+ metadata: call_metadata,
348
+ retry_policy: @config.rpcs.get.retry_policy
349
+
350
+ options.apply_defaults timeout: @config.timeout,
351
+ metadata: @config.metadata,
352
+ retry_policy: @config.retry_policy
353
+
354
+ @sql_users_service_stub.get 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
+ # Creates a new user in a Cloud SQL instance.
363
+ #
364
+ # @overload insert(request, options = nil)
365
+ # Pass arguments to `insert` via a request object, either of type
366
+ # {::Google::Cloud::Sql::V1beta4::SqlUsersInsertRequest} or an equivalent Hash.
367
+ #
368
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlUsersInsertRequest, ::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 insert(instance: nil, project: nil, body: nil)
375
+ # Pass arguments to `insert` 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 instance [::String]
380
+ # Database instance ID. This does not include the project ID.
381
+ # @param project [::String]
382
+ # Project ID of the project that contains the instance.
383
+ # @param body [::Google::Cloud::Sql::V1beta4::User, ::Hash]
384
+ # @yield [result, operation] Access the result along with the TransportOperation object
385
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::Operation]
386
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
387
+ #
388
+ # @return [::Google::Cloud::Sql::V1beta4::Operation]
389
+ #
390
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
391
+ #
392
+ # @example Basic example
393
+ # require "google/cloud/sql/v1beta4"
394
+ #
395
+ # # Create a client object. The client can be reused for multiple calls.
396
+ # client = Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.new
397
+ #
398
+ # # Create a request. To set request fields, pass in keyword arguments.
399
+ # request = Google::Cloud::Sql::V1beta4::SqlUsersInsertRequest.new
400
+ #
401
+ # # Call the insert method.
402
+ # result = client.insert request
403
+ #
404
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::Operation.
405
+ # p result
406
+ #
407
+ def insert request, options = nil
408
+ raise ::ArgumentError, "request must be provided" if request.nil?
409
+
410
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlUsersInsertRequest
411
+
412
+ # Converts hash and nil to an options object
413
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
414
+
415
+ # Customize the options with defaults
416
+ call_metadata = @config.rpcs.insert.metadata.to_h
417
+
418
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
419
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
420
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
421
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
422
+ transports_version_send: [:rest]
423
+
424
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
425
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
426
+
427
+ options.apply_defaults timeout: @config.rpcs.insert.timeout,
428
+ metadata: call_metadata,
429
+ retry_policy: @config.rpcs.insert.retry_policy
430
+
431
+ options.apply_defaults timeout: @config.timeout,
432
+ metadata: @config.metadata,
433
+ retry_policy: @config.retry_policy
434
+
435
+ @sql_users_service_stub.insert request, options do |result, operation|
436
+ yield result, operation if block_given?
437
+ end
438
+ rescue ::Gapic::Rest::Error => e
439
+ raise ::Google::Cloud::Error.from_error(e)
440
+ end
441
+
442
+ ##
443
+ # Lists users in the specified Cloud SQL instance.
444
+ #
445
+ # @overload list(request, options = nil)
446
+ # Pass arguments to `list` via a request object, either of type
447
+ # {::Google::Cloud::Sql::V1beta4::SqlUsersListRequest} or an equivalent Hash.
448
+ #
449
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlUsersListRequest, ::Hash]
450
+ # A request object representing the call parameters. Required. To specify no
451
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
452
+ # @param options [::Gapic::CallOptions, ::Hash]
453
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
454
+ #
455
+ # @overload list(instance: nil, project: nil)
456
+ # Pass arguments to `list` via keyword arguments. Note that at
457
+ # least one keyword argument is required. To specify no parameters, or to keep all
458
+ # the default parameter values, pass an empty Hash as a request object (see above).
459
+ #
460
+ # @param instance [::String]
461
+ # Database instance ID. This does not include the project ID.
462
+ # @param project [::String]
463
+ # Project ID of the project that contains the instance.
464
+ # @yield [result, operation] Access the result along with the TransportOperation object
465
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::UsersListResponse]
466
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
467
+ #
468
+ # @return [::Google::Cloud::Sql::V1beta4::UsersListResponse]
469
+ #
470
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
471
+ #
472
+ # @example Basic example
473
+ # require "google/cloud/sql/v1beta4"
474
+ #
475
+ # # Create a client object. The client can be reused for multiple calls.
476
+ # client = Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.new
477
+ #
478
+ # # Create a request. To set request fields, pass in keyword arguments.
479
+ # request = Google::Cloud::Sql::V1beta4::SqlUsersListRequest.new
480
+ #
481
+ # # Call the list method.
482
+ # result = client.list request
483
+ #
484
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::UsersListResponse.
485
+ # p result
486
+ #
487
+ def list request, options = nil
488
+ raise ::ArgumentError, "request must be provided" if request.nil?
489
+
490
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlUsersListRequest
491
+
492
+ # Converts hash and nil to an options object
493
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
494
+
495
+ # Customize the options with defaults
496
+ call_metadata = @config.rpcs.list.metadata.to_h
497
+
498
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
499
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
500
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
501
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
502
+ transports_version_send: [:rest]
503
+
504
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
505
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
506
+
507
+ options.apply_defaults timeout: @config.rpcs.list.timeout,
508
+ metadata: call_metadata,
509
+ retry_policy: @config.rpcs.list.retry_policy
510
+
511
+ options.apply_defaults timeout: @config.timeout,
512
+ metadata: @config.metadata,
513
+ retry_policy: @config.retry_policy
514
+
515
+ @sql_users_service_stub.list request, options do |result, operation|
516
+ yield result, operation if block_given?
517
+ end
518
+ rescue ::Gapic::Rest::Error => e
519
+ raise ::Google::Cloud::Error.from_error(e)
520
+ end
521
+
522
+ ##
523
+ # Updates an existing user in a Cloud SQL instance.
524
+ #
525
+ # @overload update(request, options = nil)
526
+ # Pass arguments to `update` via a request object, either of type
527
+ # {::Google::Cloud::Sql::V1beta4::SqlUsersUpdateRequest} or an equivalent Hash.
528
+ #
529
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlUsersUpdateRequest, ::Hash]
530
+ # A request object representing the call parameters. Required. To specify no
531
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
532
+ # @param options [::Gapic::CallOptions, ::Hash]
533
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
534
+ #
535
+ # @overload update(host: nil, instance: nil, name: nil, project: nil, database_roles: nil, revoke_existing_roles: nil, server_roles: nil, revoke_existing_server_roles: nil, body: nil)
536
+ # Pass arguments to `update` via keyword arguments. Note that at
537
+ # least one keyword argument is required. To specify no parameters, or to keep all
538
+ # the default parameter values, pass an empty Hash as a request object (see above).
539
+ #
540
+ # @param host [::String]
541
+ # Optional. Host of the user in the instance.
542
+ # @param instance [::String]
543
+ # Database instance ID. This does not include the project ID.
544
+ # @param name [::String]
545
+ # Name of the user in the instance.
546
+ # @param project [::String]
547
+ # Project ID of the project that contains the instance.
548
+ # @param database_roles [::Array<::String>]
549
+ # Optional. List of database roles to grant to the user. body.database_roles
550
+ # will be ignored for update request.
551
+ # @param revoke_existing_roles [::Boolean]
552
+ # Optional. Specifies whether to revoke existing roles that are not present
553
+ # in the `database_roles` field. If `false` or unset, the database roles
554
+ # specified in `database_roles` are added to the user's existing roles.
555
+ # @param server_roles [::Array<::String>]
556
+ # Optional. The server roles to grant to the SQL Server login. Existing
557
+ # server roles will not be revoked if revoke_existing_roles is false.
558
+ # body.server_roles will be ignored for update request.
559
+ # @param revoke_existing_server_roles [::Boolean]
560
+ # Optional. Specifies whether to revoke existing roles that are not present
561
+ # in the `server_roles` field. If `false` or unset, the server roles
562
+ # specified in `server_roles` are added to the user's existing server roles.
563
+ # @param body [::Google::Cloud::Sql::V1beta4::User, ::Hash]
564
+ # @yield [result, operation] Access the result along with the TransportOperation object
565
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::Operation]
566
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
567
+ #
568
+ # @return [::Google::Cloud::Sql::V1beta4::Operation]
569
+ #
570
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
571
+ #
572
+ # @example Basic example
573
+ # require "google/cloud/sql/v1beta4"
574
+ #
575
+ # # Create a client object. The client can be reused for multiple calls.
576
+ # client = Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.new
577
+ #
578
+ # # Create a request. To set request fields, pass in keyword arguments.
579
+ # request = Google::Cloud::Sql::V1beta4::SqlUsersUpdateRequest.new
580
+ #
581
+ # # Call the update method.
582
+ # result = client.update request
583
+ #
584
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::Operation.
585
+ # p result
586
+ #
587
+ def update request, options = nil
588
+ raise ::ArgumentError, "request must be provided" if request.nil?
589
+
590
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlUsersUpdateRequest
591
+
592
+ # Converts hash and nil to an options object
593
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
594
+
595
+ # Customize the options with defaults
596
+ call_metadata = @config.rpcs.update.metadata.to_h
597
+
598
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
599
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
600
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
601
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
602
+ transports_version_send: [:rest]
603
+
604
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
605
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
606
+
607
+ options.apply_defaults timeout: @config.rpcs.update.timeout,
608
+ metadata: call_metadata,
609
+ retry_policy: @config.rpcs.update.retry_policy
610
+
611
+ options.apply_defaults timeout: @config.timeout,
612
+ metadata: @config.metadata,
613
+ retry_policy: @config.retry_policy
614
+
615
+ @sql_users_service_stub.update request, options do |result, operation|
616
+ yield result, operation if block_given?
617
+ end
618
+ rescue ::Gapic::Rest::Error => e
619
+ raise ::Google::Cloud::Error.from_error(e)
620
+ end
621
+
622
+ ##
623
+ # Configuration class for the SqlUsersService REST API.
624
+ #
625
+ # This class represents the configuration for SqlUsersService REST,
626
+ # providing control over timeouts, retry behavior, logging, transport
627
+ # parameters, and other low-level controls. Certain parameters can also be
628
+ # applied individually to specific RPCs. See
629
+ # {::Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client::Configuration::Rpcs}
630
+ # for a list of RPCs that can be configured independently.
631
+ #
632
+ # Configuration can be applied globally to all clients, or to a single client
633
+ # on construction.
634
+ #
635
+ # @example
636
+ #
637
+ # # Modify the global config, setting the timeout for
638
+ # # delete to 20 seconds,
639
+ # # and all remaining timeouts to 10 seconds.
640
+ # ::Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.configure do |config|
641
+ # config.timeout = 10.0
642
+ # config.rpcs.delete.timeout = 20.0
643
+ # end
644
+ #
645
+ # # Apply the above configuration only to a new client.
646
+ # client = ::Google::Cloud::Sql::V1beta4::SqlUsersService::Rest::Client.new do |config|
647
+ # config.timeout = 10.0
648
+ # config.rpcs.delete.timeout = 20.0
649
+ # end
650
+ #
651
+ # @!attribute [rw] endpoint
652
+ # A custom service endpoint, as a hostname or hostname:port. The default is
653
+ # nil, indicating to use the default endpoint in the current universe domain.
654
+ # @return [::String,nil]
655
+ # @!attribute [rw] credentials
656
+ # Credentials to send with calls. You may provide any of the following types:
657
+ # * (`String`) The path to a service account key file in JSON format
658
+ # * (`Hash`) A service account key as a Hash
659
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
660
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
661
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
662
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
663
+ # * (`nil`) indicating no credentials
664
+ #
665
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
666
+ # external source for authentication to Google Cloud, you must validate it before
667
+ # providing it to a Google API client library. Providing an unvalidated credential
668
+ # configuration to Google APIs can compromise the security of your systems and data.
669
+ # For more information, refer to [Validate credential configurations from external
670
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
671
+ # @return [::Object]
672
+ # @!attribute [rw] scope
673
+ # The OAuth scopes
674
+ # @return [::Array<::String>]
675
+ # @!attribute [rw] lib_name
676
+ # The library name as recorded in instrumentation and logging
677
+ # @return [::String]
678
+ # @!attribute [rw] lib_version
679
+ # The library version as recorded in instrumentation and logging
680
+ # @return [::String]
681
+ # @!attribute [rw] timeout
682
+ # The call timeout in seconds.
683
+ # @return [::Numeric]
684
+ # @!attribute [rw] metadata
685
+ # Additional headers to be sent with the call.
686
+ # @return [::Hash{::Symbol=>::String}]
687
+ # @!attribute [rw] retry_policy
688
+ # The retry policy. The value is a hash with the following keys:
689
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
690
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
691
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
692
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
693
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
694
+ # trigger a retry.
695
+ # @return [::Hash]
696
+ # @!attribute [rw] quota_project
697
+ # A separate project against which to charge quota.
698
+ # @return [::String]
699
+ # @!attribute [rw] universe_domain
700
+ # The universe domain within which to make requests. This determines the
701
+ # default endpoint URL. The default value of nil uses the environment
702
+ # universe (usually the default "googleapis.com" universe).
703
+ # @return [::String,nil]
704
+ # @!attribute [rw] logger
705
+ # A custom logger to use for request/response debug logging, or the value
706
+ # `:default` (the default) to construct a default logger, or `nil` to
707
+ # explicitly disable logging.
708
+ # @return [::Logger,:default,nil]
709
+ #
710
+ class Configuration
711
+ extend ::Gapic::Config
712
+
713
+ # @private
714
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
715
+ DEFAULT_ENDPOINT = "sqladmin.googleapis.com"
716
+
717
+ config_attr :endpoint, nil, ::String, nil
718
+ config_attr :credentials, nil do |value|
719
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
720
+ allowed.any? { |klass| klass === value }
721
+ end
722
+ config_attr :scope, nil, ::String, ::Array, nil
723
+ config_attr :lib_name, nil, ::String, nil
724
+ config_attr :lib_version, nil, ::String, nil
725
+ config_attr :timeout, nil, ::Numeric, nil
726
+ config_attr :metadata, nil, ::Hash, nil
727
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
728
+ config_attr :quota_project, nil, ::String, nil
729
+ config_attr :universe_domain, nil, ::String, nil
730
+ config_attr :logger, :default, ::Logger, nil, :default
731
+
732
+ # @private
733
+ def initialize parent_config = nil
734
+ @parent_config = parent_config unless parent_config.nil?
735
+
736
+ yield self if block_given?
737
+ end
738
+
739
+ ##
740
+ # Configurations for individual RPCs
741
+ # @return [Rpcs]
742
+ #
743
+ def rpcs
744
+ @rpcs ||= begin
745
+ parent_rpcs = nil
746
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
747
+ Rpcs.new parent_rpcs
748
+ end
749
+ end
750
+
751
+ ##
752
+ # Configuration RPC class for the SqlUsersService API.
753
+ #
754
+ # Includes fields providing the configuration for each RPC in this service.
755
+ # Each configuration object is of type `Gapic::Config::Method` and includes
756
+ # the following configuration fields:
757
+ #
758
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
759
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
760
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
761
+ # include the following keys:
762
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
763
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
764
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
765
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
766
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
767
+ # trigger a retry.
768
+ #
769
+ class Rpcs
770
+ ##
771
+ # RPC-specific configuration for `delete`
772
+ # @return [::Gapic::Config::Method]
773
+ #
774
+ attr_reader :delete
775
+ ##
776
+ # RPC-specific configuration for `get`
777
+ # @return [::Gapic::Config::Method]
778
+ #
779
+ attr_reader :get
780
+ ##
781
+ # RPC-specific configuration for `insert`
782
+ # @return [::Gapic::Config::Method]
783
+ #
784
+ attr_reader :insert
785
+ ##
786
+ # RPC-specific configuration for `list`
787
+ # @return [::Gapic::Config::Method]
788
+ #
789
+ attr_reader :list
790
+ ##
791
+ # RPC-specific configuration for `update`
792
+ # @return [::Gapic::Config::Method]
793
+ #
794
+ attr_reader :update
795
+
796
+ # @private
797
+ def initialize parent_rpcs = nil
798
+ delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
799
+ @delete = ::Gapic::Config::Method.new delete_config
800
+ get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
801
+ @get = ::Gapic::Config::Method.new get_config
802
+ insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
803
+ @insert = ::Gapic::Config::Method.new insert_config
804
+ list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
805
+ @list = ::Gapic::Config::Method.new list_config
806
+ update_config = parent_rpcs.update if parent_rpcs.respond_to? :update
807
+ @update = ::Gapic::Config::Method.new update_config
808
+
809
+ yield self if block_given?
810
+ end
811
+ end
812
+ end
813
+ end
814
+ end
815
+ end
816
+ end
817
+ end
818
+ end
819
+ end