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,713 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/errors"
20
+ require "google/cloud/sql/v1beta4/cloud_sql_pb"
21
+ require "google/cloud/sql/v1beta4/sql_ssl_certs_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 SqlSslCertsService
29
+ module Rest
30
+ ##
31
+ # REST client for the SqlSslCertsService 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_ssl_certs_service_stub
42
+
43
+ ##
44
+ # Configure the SqlSslCertsService Client class.
45
+ #
46
+ # See {::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client::Configuration}
47
+ # for a description of the configuration fields.
48
+ #
49
+ # @example
50
+ #
51
+ # # Modify the configuration for all SqlSslCertsService clients
52
+ # ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::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 SqlSslCertsService 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::SqlSslCertsService::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_ssl_certs_service_stub.universe_domain
107
+ end
108
+
109
+ ##
110
+ # Create a new SqlSslCertsService REST client object.
111
+ #
112
+ # @example
113
+ #
114
+ # # Create a client using the default configuration
115
+ # client = ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client.new
116
+ #
117
+ # # Create a client using a custom configuration
118
+ # client = ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client.new do |config|
119
+ # config.timeout = 10.0
120
+ # end
121
+ #
122
+ # @yield [config] Configure the SqlSslCertsService 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_ssl_certs_service_stub = ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::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_ssl_certs_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_ssl_certs_service_stub.endpoint
170
+ config.universe_domain = @sql_ssl_certs_service_stub.universe_domain
171
+ config.logger = @sql_ssl_certs_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_ssl_certs_service_stub.logger
189
+ end
190
+
191
+ # Service calls
192
+
193
+ ##
194
+ # Deletes the SSL certificate. For First Generation instances, the
195
+ # certificate remains valid until the instance is restarted.
196
+ #
197
+ # @overload delete(request, options = nil)
198
+ # Pass arguments to `delete` via a request object, either of type
199
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsDeleteRequest} or an equivalent Hash.
200
+ #
201
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlSslCertsDeleteRequest, ::Hash]
202
+ # A request object representing the call parameters. Required. To specify no
203
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
204
+ # @param options [::Gapic::CallOptions, ::Hash]
205
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
206
+ #
207
+ # @overload delete(instance: nil, project: nil, sha1_fingerprint: nil)
208
+ # Pass arguments to `delete` via keyword arguments. Note that at
209
+ # least one keyword argument is required. To specify no parameters, or to keep all
210
+ # the default parameter values, pass an empty Hash as a request object (see above).
211
+ #
212
+ # @param instance [::String]
213
+ # Cloud SQL instance ID. This does not include the project ID.
214
+ # @param project [::String]
215
+ # Project ID of the project that contains the instance.
216
+ # @param sha1_fingerprint [::String]
217
+ # Sha1 FingerPrint.
218
+ # @yield [result, operation] Access the result along with the TransportOperation object
219
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::Operation]
220
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
221
+ #
222
+ # @return [::Google::Cloud::Sql::V1beta4::Operation]
223
+ #
224
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
225
+ #
226
+ # @example Basic example
227
+ # require "google/cloud/sql/v1beta4"
228
+ #
229
+ # # Create a client object. The client can be reused for multiple calls.
230
+ # client = Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client.new
231
+ #
232
+ # # Create a request. To set request fields, pass in keyword arguments.
233
+ # request = Google::Cloud::Sql::V1beta4::SqlSslCertsDeleteRequest.new
234
+ #
235
+ # # Call the delete method.
236
+ # result = client.delete request
237
+ #
238
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::Operation.
239
+ # p result
240
+ #
241
+ def delete request, options = nil
242
+ raise ::ArgumentError, "request must be provided" if request.nil?
243
+
244
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlSslCertsDeleteRequest
245
+
246
+ # Converts hash and nil to an options object
247
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
248
+
249
+ # Customize the options with defaults
250
+ call_metadata = @config.rpcs.delete.metadata.to_h
251
+
252
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
253
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
254
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
255
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
256
+ transports_version_send: [:rest]
257
+
258
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
259
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
260
+
261
+ options.apply_defaults timeout: @config.rpcs.delete.timeout,
262
+ metadata: call_metadata,
263
+ retry_policy: @config.rpcs.delete.retry_policy
264
+
265
+ options.apply_defaults timeout: @config.timeout,
266
+ metadata: @config.metadata,
267
+ retry_policy: @config.retry_policy
268
+
269
+ @sql_ssl_certs_service_stub.delete request, options do |result, operation|
270
+ yield result, operation if block_given?
271
+ end
272
+ rescue ::Gapic::Rest::Error => e
273
+ raise ::Google::Cloud::Error.from_error(e)
274
+ end
275
+
276
+ ##
277
+ # Retrieves a particular SSL certificate. Does not include the private key
278
+ # (required for usage). The private key must be saved from the response to
279
+ # initial creation.
280
+ #
281
+ # @overload get(request, options = nil)
282
+ # Pass arguments to `get` via a request object, either of type
283
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsGetRequest} or an equivalent Hash.
284
+ #
285
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlSslCertsGetRequest, ::Hash]
286
+ # A request object representing the call parameters. Required. To specify no
287
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
288
+ # @param options [::Gapic::CallOptions, ::Hash]
289
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
290
+ #
291
+ # @overload get(instance: nil, project: nil, sha1_fingerprint: nil)
292
+ # Pass arguments to `get` via keyword arguments. Note that at
293
+ # least one keyword argument is required. To specify no parameters, or to keep all
294
+ # the default parameter values, pass an empty Hash as a request object (see above).
295
+ #
296
+ # @param instance [::String]
297
+ # Cloud SQL instance ID. This does not include the project ID.
298
+ # @param project [::String]
299
+ # Project ID of the project that contains the instance.
300
+ # @param sha1_fingerprint [::String]
301
+ # Sha1 FingerPrint.
302
+ # @yield [result, operation] Access the result along with the TransportOperation object
303
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::SslCert]
304
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
305
+ #
306
+ # @return [::Google::Cloud::Sql::V1beta4::SslCert]
307
+ #
308
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
309
+ #
310
+ # @example Basic example
311
+ # require "google/cloud/sql/v1beta4"
312
+ #
313
+ # # Create a client object. The client can be reused for multiple calls.
314
+ # client = Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client.new
315
+ #
316
+ # # Create a request. To set request fields, pass in keyword arguments.
317
+ # request = Google::Cloud::Sql::V1beta4::SqlSslCertsGetRequest.new
318
+ #
319
+ # # Call the get method.
320
+ # result = client.get request
321
+ #
322
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::SslCert.
323
+ # p result
324
+ #
325
+ def get request, options = nil
326
+ raise ::ArgumentError, "request must be provided" if request.nil?
327
+
328
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlSslCertsGetRequest
329
+
330
+ # Converts hash and nil to an options object
331
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
332
+
333
+ # Customize the options with defaults
334
+ call_metadata = @config.rpcs.get.metadata.to_h
335
+
336
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
337
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
338
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
339
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
340
+ transports_version_send: [:rest]
341
+
342
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
343
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
344
+
345
+ options.apply_defaults timeout: @config.rpcs.get.timeout,
346
+ metadata: call_metadata,
347
+ retry_policy: @config.rpcs.get.retry_policy
348
+
349
+ options.apply_defaults timeout: @config.timeout,
350
+ metadata: @config.metadata,
351
+ retry_policy: @config.retry_policy
352
+
353
+ @sql_ssl_certs_service_stub.get request, options do |result, operation|
354
+ yield result, operation if block_given?
355
+ end
356
+ rescue ::Gapic::Rest::Error => e
357
+ raise ::Google::Cloud::Error.from_error(e)
358
+ end
359
+
360
+ ##
361
+ # Creates an SSL certificate and returns it along with the private key and
362
+ # server certificate authority. The new certificate will not be usable until
363
+ # the instance is restarted.
364
+ #
365
+ # @overload insert(request, options = nil)
366
+ # Pass arguments to `insert` via a request object, either of type
367
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsInsertRequest} or an equivalent Hash.
368
+ #
369
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlSslCertsInsertRequest, ::Hash]
370
+ # A request object representing the call parameters. Required. To specify no
371
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
372
+ # @param options [::Gapic::CallOptions, ::Hash]
373
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
374
+ #
375
+ # @overload insert(instance: nil, project: nil, body: nil)
376
+ # Pass arguments to `insert` via keyword arguments. Note that at
377
+ # least one keyword argument is required. To specify no parameters, or to keep all
378
+ # the default parameter values, pass an empty Hash as a request object (see above).
379
+ #
380
+ # @param instance [::String]
381
+ # Cloud SQL instance ID. This does not include the project ID.
382
+ # @param project [::String]
383
+ # Project ID of the project that contains the instance.
384
+ # @param body [::Google::Cloud::Sql::V1beta4::SslCertsInsertRequest, ::Hash]
385
+ # @yield [result, operation] Access the result along with the TransportOperation object
386
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::SslCertsInsertResponse]
387
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
388
+ #
389
+ # @return [::Google::Cloud::Sql::V1beta4::SslCertsInsertResponse]
390
+ #
391
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
392
+ #
393
+ # @example Basic example
394
+ # require "google/cloud/sql/v1beta4"
395
+ #
396
+ # # Create a client object. The client can be reused for multiple calls.
397
+ # client = Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client.new
398
+ #
399
+ # # Create a request. To set request fields, pass in keyword arguments.
400
+ # request = Google::Cloud::Sql::V1beta4::SqlSslCertsInsertRequest.new
401
+ #
402
+ # # Call the insert method.
403
+ # result = client.insert request
404
+ #
405
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::SslCertsInsertResponse.
406
+ # p result
407
+ #
408
+ def insert request, options = nil
409
+ raise ::ArgumentError, "request must be provided" if request.nil?
410
+
411
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlSslCertsInsertRequest
412
+
413
+ # Converts hash and nil to an options object
414
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
415
+
416
+ # Customize the options with defaults
417
+ call_metadata = @config.rpcs.insert.metadata.to_h
418
+
419
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
420
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
421
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
422
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
423
+ transports_version_send: [:rest]
424
+
425
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
426
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
427
+
428
+ options.apply_defaults timeout: @config.rpcs.insert.timeout,
429
+ metadata: call_metadata,
430
+ retry_policy: @config.rpcs.insert.retry_policy
431
+
432
+ options.apply_defaults timeout: @config.timeout,
433
+ metadata: @config.metadata,
434
+ retry_policy: @config.retry_policy
435
+
436
+ @sql_ssl_certs_service_stub.insert request, options do |result, operation|
437
+ yield result, operation if block_given?
438
+ end
439
+ rescue ::Gapic::Rest::Error => e
440
+ raise ::Google::Cloud::Error.from_error(e)
441
+ end
442
+
443
+ ##
444
+ # Lists all of the current SSL certificates for the instance.
445
+ #
446
+ # @overload list(request, options = nil)
447
+ # Pass arguments to `list` via a request object, either of type
448
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsListRequest} or an equivalent Hash.
449
+ #
450
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlSslCertsListRequest, ::Hash]
451
+ # A request object representing the call parameters. Required. To specify no
452
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
453
+ # @param options [::Gapic::CallOptions, ::Hash]
454
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
455
+ #
456
+ # @overload list(instance: nil, project: nil)
457
+ # Pass arguments to `list` via keyword arguments. Note that at
458
+ # least one keyword argument is required. To specify no parameters, or to keep all
459
+ # the default parameter values, pass an empty Hash as a request object (see above).
460
+ #
461
+ # @param instance [::String]
462
+ # Cloud SQL instance ID. This does not include the project ID.
463
+ # @param project [::String]
464
+ # Project ID of the project that contains the instance.
465
+ # @yield [result, operation] Access the result along with the TransportOperation object
466
+ # @yieldparam result [::Google::Cloud::Sql::V1beta4::SslCertsListResponse]
467
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
468
+ #
469
+ # @return [::Google::Cloud::Sql::V1beta4::SslCertsListResponse]
470
+ #
471
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
472
+ #
473
+ # @example Basic example
474
+ # require "google/cloud/sql/v1beta4"
475
+ #
476
+ # # Create a client object. The client can be reused for multiple calls.
477
+ # client = Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client.new
478
+ #
479
+ # # Create a request. To set request fields, pass in keyword arguments.
480
+ # request = Google::Cloud::Sql::V1beta4::SqlSslCertsListRequest.new
481
+ #
482
+ # # Call the list method.
483
+ # result = client.list request
484
+ #
485
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::SslCertsListResponse.
486
+ # p result
487
+ #
488
+ def list request, options = nil
489
+ raise ::ArgumentError, "request must be provided" if request.nil?
490
+
491
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlSslCertsListRequest
492
+
493
+ # Converts hash and nil to an options object
494
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
495
+
496
+ # Customize the options with defaults
497
+ call_metadata = @config.rpcs.list.metadata.to_h
498
+
499
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
500
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
501
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
502
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION,
503
+ transports_version_send: [:rest]
504
+
505
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
506
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
507
+
508
+ options.apply_defaults timeout: @config.rpcs.list.timeout,
509
+ metadata: call_metadata,
510
+ retry_policy: @config.rpcs.list.retry_policy
511
+
512
+ options.apply_defaults timeout: @config.timeout,
513
+ metadata: @config.metadata,
514
+ retry_policy: @config.retry_policy
515
+
516
+ @sql_ssl_certs_service_stub.list request, options do |result, operation|
517
+ yield result, operation if block_given?
518
+ end
519
+ rescue ::Gapic::Rest::Error => e
520
+ raise ::Google::Cloud::Error.from_error(e)
521
+ end
522
+
523
+ ##
524
+ # Configuration class for the SqlSslCertsService REST API.
525
+ #
526
+ # This class represents the configuration for SqlSslCertsService REST,
527
+ # providing control over timeouts, retry behavior, logging, transport
528
+ # parameters, and other low-level controls. Certain parameters can also be
529
+ # applied individually to specific RPCs. See
530
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client::Configuration::Rpcs}
531
+ # for a list of RPCs that can be configured independently.
532
+ #
533
+ # Configuration can be applied globally to all clients, or to a single client
534
+ # on construction.
535
+ #
536
+ # @example
537
+ #
538
+ # # Modify the global config, setting the timeout for
539
+ # # delete to 20 seconds,
540
+ # # and all remaining timeouts to 10 seconds.
541
+ # ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client.configure do |config|
542
+ # config.timeout = 10.0
543
+ # config.rpcs.delete.timeout = 20.0
544
+ # end
545
+ #
546
+ # # Apply the above configuration only to a new client.
547
+ # client = ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Rest::Client.new do |config|
548
+ # config.timeout = 10.0
549
+ # config.rpcs.delete.timeout = 20.0
550
+ # end
551
+ #
552
+ # @!attribute [rw] endpoint
553
+ # A custom service endpoint, as a hostname or hostname:port. The default is
554
+ # nil, indicating to use the default endpoint in the current universe domain.
555
+ # @return [::String,nil]
556
+ # @!attribute [rw] credentials
557
+ # Credentials to send with calls. You may provide any of the following types:
558
+ # * (`String`) The path to a service account key file in JSON format
559
+ # * (`Hash`) A service account key as a Hash
560
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
561
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
562
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
563
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
564
+ # * (`nil`) indicating no credentials
565
+ #
566
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
567
+ # external source for authentication to Google Cloud, you must validate it before
568
+ # providing it to a Google API client library. Providing an unvalidated credential
569
+ # configuration to Google APIs can compromise the security of your systems and data.
570
+ # For more information, refer to [Validate credential configurations from external
571
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
572
+ # @return [::Object]
573
+ # @!attribute [rw] scope
574
+ # The OAuth scopes
575
+ # @return [::Array<::String>]
576
+ # @!attribute [rw] lib_name
577
+ # The library name as recorded in instrumentation and logging
578
+ # @return [::String]
579
+ # @!attribute [rw] lib_version
580
+ # The library version as recorded in instrumentation and logging
581
+ # @return [::String]
582
+ # @!attribute [rw] timeout
583
+ # The call timeout in seconds.
584
+ # @return [::Numeric]
585
+ # @!attribute [rw] metadata
586
+ # Additional headers to be sent with the call.
587
+ # @return [::Hash{::Symbol=>::String}]
588
+ # @!attribute [rw] retry_policy
589
+ # The retry policy. The value is a hash with the following keys:
590
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
591
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
592
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
593
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
594
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
595
+ # trigger a retry.
596
+ # @return [::Hash]
597
+ # @!attribute [rw] quota_project
598
+ # A separate project against which to charge quota.
599
+ # @return [::String]
600
+ # @!attribute [rw] universe_domain
601
+ # The universe domain within which to make requests. This determines the
602
+ # default endpoint URL. The default value of nil uses the environment
603
+ # universe (usually the default "googleapis.com" universe).
604
+ # @return [::String,nil]
605
+ # @!attribute [rw] logger
606
+ # A custom logger to use for request/response debug logging, or the value
607
+ # `:default` (the default) to construct a default logger, or `nil` to
608
+ # explicitly disable logging.
609
+ # @return [::Logger,:default,nil]
610
+ #
611
+ class Configuration
612
+ extend ::Gapic::Config
613
+
614
+ # @private
615
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
616
+ DEFAULT_ENDPOINT = "sqladmin.googleapis.com"
617
+
618
+ config_attr :endpoint, nil, ::String, nil
619
+ config_attr :credentials, nil do |value|
620
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
621
+ allowed.any? { |klass| klass === value }
622
+ end
623
+ config_attr :scope, nil, ::String, ::Array, nil
624
+ config_attr :lib_name, nil, ::String, nil
625
+ config_attr :lib_version, nil, ::String, nil
626
+ config_attr :timeout, nil, ::Numeric, nil
627
+ config_attr :metadata, nil, ::Hash, nil
628
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
629
+ config_attr :quota_project, nil, ::String, nil
630
+ config_attr :universe_domain, nil, ::String, nil
631
+ config_attr :logger, :default, ::Logger, nil, :default
632
+
633
+ # @private
634
+ def initialize parent_config = nil
635
+ @parent_config = parent_config unless parent_config.nil?
636
+
637
+ yield self if block_given?
638
+ end
639
+
640
+ ##
641
+ # Configurations for individual RPCs
642
+ # @return [Rpcs]
643
+ #
644
+ def rpcs
645
+ @rpcs ||= begin
646
+ parent_rpcs = nil
647
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
648
+ Rpcs.new parent_rpcs
649
+ end
650
+ end
651
+
652
+ ##
653
+ # Configuration RPC class for the SqlSslCertsService API.
654
+ #
655
+ # Includes fields providing the configuration for each RPC in this service.
656
+ # Each configuration object is of type `Gapic::Config::Method` and includes
657
+ # the following configuration fields:
658
+ #
659
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
660
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
661
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
662
+ # include the following keys:
663
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
664
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
665
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
666
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
667
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
668
+ # trigger a retry.
669
+ #
670
+ class Rpcs
671
+ ##
672
+ # RPC-specific configuration for `delete`
673
+ # @return [::Gapic::Config::Method]
674
+ #
675
+ attr_reader :delete
676
+ ##
677
+ # RPC-specific configuration for `get`
678
+ # @return [::Gapic::Config::Method]
679
+ #
680
+ attr_reader :get
681
+ ##
682
+ # RPC-specific configuration for `insert`
683
+ # @return [::Gapic::Config::Method]
684
+ #
685
+ attr_reader :insert
686
+ ##
687
+ # RPC-specific configuration for `list`
688
+ # @return [::Gapic::Config::Method]
689
+ #
690
+ attr_reader :list
691
+
692
+ # @private
693
+ def initialize parent_rpcs = nil
694
+ delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
695
+ @delete = ::Gapic::Config::Method.new delete_config
696
+ get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
697
+ @get = ::Gapic::Config::Method.new get_config
698
+ insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
699
+ @insert = ::Gapic::Config::Method.new insert_config
700
+ list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
701
+ @list = ::Gapic::Config::Method.new list_config
702
+
703
+ yield self if block_given?
704
+ end
705
+ end
706
+ end
707
+ end
708
+ end
709
+ end
710
+ end
711
+ end
712
+ end
713
+ end