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,802 @@
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/location"
22
+
23
+ module Google
24
+ module Cloud
25
+ module Sql
26
+ module V1beta4
27
+ module SqlSslCertsService
28
+ ##
29
+ # Client for the SqlSslCertsService service.
30
+ #
31
+ class Client
32
+ # @private
33
+ API_VERSION = ""
34
+
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "sqladmin.$UNIVERSE_DOMAIN$"
37
+
38
+ # @private
39
+ attr_reader :sql_ssl_certs_service_stub
40
+
41
+ ##
42
+ # Configure the SqlSslCertsService Client class.
43
+ #
44
+ # See {::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client::Configuration}
45
+ # for a description of the configuration fields.
46
+ #
47
+ # @example
48
+ #
49
+ # # Modify the configuration for all SqlSslCertsService clients
50
+ # ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.configure do |config|
51
+ # config.timeout = 10.0
52
+ # end
53
+ #
54
+ # @yield [config] Configure the Client client.
55
+ # @yieldparam config [Client::Configuration]
56
+ #
57
+ # @return [Client::Configuration]
58
+ #
59
+ def self.configure
60
+ @configure ||= begin
61
+ namespace = ["Google", "Cloud", "Sql", "V1beta4"]
62
+ parent_config = while namespace.any?
63
+ parent_name = namespace.join "::"
64
+ parent_const = const_get parent_name
65
+ break parent_const.configure if parent_const.respond_to? :configure
66
+ namespace.pop
67
+ end
68
+ default_config = Client::Configuration.new parent_config
69
+
70
+ default_config.timeout = 60.0
71
+
72
+ default_config
73
+ end
74
+ yield @configure if block_given?
75
+ @configure
76
+ end
77
+
78
+ ##
79
+ # Configure the SqlSslCertsService Client instance.
80
+ #
81
+ # The configuration is set to the derived mode, meaning that values can be changed,
82
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
83
+ # should be made on {Client.configure}.
84
+ #
85
+ # See {::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client::Configuration}
86
+ # for a description of the configuration fields.
87
+ #
88
+ # @yield [config] Configure the Client client.
89
+ # @yieldparam config [Client::Configuration]
90
+ #
91
+ # @return [Client::Configuration]
92
+ #
93
+ def configure
94
+ yield @config if block_given?
95
+ @config
96
+ end
97
+
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @sql_ssl_certs_service_stub.universe_domain
105
+ end
106
+
107
+ ##
108
+ # Create a new SqlSslCertsService client object.
109
+ #
110
+ # @example
111
+ #
112
+ # # Create a client using the default configuration
113
+ # client = ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.new
114
+ #
115
+ # # Create a client using a custom configuration
116
+ # client = ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.new do |config|
117
+ # config.timeout = 10.0
118
+ # end
119
+ #
120
+ # @yield [config] Configure the SqlSslCertsService client.
121
+ # @yieldparam config [Client::Configuration]
122
+ #
123
+ def initialize
124
+ # These require statements are intentionally placed here to initialize
125
+ # the gRPC module only when it's required.
126
+ # See https://github.com/googleapis/toolkit/issues/446
127
+ require "gapic/grpc"
128
+ require "google/cloud/sql/v1beta4/cloud_sql_services_pb"
129
+
130
+ # Create the configuration object
131
+ @config = Configuration.new Client.configure
132
+
133
+ # Yield the configuration if needed
134
+ yield @config if block_given?
135
+
136
+ # Create credentials
137
+ credentials = @config.credentials
138
+ # Use self-signed JWT if the endpoint is unchanged from default,
139
+ # but only if the default endpoint does not have a region prefix.
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
143
+ credentials ||= Credentials.default scope: @config.scope,
144
+ enable_self_signed_jwt: enable_self_signed_jwt
145
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
146
+ credentials = Credentials.new credentials, scope: @config.scope
147
+ end
148
+ @quota_project_id = @config.quota_project
149
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
150
+
151
+ @sql_ssl_certs_service_stub = ::Gapic::ServiceStub.new(
152
+ ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Stub,
153
+ credentials: credentials,
154
+ endpoint: @config.endpoint,
155
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
156
+ universe_domain: @config.universe_domain,
157
+ channel_args: @config.channel_args,
158
+ interceptors: @config.interceptors,
159
+ channel_pool_config: @config.channel_pool,
160
+ logger: @config.logger
161
+ )
162
+
163
+ @sql_ssl_certs_service_stub.stub_logger&.info do |entry|
164
+ entry.set_system_name
165
+ entry.set_service
166
+ entry.message = "Created client for #{entry.service}"
167
+ entry.set_credentials_fields credentials
168
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
169
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
170
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
171
+ end
172
+
173
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
174
+ config.credentials = credentials
175
+ config.quota_project = @quota_project_id
176
+ config.endpoint = @sql_ssl_certs_service_stub.endpoint
177
+ config.universe_domain = @sql_ssl_certs_service_stub.universe_domain
178
+ config.logger = @sql_ssl_certs_service_stub.logger if config.respond_to? :logger=
179
+ end
180
+ end
181
+
182
+ ##
183
+ # Get the associated client for mix-in of the Locations.
184
+ #
185
+ # @return [Google::Cloud::Location::Locations::Client]
186
+ #
187
+ attr_reader :location_client
188
+
189
+ ##
190
+ # The logger used for request/response debug logging.
191
+ #
192
+ # @return [Logger]
193
+ #
194
+ def logger
195
+ @sql_ssl_certs_service_stub.logger
196
+ end
197
+
198
+ # Service calls
199
+
200
+ ##
201
+ # Deletes the SSL certificate. For First Generation instances, the
202
+ # certificate remains valid until the instance is restarted.
203
+ #
204
+ # @overload delete(request, options = nil)
205
+ # Pass arguments to `delete` via a request object, either of type
206
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsDeleteRequest} or an equivalent Hash.
207
+ #
208
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlSslCertsDeleteRequest, ::Hash]
209
+ # A request object representing the call parameters. Required. To specify no
210
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
211
+ # @param options [::Gapic::CallOptions, ::Hash]
212
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
213
+ #
214
+ # @overload delete(instance: nil, project: nil, sha1_fingerprint: nil)
215
+ # Pass arguments to `delete` via keyword arguments. Note that at
216
+ # least one keyword argument is required. To specify no parameters, or to keep all
217
+ # the default parameter values, pass an empty Hash as a request object (see above).
218
+ #
219
+ # @param instance [::String]
220
+ # Cloud SQL instance ID. This does not include the project ID.
221
+ # @param project [::String]
222
+ # Project ID of the project that contains the instance.
223
+ # @param sha1_fingerprint [::String]
224
+ # Sha1 FingerPrint.
225
+ #
226
+ # @yield [response, operation] Access the result along with the RPC operation
227
+ # @yieldparam response [::Google::Cloud::Sql::V1beta4::Operation]
228
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
229
+ #
230
+ # @return [::Google::Cloud::Sql::V1beta4::Operation]
231
+ #
232
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
233
+ #
234
+ # @example Basic example
235
+ # require "google/cloud/sql/v1beta4"
236
+ #
237
+ # # Create a client object. The client can be reused for multiple calls.
238
+ # client = Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.new
239
+ #
240
+ # # Create a request. To set request fields, pass in keyword arguments.
241
+ # request = Google::Cloud::Sql::V1beta4::SqlSslCertsDeleteRequest.new
242
+ #
243
+ # # Call the delete method.
244
+ # result = client.delete request
245
+ #
246
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::Operation.
247
+ # p result
248
+ #
249
+ def delete request, options = nil
250
+ raise ::ArgumentError, "request must be provided" if request.nil?
251
+
252
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlSslCertsDeleteRequest
253
+
254
+ # Converts hash and nil to an options object
255
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
256
+
257
+ # Customize the options with defaults
258
+ metadata = @config.rpcs.delete.metadata.to_h
259
+
260
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
261
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
262
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
263
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION
264
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
265
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
266
+
267
+ header_params = {}
268
+ if request.project
269
+ header_params["project"] = request.project
270
+ end
271
+ if request.instance
272
+ header_params["instance"] = request.instance
273
+ end
274
+ if request.sha1_fingerprint
275
+ header_params["sha1_fingerprint"] = request.sha1_fingerprint
276
+ end
277
+
278
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
279
+ metadata[:"x-goog-request-params"] ||= request_params_header
280
+
281
+ options.apply_defaults timeout: @config.rpcs.delete.timeout,
282
+ metadata: metadata,
283
+ retry_policy: @config.rpcs.delete.retry_policy
284
+
285
+ options.apply_defaults timeout: @config.timeout,
286
+ metadata: @config.metadata,
287
+ retry_policy: @config.retry_policy
288
+
289
+ @sql_ssl_certs_service_stub.call_rpc :delete, request, options: options do |response, operation|
290
+ yield response, operation if block_given?
291
+ end
292
+ rescue ::GRPC::BadStatus => e
293
+ raise ::Google::Cloud::Error.from_error(e)
294
+ end
295
+
296
+ ##
297
+ # Retrieves a particular SSL certificate. Does not include the private key
298
+ # (required for usage). The private key must be saved from the response to
299
+ # initial creation.
300
+ #
301
+ # @overload get(request, options = nil)
302
+ # Pass arguments to `get` via a request object, either of type
303
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsGetRequest} or an equivalent Hash.
304
+ #
305
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlSslCertsGetRequest, ::Hash]
306
+ # A request object representing the call parameters. Required. To specify no
307
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
308
+ # @param options [::Gapic::CallOptions, ::Hash]
309
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
310
+ #
311
+ # @overload get(instance: nil, project: nil, sha1_fingerprint: nil)
312
+ # Pass arguments to `get` via keyword arguments. Note that at
313
+ # least one keyword argument is required. To specify no parameters, or to keep all
314
+ # the default parameter values, pass an empty Hash as a request object (see above).
315
+ #
316
+ # @param instance [::String]
317
+ # Cloud SQL instance ID. This does not include the project ID.
318
+ # @param project [::String]
319
+ # Project ID of the project that contains the instance.
320
+ # @param sha1_fingerprint [::String]
321
+ # Sha1 FingerPrint.
322
+ #
323
+ # @yield [response, operation] Access the result along with the RPC operation
324
+ # @yieldparam response [::Google::Cloud::Sql::V1beta4::SslCert]
325
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
326
+ #
327
+ # @return [::Google::Cloud::Sql::V1beta4::SslCert]
328
+ #
329
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
330
+ #
331
+ # @example Basic example
332
+ # require "google/cloud/sql/v1beta4"
333
+ #
334
+ # # Create a client object. The client can be reused for multiple calls.
335
+ # client = Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.new
336
+ #
337
+ # # Create a request. To set request fields, pass in keyword arguments.
338
+ # request = Google::Cloud::Sql::V1beta4::SqlSslCertsGetRequest.new
339
+ #
340
+ # # Call the get method.
341
+ # result = client.get request
342
+ #
343
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::SslCert.
344
+ # p result
345
+ #
346
+ def get request, options = nil
347
+ raise ::ArgumentError, "request must be provided" if request.nil?
348
+
349
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlSslCertsGetRequest
350
+
351
+ # Converts hash and nil to an options object
352
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
353
+
354
+ # Customize the options with defaults
355
+ metadata = @config.rpcs.get.metadata.to_h
356
+
357
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
358
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
359
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
360
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION
361
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
362
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
363
+
364
+ header_params = {}
365
+ if request.project
366
+ header_params["project"] = request.project
367
+ end
368
+ if request.instance
369
+ header_params["instance"] = request.instance
370
+ end
371
+ if request.sha1_fingerprint
372
+ header_params["sha1_fingerprint"] = request.sha1_fingerprint
373
+ end
374
+
375
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
376
+ metadata[:"x-goog-request-params"] ||= request_params_header
377
+
378
+ options.apply_defaults timeout: @config.rpcs.get.timeout,
379
+ metadata: metadata,
380
+ retry_policy: @config.rpcs.get.retry_policy
381
+
382
+ options.apply_defaults timeout: @config.timeout,
383
+ metadata: @config.metadata,
384
+ retry_policy: @config.retry_policy
385
+
386
+ @sql_ssl_certs_service_stub.call_rpc :get, request, options: options do |response, operation|
387
+ yield response, operation if block_given?
388
+ end
389
+ rescue ::GRPC::BadStatus => e
390
+ raise ::Google::Cloud::Error.from_error(e)
391
+ end
392
+
393
+ ##
394
+ # Creates an SSL certificate and returns it along with the private key and
395
+ # server certificate authority. The new certificate will not be usable until
396
+ # the instance is restarted.
397
+ #
398
+ # @overload insert(request, options = nil)
399
+ # Pass arguments to `insert` via a request object, either of type
400
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsInsertRequest} or an equivalent Hash.
401
+ #
402
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlSslCertsInsertRequest, ::Hash]
403
+ # A request object representing the call parameters. Required. To specify no
404
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
405
+ # @param options [::Gapic::CallOptions, ::Hash]
406
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
407
+ #
408
+ # @overload insert(instance: nil, project: nil, body: nil)
409
+ # Pass arguments to `insert` via keyword arguments. Note that at
410
+ # least one keyword argument is required. To specify no parameters, or to keep all
411
+ # the default parameter values, pass an empty Hash as a request object (see above).
412
+ #
413
+ # @param instance [::String]
414
+ # Cloud SQL instance ID. This does not include the project ID.
415
+ # @param project [::String]
416
+ # Project ID of the project that contains the instance.
417
+ # @param body [::Google::Cloud::Sql::V1beta4::SslCertsInsertRequest, ::Hash]
418
+ #
419
+ # @yield [response, operation] Access the result along with the RPC operation
420
+ # @yieldparam response [::Google::Cloud::Sql::V1beta4::SslCertsInsertResponse]
421
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
422
+ #
423
+ # @return [::Google::Cloud::Sql::V1beta4::SslCertsInsertResponse]
424
+ #
425
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
426
+ #
427
+ # @example Basic example
428
+ # require "google/cloud/sql/v1beta4"
429
+ #
430
+ # # Create a client object. The client can be reused for multiple calls.
431
+ # client = Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.new
432
+ #
433
+ # # Create a request. To set request fields, pass in keyword arguments.
434
+ # request = Google::Cloud::Sql::V1beta4::SqlSslCertsInsertRequest.new
435
+ #
436
+ # # Call the insert method.
437
+ # result = client.insert request
438
+ #
439
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::SslCertsInsertResponse.
440
+ # p result
441
+ #
442
+ def insert request, options = nil
443
+ raise ::ArgumentError, "request must be provided" if request.nil?
444
+
445
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlSslCertsInsertRequest
446
+
447
+ # Converts hash and nil to an options object
448
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
449
+
450
+ # Customize the options with defaults
451
+ metadata = @config.rpcs.insert.metadata.to_h
452
+
453
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
454
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
455
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
456
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION
457
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
458
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
459
+
460
+ header_params = {}
461
+ if request.project
462
+ header_params["project"] = request.project
463
+ end
464
+ if request.instance
465
+ header_params["instance"] = request.instance
466
+ end
467
+
468
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
469
+ metadata[:"x-goog-request-params"] ||= request_params_header
470
+
471
+ options.apply_defaults timeout: @config.rpcs.insert.timeout,
472
+ metadata: metadata,
473
+ retry_policy: @config.rpcs.insert.retry_policy
474
+
475
+ options.apply_defaults timeout: @config.timeout,
476
+ metadata: @config.metadata,
477
+ retry_policy: @config.retry_policy
478
+
479
+ @sql_ssl_certs_service_stub.call_rpc :insert, request, options: options do |response, operation|
480
+ yield response, operation if block_given?
481
+ end
482
+ rescue ::GRPC::BadStatus => e
483
+ raise ::Google::Cloud::Error.from_error(e)
484
+ end
485
+
486
+ ##
487
+ # Lists all of the current SSL certificates for the instance.
488
+ #
489
+ # @overload list(request, options = nil)
490
+ # Pass arguments to `list` via a request object, either of type
491
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsListRequest} or an equivalent Hash.
492
+ #
493
+ # @param request [::Google::Cloud::Sql::V1beta4::SqlSslCertsListRequest, ::Hash]
494
+ # A request object representing the call parameters. Required. To specify no
495
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
496
+ # @param options [::Gapic::CallOptions, ::Hash]
497
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
498
+ #
499
+ # @overload list(instance: nil, project: nil)
500
+ # Pass arguments to `list` via keyword arguments. Note that at
501
+ # least one keyword argument is required. To specify no parameters, or to keep all
502
+ # the default parameter values, pass an empty Hash as a request object (see above).
503
+ #
504
+ # @param instance [::String]
505
+ # Cloud SQL instance ID. This does not include the project ID.
506
+ # @param project [::String]
507
+ # Project ID of the project that contains the instance.
508
+ #
509
+ # @yield [response, operation] Access the result along with the RPC operation
510
+ # @yieldparam response [::Google::Cloud::Sql::V1beta4::SslCertsListResponse]
511
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
512
+ #
513
+ # @return [::Google::Cloud::Sql::V1beta4::SslCertsListResponse]
514
+ #
515
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
516
+ #
517
+ # @example Basic example
518
+ # require "google/cloud/sql/v1beta4"
519
+ #
520
+ # # Create a client object. The client can be reused for multiple calls.
521
+ # client = Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.new
522
+ #
523
+ # # Create a request. To set request fields, pass in keyword arguments.
524
+ # request = Google::Cloud::Sql::V1beta4::SqlSslCertsListRequest.new
525
+ #
526
+ # # Call the list method.
527
+ # result = client.list request
528
+ #
529
+ # # The returned object is of type Google::Cloud::Sql::V1beta4::SslCertsListResponse.
530
+ # p result
531
+ #
532
+ def list request, options = nil
533
+ raise ::ArgumentError, "request must be provided" if request.nil?
534
+
535
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1beta4::SqlSslCertsListRequest
536
+
537
+ # Converts hash and nil to an options object
538
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
539
+
540
+ # Customize the options with defaults
541
+ metadata = @config.rpcs.list.metadata.to_h
542
+
543
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
544
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
545
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
546
+ gapic_version: ::Google::Cloud::Sql::V1beta4::VERSION
547
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
548
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
549
+
550
+ header_params = {}
551
+ if request.project
552
+ header_params["project"] = request.project
553
+ end
554
+ if request.instance
555
+ header_params["instance"] = request.instance
556
+ end
557
+
558
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
559
+ metadata[:"x-goog-request-params"] ||= request_params_header
560
+
561
+ options.apply_defaults timeout: @config.rpcs.list.timeout,
562
+ metadata: metadata,
563
+ retry_policy: @config.rpcs.list.retry_policy
564
+
565
+ options.apply_defaults timeout: @config.timeout,
566
+ metadata: @config.metadata,
567
+ retry_policy: @config.retry_policy
568
+
569
+ @sql_ssl_certs_service_stub.call_rpc :list, request, options: options do |response, operation|
570
+ yield response, operation if block_given?
571
+ end
572
+ rescue ::GRPC::BadStatus => e
573
+ raise ::Google::Cloud::Error.from_error(e)
574
+ end
575
+
576
+ ##
577
+ # Configuration class for the SqlSslCertsService API.
578
+ #
579
+ # This class represents the configuration for SqlSslCertsService,
580
+ # providing control over timeouts, retry behavior, logging, transport
581
+ # parameters, and other low-level controls. Certain parameters can also be
582
+ # applied individually to specific RPCs. See
583
+ # {::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client::Configuration::Rpcs}
584
+ # for a list of RPCs that can be configured independently.
585
+ #
586
+ # Configuration can be applied globally to all clients, or to a single client
587
+ # on construction.
588
+ #
589
+ # @example
590
+ #
591
+ # # Modify the global config, setting the timeout for
592
+ # # delete to 20 seconds,
593
+ # # and all remaining timeouts to 10 seconds.
594
+ # ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.configure do |config|
595
+ # config.timeout = 10.0
596
+ # config.rpcs.delete.timeout = 20.0
597
+ # end
598
+ #
599
+ # # Apply the above configuration only to a new client.
600
+ # client = ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.new do |config|
601
+ # config.timeout = 10.0
602
+ # config.rpcs.delete.timeout = 20.0
603
+ # end
604
+ #
605
+ # @!attribute [rw] endpoint
606
+ # A custom service endpoint, as a hostname or hostname:port. The default is
607
+ # nil, indicating to use the default endpoint in the current universe domain.
608
+ # @return [::String,nil]
609
+ # @!attribute [rw] credentials
610
+ # Credentials to send with calls. You may provide any of the following types:
611
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
612
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
613
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
614
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
615
+ # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
616
+ # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
617
+ # * (`nil`) indicating no credentials
618
+ #
619
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
620
+ # is deprecated. Providing an unvalidated credential configuration to
621
+ # Google APIs can compromise the security of your systems and data.
622
+ #
623
+ # @example
624
+ #
625
+ # # The recommended way to provide credentials is to use the `make_creds` method
626
+ # # on the appropriate credentials class for your environment.
627
+ #
628
+ # require "googleauth"
629
+ #
630
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
631
+ # json_key_io: ::File.open("/path/to/keyfile.json")
632
+ # )
633
+ #
634
+ # client = ::Google::Cloud::Sql::V1beta4::SqlSslCertsService::Client.new do |config|
635
+ # config.credentials = credentials
636
+ # end
637
+ #
638
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
639
+ # external source for authentication to Google Cloud, you must validate it before
640
+ # providing it to a Google API client library. Providing an unvalidated credential
641
+ # configuration to Google APIs can compromise the security of your systems and data.
642
+ # For more information, refer to [Validate credential configurations from external
643
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
644
+ # @return [::Object]
645
+ # @!attribute [rw] scope
646
+ # The OAuth scopes
647
+ # @return [::Array<::String>]
648
+ # @!attribute [rw] lib_name
649
+ # The library name as recorded in instrumentation and logging
650
+ # @return [::String]
651
+ # @!attribute [rw] lib_version
652
+ # The library version as recorded in instrumentation and logging
653
+ # @return [::String]
654
+ # @!attribute [rw] channel_args
655
+ # Extra parameters passed to the gRPC channel. Note: this is ignored if a
656
+ # `GRPC::Core::Channel` object is provided as the credential.
657
+ # @return [::Hash]
658
+ # @!attribute [rw] interceptors
659
+ # An array of interceptors that are run before calls are executed.
660
+ # @return [::Array<::GRPC::ClientInterceptor>]
661
+ # @!attribute [rw] timeout
662
+ # The call timeout in seconds.
663
+ # @return [::Numeric]
664
+ # @!attribute [rw] metadata
665
+ # Additional gRPC headers to be sent with the call.
666
+ # @return [::Hash{::Symbol=>::String}]
667
+ # @!attribute [rw] retry_policy
668
+ # The retry policy. The value is a hash with the following keys:
669
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
670
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
671
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
672
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
673
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
674
+ # trigger a retry.
675
+ # @return [::Hash]
676
+ # @!attribute [rw] quota_project
677
+ # A separate project against which to charge quota.
678
+ # @return [::String]
679
+ # @!attribute [rw] universe_domain
680
+ # The universe domain within which to make requests. This determines the
681
+ # default endpoint URL. The default value of nil uses the environment
682
+ # universe (usually the default "googleapis.com" universe).
683
+ # @return [::String,nil]
684
+ # @!attribute [rw] logger
685
+ # A custom logger to use for request/response debug logging, or the value
686
+ # `:default` (the default) to construct a default logger, or `nil` to
687
+ # explicitly disable logging.
688
+ # @return [::Logger,:default,nil]
689
+ #
690
+ class Configuration
691
+ extend ::Gapic::Config
692
+
693
+ # @private
694
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
695
+ DEFAULT_ENDPOINT = "sqladmin.googleapis.com"
696
+
697
+ config_attr :endpoint, nil, ::String, nil
698
+ config_attr :credentials, nil do |value|
699
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
700
+ allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
701
+ allowed.any? { |klass| klass === value }
702
+ end
703
+ config_attr :scope, nil, ::String, ::Array, nil
704
+ config_attr :lib_name, nil, ::String, nil
705
+ config_attr :lib_version, nil, ::String, nil
706
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
707
+ config_attr :interceptors, nil, ::Array, nil
708
+ config_attr :timeout, nil, ::Numeric, nil
709
+ config_attr :metadata, nil, ::Hash, nil
710
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
711
+ config_attr :quota_project, nil, ::String, nil
712
+ config_attr :universe_domain, nil, ::String, nil
713
+ config_attr :logger, :default, ::Logger, nil, :default
714
+
715
+ # @private
716
+ def initialize parent_config = nil
717
+ @parent_config = parent_config unless parent_config.nil?
718
+
719
+ yield self if block_given?
720
+ end
721
+
722
+ ##
723
+ # Configurations for individual RPCs
724
+ # @return [Rpcs]
725
+ #
726
+ def rpcs
727
+ @rpcs ||= begin
728
+ parent_rpcs = nil
729
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
730
+ Rpcs.new parent_rpcs
731
+ end
732
+ end
733
+
734
+ ##
735
+ # Configuration for the channel pool
736
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
737
+ #
738
+ def channel_pool
739
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
740
+ end
741
+
742
+ ##
743
+ # Configuration RPC class for the SqlSslCertsService API.
744
+ #
745
+ # Includes fields providing the configuration for each RPC in this service.
746
+ # Each configuration object is of type `Gapic::Config::Method` and includes
747
+ # the following configuration fields:
748
+ #
749
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
750
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
751
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
752
+ # include the following keys:
753
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
754
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
755
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
756
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
757
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
758
+ # trigger a retry.
759
+ #
760
+ class Rpcs
761
+ ##
762
+ # RPC-specific configuration for `delete`
763
+ # @return [::Gapic::Config::Method]
764
+ #
765
+ attr_reader :delete
766
+ ##
767
+ # RPC-specific configuration for `get`
768
+ # @return [::Gapic::Config::Method]
769
+ #
770
+ attr_reader :get
771
+ ##
772
+ # RPC-specific configuration for `insert`
773
+ # @return [::Gapic::Config::Method]
774
+ #
775
+ attr_reader :insert
776
+ ##
777
+ # RPC-specific configuration for `list`
778
+ # @return [::Gapic::Config::Method]
779
+ #
780
+ attr_reader :list
781
+
782
+ # @private
783
+ def initialize parent_rpcs = nil
784
+ delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
785
+ @delete = ::Gapic::Config::Method.new delete_config
786
+ get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
787
+ @get = ::Gapic::Config::Method.new get_config
788
+ insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
789
+ @insert = ::Gapic::Config::Method.new insert_config
790
+ list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
791
+ @list = ::Gapic::Config::Method.new list_config
792
+
793
+ yield self if block_given?
794
+ end
795
+ end
796
+ end
797
+ end
798
+ end
799
+ end
800
+ end
801
+ end
802
+ end