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