google-cloud-sql-v1 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +146 -8
  5. data/lib/google/cloud/sql/v1/cloud_sql_available_database_versions_pb.rb +25 -0
  6. data/lib/google/cloud/sql/v1/cloud_sql_available_database_versions_services_pb.rb +29 -0
  7. data/lib/google/cloud/sql/v1/cloud_sql_backup_runs_pb.rb +35 -0
  8. data/lib/google/cloud/sql/v1/cloud_sql_backup_runs_services_pb.rb +53 -0
  9. data/lib/google/cloud/sql/v1/cloud_sql_backups_pb.rb +41 -0
  10. data/lib/google/cloud/sql/v1/cloud_sql_backups_services_pb.rb +54 -0
  11. data/lib/google/cloud/sql/v1/cloud_sql_connect_pb.rb +34 -0
  12. data/lib/google/cloud/sql/v1/cloud_sql_connect_services_pb.rb +50 -0
  13. data/lib/google/cloud/sql/v1/cloud_sql_databases_pb.rb +30 -0
  14. data/lib/google/cloud/sql/v1/cloud_sql_databases_services_pb.rb +61 -0
  15. data/lib/google/cloud/sql/v1/cloud_sql_events_pb.rb +25 -0
  16. data/lib/google/cloud/sql/v1/cloud_sql_events_services_pb.rb +29 -0
  17. data/lib/google/cloud/sql/v1/cloud_sql_feature_eligibility_pb.rb +24 -0
  18. data/lib/google/cloud/sql/v1/cloud_sql_feature_eligibility_services_pb.rb +29 -0
  19. data/lib/google/cloud/sql/v1/cloud_sql_flags_pb.rb +31 -0
  20. data/lib/google/cloud/sql/v1/cloud_sql_flags_services_pb.rb +45 -0
  21. data/lib/google/cloud/sql/v1/cloud_sql_iam_policies_pb.rb +23 -0
  22. data/lib/google/cloud/sql/v1/cloud_sql_iam_policies_services_pb.rb +29 -0
  23. data/lib/google/cloud/sql/v1/cloud_sql_instance_names_pb.rb +24 -0
  24. data/lib/google/cloud/sql/v1/cloud_sql_instance_names_services_pb.rb +29 -0
  25. data/lib/google/cloud/sql/v1/cloud_sql_instances_pb.rb +146 -0
  26. data/lib/google/cloud/sql/v1/cloud_sql_instances_services_pb.rb +184 -0
  27. data/lib/google/cloud/sql/v1/cloud_sql_operations_pb.rb +30 -0
  28. data/lib/google/cloud/sql/v1/cloud_sql_operations_services_pb.rb +50 -0
  29. data/lib/google/cloud/sql/v1/cloud_sql_regions_pb.rb +25 -0
  30. data/lib/google/cloud/sql/v1/cloud_sql_regions_services_pb.rb +29 -0
  31. data/lib/google/cloud/sql/v1/cloud_sql_resources_pb.rb +119 -0
  32. data/lib/google/cloud/sql/v1/cloud_sql_ssl_certs_pb.rb +31 -0
  33. data/lib/google/cloud/sql/v1/cloud_sql_ssl_certs_services_pb.rb +56 -0
  34. data/lib/google/cloud/sql/v1/cloud_sql_tiers_pb.rb +26 -0
  35. data/lib/google/cloud/sql/v1/cloud_sql_tiers_services_pb.rb +47 -0
  36. data/lib/google/cloud/sql/v1/cloud_sql_users_pb.rb +41 -0
  37. data/lib/google/cloud/sql/v1/cloud_sql_users_services_pb.rb +53 -0
  38. data/lib/google/cloud/sql/v1/rest.rb +46 -0
  39. data/lib/google/cloud/sql/v1/sql_backup_runs_service/client.rb +809 -0
  40. data/lib/google/cloud/sql/v1/sql_backup_runs_service/credentials.rb +48 -0
  41. data/lib/google/cloud/sql/v1/sql_backup_runs_service/rest/client.rb +720 -0
  42. data/lib/google/cloud/sql/v1/sql_backup_runs_service/rest/service_stub.rb +332 -0
  43. data/lib/google/cloud/sql/v1/sql_backup_runs_service/rest.rb +51 -0
  44. data/lib/google/cloud/sql/v1/sql_backup_runs_service.rb +54 -0
  45. data/lib/google/cloud/sql/v1/sql_backups_service/client.rb +896 -0
  46. data/lib/google/cloud/sql/v1/sql_backups_service/credentials.rb +48 -0
  47. data/lib/google/cloud/sql/v1/sql_backups_service/paths.rb +64 -0
  48. data/lib/google/cloud/sql/v1/sql_backups_service/rest/client.rb +818 -0
  49. data/lib/google/cloud/sql/v1/sql_backups_service/rest/service_stub.rb +388 -0
  50. data/lib/google/cloud/sql/v1/sql_backups_service/rest.rb +50 -0
  51. data/lib/google/cloud/sql/v1/sql_backups_service.rb +53 -0
  52. data/lib/google/cloud/sql/v1/sql_connect_service/client.rb +607 -0
  53. data/lib/google/cloud/sql/v1/sql_connect_service/credentials.rb +48 -0
  54. data/lib/google/cloud/sql/v1/sql_connect_service/rest/client.rb +544 -0
  55. data/lib/google/cloud/sql/v1/sql_connect_service/rest/service_stub.rb +206 -0
  56. data/lib/google/cloud/sql/v1/sql_connect_service/rest.rb +51 -0
  57. data/lib/google/cloud/sql/v1/sql_connect_service.rb +54 -0
  58. data/lib/google/cloud/sql/v1/sql_databases_service/client.rb +1011 -0
  59. data/lib/google/cloud/sql/v1/sql_databases_service/credentials.rb +48 -0
  60. data/lib/google/cloud/sql/v1/sql_databases_service/rest/client.rb +896 -0
  61. data/lib/google/cloud/sql/v1/sql_databases_service/rest/service_stub.rb +460 -0
  62. data/lib/google/cloud/sql/v1/sql_databases_service/rest.rb +51 -0
  63. data/lib/google/cloud/sql/v1/sql_databases_service.rb +54 -0
  64. data/lib/google/cloud/sql/v1/sql_flags_service/client.rb +488 -0
  65. data/lib/google/cloud/sql/v1/sql_flags_service/credentials.rb +48 -0
  66. data/lib/google/cloud/sql/v1/sql_flags_service/rest/client.rb +446 -0
  67. data/lib/google/cloud/sql/v1/sql_flags_service/rest/service_stub.rb +140 -0
  68. data/lib/google/cloud/sql/v1/sql_flags_service/rest.rb +51 -0
  69. data/lib/google/cloud/sql/v1/sql_flags_service.rb +54 -0
  70. data/lib/google/cloud/sql/v1/sql_instances_service/client.rb +4738 -0
  71. data/lib/google/cloud/sql/v1/sql_instances_service/credentials.rb +48 -0
  72. data/lib/google/cloud/sql/v1/sql_instances_service/paths.rb +95 -0
  73. data/lib/google/cloud/sql/v1/sql_instances_service/rest/client.rb +4274 -0
  74. data/lib/google/cloud/sql/v1/sql_instances_service/rest/service_stub.rb +2769 -0
  75. data/lib/google/cloud/sql/v1/sql_instances_service/rest.rb +50 -0
  76. data/lib/google/cloud/sql/v1/sql_instances_service.rb +53 -0
  77. data/lib/google/cloud/sql/v1/sql_operations_service/client.rb +694 -0
  78. data/lib/google/cloud/sql/v1/sql_operations_service/credentials.rb +48 -0
  79. data/lib/google/cloud/sql/v1/sql_operations_service/rest/client.rb +624 -0
  80. data/lib/google/cloud/sql/v1/sql_operations_service/rest/service_stub.rb +266 -0
  81. data/lib/google/cloud/sql/v1/sql_operations_service/rest.rb +51 -0
  82. data/lib/google/cloud/sql/v1/sql_operations_service.rb +54 -0
  83. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/client.rb +804 -0
  84. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/credentials.rb +48 -0
  85. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/rest/client.rb +715 -0
  86. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/rest/service_stub.rb +332 -0
  87. data/lib/google/cloud/sql/v1/sql_ssl_certs_service/rest.rb +51 -0
  88. data/lib/google/cloud/sql/v1/sql_ssl_certs_service.rb +54 -0
  89. data/lib/google/cloud/sql/v1/sql_tiers_service/client.rb +494 -0
  90. data/lib/google/cloud/sql/v1/sql_tiers_service/credentials.rb +48 -0
  91. data/lib/google/cloud/sql/v1/sql_tiers_service/rest/client.rb +444 -0
  92. data/lib/google/cloud/sql/v1/sql_tiers_service/rest/service_stub.rb +142 -0
  93. data/lib/google/cloud/sql/v1/sql_tiers_service/rest.rb +51 -0
  94. data/lib/google/cloud/sql/v1/sql_tiers_service.rb +54 -0
  95. data/lib/google/cloud/sql/v1/sql_users_service/client.rb +909 -0
  96. data/lib/google/cloud/sql/v1/sql_users_service/credentials.rb +48 -0
  97. data/lib/google/cloud/sql/v1/sql_users_service/rest/client.rb +813 -0
  98. data/lib/google/cloud/sql/v1/sql_users_service/rest/service_stub.rb +394 -0
  99. data/lib/google/cloud/sql/v1/sql_users_service/rest.rb +51 -0
  100. data/lib/google/cloud/sql/v1/sql_users_service.rb +54 -0
  101. data/lib/google/cloud/sql/v1/version.rb +8 -3
  102. data/lib/google/cloud/sql/v1.rb +60 -0
  103. data/lib/google-cloud-sql-v1.rb +21 -0
  104. data/proto_docs/README.md +4 -0
  105. data/proto_docs/google/api/client.rb +593 -0
  106. data/proto_docs/google/api/field_behavior.rb +85 -0
  107. data/proto_docs/google/api/field_info.rb +88 -0
  108. data/proto_docs/google/api/launch_stage.rb +71 -0
  109. data/proto_docs/google/api/resource.rb +227 -0
  110. data/proto_docs/google/cloud/sql/v1/cloud_sql_backup_runs.rb +245 -0
  111. data/proto_docs/google/cloud/sql/v1/cloud_sql_backups.rb +259 -0
  112. data/proto_docs/google/cloud/sql/v1/cloud_sql_connect.rb +190 -0
  113. data/proto_docs/google/cloud/sql/v1/cloud_sql_databases.rb +111 -0
  114. data/proto_docs/google/cloud/sql/v1/cloud_sql_flags.rb +154 -0
  115. data/proto_docs/google/cloud/sql/v1/cloud_sql_instances.rb +2357 -0
  116. data/proto_docs/google/cloud/sql/v1/cloud_sql_operations.rb +85 -0
  117. data/proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb +2522 -0
  118. data/proto_docs/google/cloud/sql/v1/cloud_sql_ssl_certs.rb +120 -0
  119. data/proto_docs/google/cloud/sql/v1/cloud_sql_tiers.rb +69 -0
  120. data/proto_docs/google/cloud/sql/v1/cloud_sql_users.rb +291 -0
  121. data/proto_docs/google/protobuf/any.rb +145 -0
  122. data/proto_docs/google/protobuf/duration.rb +98 -0
  123. data/proto_docs/google/protobuf/empty.rb +34 -0
  124. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  125. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  126. data/proto_docs/google/protobuf/wrappers.rb +148 -0
  127. data/proto_docs/google/rpc/status.rb +48 -0
  128. data/proto_docs/google/type/interval.rb +45 -0
  129. metadata +176 -14
@@ -0,0 +1,715 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/errors"
20
+ require "google/cloud/sql/v1/cloud_sql_ssl_certs_pb"
21
+ require "google/cloud/sql/v1/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 V1
28
+ module SqlSslCertsService
29
+ module Rest
30
+ ##
31
+ # REST client for the SqlSslCertsService service.
32
+ #
33
+ # Service to manage SSL certs for Cloud SQL instances.
34
+ #
35
+ class Client
36
+ # @private
37
+ API_VERSION = ""
38
+
39
+ # @private
40
+ DEFAULT_ENDPOINT_TEMPLATE = "sqladmin.$UNIVERSE_DOMAIN$"
41
+
42
+ # @private
43
+ attr_reader :sql_ssl_certs_service_stub
44
+
45
+ ##
46
+ # Configure the SqlSslCertsService Client class.
47
+ #
48
+ # See {::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client::Configuration}
49
+ # for a description of the configuration fields.
50
+ #
51
+ # @example
52
+ #
53
+ # # Modify the configuration for all SqlSslCertsService clients
54
+ # ::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.configure do |config|
55
+ # config.timeout = 10.0
56
+ # end
57
+ #
58
+ # @yield [config] Configure the Client client.
59
+ # @yieldparam config [Client::Configuration]
60
+ #
61
+ # @return [Client::Configuration]
62
+ #
63
+ def self.configure
64
+ @configure ||= begin
65
+ namespace = ["Google", "Cloud", "Sql", "V1"]
66
+ parent_config = while namespace.any?
67
+ parent_name = namespace.join "::"
68
+ parent_const = const_get parent_name
69
+ break parent_const.configure if parent_const.respond_to? :configure
70
+ namespace.pop
71
+ end
72
+ default_config = Client::Configuration.new parent_config
73
+
74
+ default_config.timeout = 60.0
75
+
76
+ default_config
77
+ end
78
+ yield @configure if block_given?
79
+ @configure
80
+ end
81
+
82
+ ##
83
+ # Configure the SqlSslCertsService Client instance.
84
+ #
85
+ # The configuration is set to the derived mode, meaning that values can be changed,
86
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
87
+ # should be made on {Client.configure}.
88
+ #
89
+ # See {::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client::Configuration}
90
+ # for a description of the configuration fields.
91
+ #
92
+ # @yield [config] Configure the Client client.
93
+ # @yieldparam config [Client::Configuration]
94
+ #
95
+ # @return [Client::Configuration]
96
+ #
97
+ def configure
98
+ yield @config if block_given?
99
+ @config
100
+ end
101
+
102
+ ##
103
+ # The effective universe domain
104
+ #
105
+ # @return [String]
106
+ #
107
+ def universe_domain
108
+ @sql_ssl_certs_service_stub.universe_domain
109
+ end
110
+
111
+ ##
112
+ # Create a new SqlSslCertsService REST client object.
113
+ #
114
+ # @example
115
+ #
116
+ # # Create a client using the default configuration
117
+ # client = ::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.new
118
+ #
119
+ # # Create a client using a custom configuration
120
+ # client = ::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.new do |config|
121
+ # config.timeout = 10.0
122
+ # end
123
+ #
124
+ # @yield [config] Configure the SqlSslCertsService client.
125
+ # @yieldparam config [Client::Configuration]
126
+ #
127
+ def initialize
128
+ # Create the configuration object
129
+ @config = Configuration.new Client.configure
130
+
131
+ # Yield the configuration if needed
132
+ yield @config if block_given?
133
+
134
+ # Create credentials
135
+ credentials = @config.credentials
136
+ # Use self-signed JWT if the endpoint is unchanged from default,
137
+ # but only if the default endpoint does not have a region prefix.
138
+ enable_self_signed_jwt = @config.endpoint.nil? ||
139
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
+ !@config.endpoint.split(".").first.include?("-"))
141
+ credentials ||= Credentials.default scope: @config.scope,
142
+ enable_self_signed_jwt: enable_self_signed_jwt
143
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
144
+ credentials = Credentials.new credentials, scope: @config.scope
145
+ end
146
+
147
+ @quota_project_id = @config.quota_project
148
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
149
+
150
+ @sql_ssl_certs_service_stub = ::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::ServiceStub.new(
151
+ endpoint: @config.endpoint,
152
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
153
+ universe_domain: @config.universe_domain,
154
+ credentials: credentials,
155
+ logger: @config.logger
156
+ )
157
+
158
+ @sql_ssl_certs_service_stub.logger(stub: true)&.info do |entry|
159
+ entry.set_system_name
160
+ entry.set_service
161
+ entry.message = "Created client for #{entry.service}"
162
+ entry.set_credentials_fields credentials
163
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
164
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
165
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
166
+ end
167
+
168
+ @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
169
+ config.credentials = credentials
170
+ config.quota_project = @quota_project_id
171
+ config.endpoint = @sql_ssl_certs_service_stub.endpoint
172
+ config.universe_domain = @sql_ssl_certs_service_stub.universe_domain
173
+ config.logger = @sql_ssl_certs_service_stub.logger if config.respond_to? :logger=
174
+ end
175
+ end
176
+
177
+ ##
178
+ # Get the associated client for mix-in of the Locations.
179
+ #
180
+ # @return [Google::Cloud::Location::Locations::Rest::Client]
181
+ #
182
+ attr_reader :location_client
183
+
184
+ ##
185
+ # The logger used for request/response debug logging.
186
+ #
187
+ # @return [Logger]
188
+ #
189
+ def logger
190
+ @sql_ssl_certs_service_stub.logger
191
+ end
192
+
193
+ # Service calls
194
+
195
+ ##
196
+ # Deletes the SSL certificate. For First Generation instances, the
197
+ # certificate remains valid until the instance is restarted.
198
+ #
199
+ # @overload delete(request, options = nil)
200
+ # Pass arguments to `delete` via a request object, either of type
201
+ # {::Google::Cloud::Sql::V1::SqlSslCertsDeleteRequest} or an equivalent Hash.
202
+ #
203
+ # @param request [::Google::Cloud::Sql::V1::SqlSslCertsDeleteRequest, ::Hash]
204
+ # A request object representing the call parameters. Required. To specify no
205
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
206
+ # @param options [::Gapic::CallOptions, ::Hash]
207
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
208
+ #
209
+ # @overload delete(instance: nil, project: nil, sha1_fingerprint: nil)
210
+ # Pass arguments to `delete` via keyword arguments. Note that at
211
+ # least one keyword argument is required. To specify no parameters, or to keep all
212
+ # the default parameter values, pass an empty Hash as a request object (see above).
213
+ #
214
+ # @param instance [::String]
215
+ # Cloud SQL instance ID. This does not include the project ID.
216
+ # @param project [::String]
217
+ # Project ID of the project that contains the instance.
218
+ # @param sha1_fingerprint [::String]
219
+ # Sha1 FingerPrint.
220
+ # @yield [result, operation] Access the result along with the TransportOperation object
221
+ # @yieldparam result [::Google::Cloud::Sql::V1::Operation]
222
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
223
+ #
224
+ # @return [::Google::Cloud::Sql::V1::Operation]
225
+ #
226
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
227
+ #
228
+ # @example Basic example
229
+ # require "google/cloud/sql/v1"
230
+ #
231
+ # # Create a client object. The client can be reused for multiple calls.
232
+ # client = Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.new
233
+ #
234
+ # # Create a request. To set request fields, pass in keyword arguments.
235
+ # request = Google::Cloud::Sql::V1::SqlSslCertsDeleteRequest.new
236
+ #
237
+ # # Call the delete method.
238
+ # result = client.delete request
239
+ #
240
+ # # The returned object is of type Google::Cloud::Sql::V1::Operation.
241
+ # p result
242
+ #
243
+ def delete request, options = nil
244
+ raise ::ArgumentError, "request must be provided" if request.nil?
245
+
246
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1::SqlSslCertsDeleteRequest
247
+
248
+ # Converts hash and nil to an options object
249
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
250
+
251
+ # Customize the options with defaults
252
+ call_metadata = @config.rpcs.delete.metadata.to_h
253
+
254
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
255
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
256
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
257
+ gapic_version: ::Google::Cloud::Sql::V1::VERSION,
258
+ transports_version_send: [:rest]
259
+
260
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
261
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
262
+
263
+ options.apply_defaults timeout: @config.rpcs.delete.timeout,
264
+ metadata: call_metadata,
265
+ retry_policy: @config.rpcs.delete.retry_policy
266
+
267
+ options.apply_defaults timeout: @config.timeout,
268
+ metadata: @config.metadata,
269
+ retry_policy: @config.retry_policy
270
+
271
+ @sql_ssl_certs_service_stub.delete request, options do |result, operation|
272
+ yield result, operation if block_given?
273
+ end
274
+ rescue ::Gapic::Rest::Error => e
275
+ raise ::Google::Cloud::Error.from_error(e)
276
+ end
277
+
278
+ ##
279
+ # Retrieves a particular SSL certificate. Does not include the private key
280
+ # (required for usage). The private key must be saved from the response to
281
+ # initial creation.
282
+ #
283
+ # @overload get(request, options = nil)
284
+ # Pass arguments to `get` via a request object, either of type
285
+ # {::Google::Cloud::Sql::V1::SqlSslCertsGetRequest} or an equivalent Hash.
286
+ #
287
+ # @param request [::Google::Cloud::Sql::V1::SqlSslCertsGetRequest, ::Hash]
288
+ # A request object representing the call parameters. Required. To specify no
289
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
290
+ # @param options [::Gapic::CallOptions, ::Hash]
291
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
292
+ #
293
+ # @overload get(instance: nil, project: nil, sha1_fingerprint: nil)
294
+ # Pass arguments to `get` via keyword arguments. Note that at
295
+ # least one keyword argument is required. To specify no parameters, or to keep all
296
+ # the default parameter values, pass an empty Hash as a request object (see above).
297
+ #
298
+ # @param instance [::String]
299
+ # Cloud SQL instance ID. This does not include the project ID.
300
+ # @param project [::String]
301
+ # Project ID of the project that contains the instance.
302
+ # @param sha1_fingerprint [::String]
303
+ # Sha1 FingerPrint.
304
+ # @yield [result, operation] Access the result along with the TransportOperation object
305
+ # @yieldparam result [::Google::Cloud::Sql::V1::SslCert]
306
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
307
+ #
308
+ # @return [::Google::Cloud::Sql::V1::SslCert]
309
+ #
310
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
311
+ #
312
+ # @example Basic example
313
+ # require "google/cloud/sql/v1"
314
+ #
315
+ # # Create a client object. The client can be reused for multiple calls.
316
+ # client = Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.new
317
+ #
318
+ # # Create a request. To set request fields, pass in keyword arguments.
319
+ # request = Google::Cloud::Sql::V1::SqlSslCertsGetRequest.new
320
+ #
321
+ # # Call the get method.
322
+ # result = client.get request
323
+ #
324
+ # # The returned object is of type Google::Cloud::Sql::V1::SslCert.
325
+ # p result
326
+ #
327
+ def get request, options = nil
328
+ raise ::ArgumentError, "request must be provided" if request.nil?
329
+
330
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1::SqlSslCertsGetRequest
331
+
332
+ # Converts hash and nil to an options object
333
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
334
+
335
+ # Customize the options with defaults
336
+ call_metadata = @config.rpcs.get.metadata.to_h
337
+
338
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
339
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
340
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
341
+ gapic_version: ::Google::Cloud::Sql::V1::VERSION,
342
+ transports_version_send: [:rest]
343
+
344
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
345
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
346
+
347
+ options.apply_defaults timeout: @config.rpcs.get.timeout,
348
+ metadata: call_metadata,
349
+ retry_policy: @config.rpcs.get.retry_policy
350
+
351
+ options.apply_defaults timeout: @config.timeout,
352
+ metadata: @config.metadata,
353
+ retry_policy: @config.retry_policy
354
+
355
+ @sql_ssl_certs_service_stub.get request, options do |result, operation|
356
+ yield result, operation if block_given?
357
+ end
358
+ rescue ::Gapic::Rest::Error => e
359
+ raise ::Google::Cloud::Error.from_error(e)
360
+ end
361
+
362
+ ##
363
+ # Creates an SSL certificate and returns it along with the private key and
364
+ # server certificate authority. The new certificate will not be usable until
365
+ # the instance is restarted.
366
+ #
367
+ # @overload insert(request, options = nil)
368
+ # Pass arguments to `insert` via a request object, either of type
369
+ # {::Google::Cloud::Sql::V1::SqlSslCertsInsertRequest} or an equivalent Hash.
370
+ #
371
+ # @param request [::Google::Cloud::Sql::V1::SqlSslCertsInsertRequest, ::Hash]
372
+ # A request object representing the call parameters. Required. To specify no
373
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
374
+ # @param options [::Gapic::CallOptions, ::Hash]
375
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
376
+ #
377
+ # @overload insert(instance: nil, project: nil, body: nil)
378
+ # Pass arguments to `insert` via keyword arguments. Note that at
379
+ # least one keyword argument is required. To specify no parameters, or to keep all
380
+ # the default parameter values, pass an empty Hash as a request object (see above).
381
+ #
382
+ # @param instance [::String]
383
+ # Cloud SQL instance ID. This does not include the project ID.
384
+ # @param project [::String]
385
+ # Project ID of the project that contains the instance.
386
+ # @param body [::Google::Cloud::Sql::V1::SslCertsInsertRequest, ::Hash]
387
+ # @yield [result, operation] Access the result along with the TransportOperation object
388
+ # @yieldparam result [::Google::Cloud::Sql::V1::SslCertsInsertResponse]
389
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
390
+ #
391
+ # @return [::Google::Cloud::Sql::V1::SslCertsInsertResponse]
392
+ #
393
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
394
+ #
395
+ # @example Basic example
396
+ # require "google/cloud/sql/v1"
397
+ #
398
+ # # Create a client object. The client can be reused for multiple calls.
399
+ # client = Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.new
400
+ #
401
+ # # Create a request. To set request fields, pass in keyword arguments.
402
+ # request = Google::Cloud::Sql::V1::SqlSslCertsInsertRequest.new
403
+ #
404
+ # # Call the insert method.
405
+ # result = client.insert request
406
+ #
407
+ # # The returned object is of type Google::Cloud::Sql::V1::SslCertsInsertResponse.
408
+ # p result
409
+ #
410
+ def insert request, options = nil
411
+ raise ::ArgumentError, "request must be provided" if request.nil?
412
+
413
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1::SqlSslCertsInsertRequest
414
+
415
+ # Converts hash and nil to an options object
416
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
417
+
418
+ # Customize the options with defaults
419
+ call_metadata = @config.rpcs.insert.metadata.to_h
420
+
421
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
422
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
423
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
424
+ gapic_version: ::Google::Cloud::Sql::V1::VERSION,
425
+ transports_version_send: [:rest]
426
+
427
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
428
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
429
+
430
+ options.apply_defaults timeout: @config.rpcs.insert.timeout,
431
+ metadata: call_metadata,
432
+ retry_policy: @config.rpcs.insert.retry_policy
433
+
434
+ options.apply_defaults timeout: @config.timeout,
435
+ metadata: @config.metadata,
436
+ retry_policy: @config.retry_policy
437
+
438
+ @sql_ssl_certs_service_stub.insert request, options do |result, operation|
439
+ yield result, operation if block_given?
440
+ end
441
+ rescue ::Gapic::Rest::Error => e
442
+ raise ::Google::Cloud::Error.from_error(e)
443
+ end
444
+
445
+ ##
446
+ # Lists all of the current SSL certificates for the instance.
447
+ #
448
+ # @overload list(request, options = nil)
449
+ # Pass arguments to `list` via a request object, either of type
450
+ # {::Google::Cloud::Sql::V1::SqlSslCertsListRequest} or an equivalent Hash.
451
+ #
452
+ # @param request [::Google::Cloud::Sql::V1::SqlSslCertsListRequest, ::Hash]
453
+ # A request object representing the call parameters. Required. To specify no
454
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
455
+ # @param options [::Gapic::CallOptions, ::Hash]
456
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
457
+ #
458
+ # @overload list(instance: nil, project: nil)
459
+ # Pass arguments to `list` via keyword arguments. Note that at
460
+ # least one keyword argument is required. To specify no parameters, or to keep all
461
+ # the default parameter values, pass an empty Hash as a request object (see above).
462
+ #
463
+ # @param instance [::String]
464
+ # Cloud SQL instance ID. This does not include the project ID.
465
+ # @param project [::String]
466
+ # Project ID of the project that contains the instance.
467
+ # @yield [result, operation] Access the result along with the TransportOperation object
468
+ # @yieldparam result [::Google::Cloud::Sql::V1::SslCertsListResponse]
469
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
470
+ #
471
+ # @return [::Google::Cloud::Sql::V1::SslCertsListResponse]
472
+ #
473
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
474
+ #
475
+ # @example Basic example
476
+ # require "google/cloud/sql/v1"
477
+ #
478
+ # # Create a client object. The client can be reused for multiple calls.
479
+ # client = Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.new
480
+ #
481
+ # # Create a request. To set request fields, pass in keyword arguments.
482
+ # request = Google::Cloud::Sql::V1::SqlSslCertsListRequest.new
483
+ #
484
+ # # Call the list method.
485
+ # result = client.list request
486
+ #
487
+ # # The returned object is of type Google::Cloud::Sql::V1::SslCertsListResponse.
488
+ # p result
489
+ #
490
+ def list request, options = nil
491
+ raise ::ArgumentError, "request must be provided" if request.nil?
492
+
493
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1::SqlSslCertsListRequest
494
+
495
+ # Converts hash and nil to an options object
496
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
497
+
498
+ # Customize the options with defaults
499
+ call_metadata = @config.rpcs.list.metadata.to_h
500
+
501
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
502
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
503
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
504
+ gapic_version: ::Google::Cloud::Sql::V1::VERSION,
505
+ transports_version_send: [:rest]
506
+
507
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
508
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
509
+
510
+ options.apply_defaults timeout: @config.rpcs.list.timeout,
511
+ metadata: call_metadata,
512
+ retry_policy: @config.rpcs.list.retry_policy
513
+
514
+ options.apply_defaults timeout: @config.timeout,
515
+ metadata: @config.metadata,
516
+ retry_policy: @config.retry_policy
517
+
518
+ @sql_ssl_certs_service_stub.list request, options do |result, operation|
519
+ yield result, operation if block_given?
520
+ end
521
+ rescue ::Gapic::Rest::Error => e
522
+ raise ::Google::Cloud::Error.from_error(e)
523
+ end
524
+
525
+ ##
526
+ # Configuration class for the SqlSslCertsService REST API.
527
+ #
528
+ # This class represents the configuration for SqlSslCertsService REST,
529
+ # providing control over timeouts, retry behavior, logging, transport
530
+ # parameters, and other low-level controls. Certain parameters can also be
531
+ # applied individually to specific RPCs. See
532
+ # {::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client::Configuration::Rpcs}
533
+ # for a list of RPCs that can be configured independently.
534
+ #
535
+ # Configuration can be applied globally to all clients, or to a single client
536
+ # on construction.
537
+ #
538
+ # @example
539
+ #
540
+ # # Modify the global config, setting the timeout for
541
+ # # delete to 20 seconds,
542
+ # # and all remaining timeouts to 10 seconds.
543
+ # ::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.configure do |config|
544
+ # config.timeout = 10.0
545
+ # config.rpcs.delete.timeout = 20.0
546
+ # end
547
+ #
548
+ # # Apply the above configuration only to a new client.
549
+ # client = ::Google::Cloud::Sql::V1::SqlSslCertsService::Rest::Client.new do |config|
550
+ # config.timeout = 10.0
551
+ # config.rpcs.delete.timeout = 20.0
552
+ # end
553
+ #
554
+ # @!attribute [rw] endpoint
555
+ # A custom service endpoint, as a hostname or hostname:port. The default is
556
+ # nil, indicating to use the default endpoint in the current universe domain.
557
+ # @return [::String,nil]
558
+ # @!attribute [rw] credentials
559
+ # Credentials to send with calls. You may provide any of the following types:
560
+ # * (`String`) The path to a service account key file in JSON format
561
+ # * (`Hash`) A service account key as a Hash
562
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
563
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
564
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
565
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
566
+ # * (`nil`) indicating no credentials
567
+ #
568
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
569
+ # external source for authentication to Google Cloud, you must validate it before
570
+ # providing it to a Google API client library. Providing an unvalidated credential
571
+ # configuration to Google APIs can compromise the security of your systems and data.
572
+ # For more information, refer to [Validate credential configurations from external
573
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
574
+ # @return [::Object]
575
+ # @!attribute [rw] scope
576
+ # The OAuth scopes
577
+ # @return [::Array<::String>]
578
+ # @!attribute [rw] lib_name
579
+ # The library name as recorded in instrumentation and logging
580
+ # @return [::String]
581
+ # @!attribute [rw] lib_version
582
+ # The library version as recorded in instrumentation and logging
583
+ # @return [::String]
584
+ # @!attribute [rw] timeout
585
+ # The call timeout in seconds.
586
+ # @return [::Numeric]
587
+ # @!attribute [rw] metadata
588
+ # Additional headers to be sent with the call.
589
+ # @return [::Hash{::Symbol=>::String}]
590
+ # @!attribute [rw] retry_policy
591
+ # The retry policy. The value is a hash with the following keys:
592
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
593
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
594
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
595
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
596
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
597
+ # trigger a retry.
598
+ # @return [::Hash]
599
+ # @!attribute [rw] quota_project
600
+ # A separate project against which to charge quota.
601
+ # @return [::String]
602
+ # @!attribute [rw] universe_domain
603
+ # The universe domain within which to make requests. This determines the
604
+ # default endpoint URL. The default value of nil uses the environment
605
+ # universe (usually the default "googleapis.com" universe).
606
+ # @return [::String,nil]
607
+ # @!attribute [rw] logger
608
+ # A custom logger to use for request/response debug logging, or the value
609
+ # `:default` (the default) to construct a default logger, or `nil` to
610
+ # explicitly disable logging.
611
+ # @return [::Logger,:default,nil]
612
+ #
613
+ class Configuration
614
+ extend ::Gapic::Config
615
+
616
+ # @private
617
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
618
+ DEFAULT_ENDPOINT = "sqladmin.googleapis.com"
619
+
620
+ config_attr :endpoint, nil, ::String, nil
621
+ config_attr :credentials, nil do |value|
622
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
623
+ allowed.any? { |klass| klass === value }
624
+ end
625
+ config_attr :scope, nil, ::String, ::Array, nil
626
+ config_attr :lib_name, nil, ::String, nil
627
+ config_attr :lib_version, nil, ::String, nil
628
+ config_attr :timeout, nil, ::Numeric, nil
629
+ config_attr :metadata, nil, ::Hash, nil
630
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
631
+ config_attr :quota_project, nil, ::String, nil
632
+ config_attr :universe_domain, nil, ::String, nil
633
+ config_attr :logger, :default, ::Logger, nil, :default
634
+
635
+ # @private
636
+ def initialize parent_config = nil
637
+ @parent_config = parent_config unless parent_config.nil?
638
+
639
+ yield self if block_given?
640
+ end
641
+
642
+ ##
643
+ # Configurations for individual RPCs
644
+ # @return [Rpcs]
645
+ #
646
+ def rpcs
647
+ @rpcs ||= begin
648
+ parent_rpcs = nil
649
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
650
+ Rpcs.new parent_rpcs
651
+ end
652
+ end
653
+
654
+ ##
655
+ # Configuration RPC class for the SqlSslCertsService API.
656
+ #
657
+ # Includes fields providing the configuration for each RPC in this service.
658
+ # Each configuration object is of type `Gapic::Config::Method` and includes
659
+ # the following configuration fields:
660
+ #
661
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
662
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
663
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
664
+ # include the following keys:
665
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
666
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
667
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
668
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
669
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
670
+ # trigger a retry.
671
+ #
672
+ class Rpcs
673
+ ##
674
+ # RPC-specific configuration for `delete`
675
+ # @return [::Gapic::Config::Method]
676
+ #
677
+ attr_reader :delete
678
+ ##
679
+ # RPC-specific configuration for `get`
680
+ # @return [::Gapic::Config::Method]
681
+ #
682
+ attr_reader :get
683
+ ##
684
+ # RPC-specific configuration for `insert`
685
+ # @return [::Gapic::Config::Method]
686
+ #
687
+ attr_reader :insert
688
+ ##
689
+ # RPC-specific configuration for `list`
690
+ # @return [::Gapic::Config::Method]
691
+ #
692
+ attr_reader :list
693
+
694
+ # @private
695
+ def initialize parent_rpcs = nil
696
+ delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
697
+ @delete = ::Gapic::Config::Method.new delete_config
698
+ get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
699
+ @get = ::Gapic::Config::Method.new get_config
700
+ insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
701
+ @insert = ::Gapic::Config::Method.new insert_config
702
+ list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
703
+ @list = ::Gapic::Config::Method.new list_config
704
+
705
+ yield self if block_given?
706
+ end
707
+ end
708
+ end
709
+ end
710
+ end
711
+ end
712
+ end
713
+ end
714
+ end
715
+ end