google-apis-redis_v1beta1 0.54.0 → 0.56.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.
@@ -124,6 +124,273 @@ module Google
124
124
  execute_or_queue_command(command, &block)
125
125
  end
126
126
 
127
+ # Get a backup collection.
128
+ # @param [String] name
129
+ # Required. Redis backupCollection resource name using the form: `projects/`
130
+ # project_id`/locations/`location_id`/backupCollections/`backup_collection_id``
131
+ # where `location_id` refers to a GCP region.
132
+ # @param [String] fields
133
+ # Selector specifying which fields to include in a partial response.
134
+ # @param [String] quota_user
135
+ # Available to use for quota purposes for server-side applications. Can be any
136
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
137
+ # @param [Google::Apis::RequestOptions] options
138
+ # Request-specific options
139
+ #
140
+ # @yield [result, err] Result & error if block supplied
141
+ # @yieldparam result [Google::Apis::RedisV1beta1::BackupCollection] parsed result object
142
+ # @yieldparam err [StandardError] error object if request failed
143
+ #
144
+ # @return [Google::Apis::RedisV1beta1::BackupCollection]
145
+ #
146
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
147
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
148
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
149
+ def get_project_location_backup_collection(name, fields: nil, quota_user: nil, options: nil, &block)
150
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
151
+ command.response_representation = Google::Apis::RedisV1beta1::BackupCollection::Representation
152
+ command.response_class = Google::Apis::RedisV1beta1::BackupCollection
153
+ command.params['name'] = name unless name.nil?
154
+ command.query['fields'] = fields unless fields.nil?
155
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
156
+ execute_or_queue_command(command, &block)
157
+ end
158
+
159
+ # Lists all backup collections owned by a consumer project in either the
160
+ # specified location (region) or all locations. If `location_id` is specified as
161
+ # `-` (wildcard), then all regions available to the project are queried, and the
162
+ # results are aggregated.
163
+ # @param [String] parent
164
+ # Required. The resource name of the backupCollection location using the form: `
165
+ # projects/`project_id`/locations/`location_id`` where `location_id` refers to a
166
+ # GCP region.
167
+ # @param [Fixnum] page_size
168
+ # Optional. The maximum number of items to return. If not specified, a default
169
+ # value of 1000 will be used by the service. Regardless of the page_size value,
170
+ # the response may include a partial list and a caller should only rely on
171
+ # response's `next_page_token` to determine if there are more clusters left to
172
+ # be queried.
173
+ # @param [String] page_token
174
+ # Optional. The `next_page_token` value returned from a previous [
175
+ # ListBackupCollections] request, if any.
176
+ # @param [String] fields
177
+ # Selector specifying which fields to include in a partial response.
178
+ # @param [String] quota_user
179
+ # Available to use for quota purposes for server-side applications. Can be any
180
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
181
+ # @param [Google::Apis::RequestOptions] options
182
+ # Request-specific options
183
+ #
184
+ # @yield [result, err] Result & error if block supplied
185
+ # @yieldparam result [Google::Apis::RedisV1beta1::ListBackupCollectionsResponse] parsed result object
186
+ # @yieldparam err [StandardError] error object if request failed
187
+ #
188
+ # @return [Google::Apis::RedisV1beta1::ListBackupCollectionsResponse]
189
+ #
190
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
191
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
192
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
193
+ def list_project_location_backup_collections(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
194
+ command = make_simple_command(:get, 'v1beta1/{+parent}/backupCollections', options)
195
+ command.response_representation = Google::Apis::RedisV1beta1::ListBackupCollectionsResponse::Representation
196
+ command.response_class = Google::Apis::RedisV1beta1::ListBackupCollectionsResponse
197
+ command.params['parent'] = parent unless parent.nil?
198
+ command.query['pageSize'] = page_size unless page_size.nil?
199
+ command.query['pageToken'] = page_token unless page_token.nil?
200
+ command.query['fields'] = fields unless fields.nil?
201
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
202
+ execute_or_queue_command(command, &block)
203
+ end
204
+
205
+ # Deletes a specific backup.
206
+ # @param [String] name
207
+ # Required. Redis backup resource name using the form: `projects/`project_id`/
208
+ # locations/`location_id`/backupCollections/`backup_collection_id`/backups/`
209
+ # backup_id``
210
+ # @param [String] request_id
211
+ # Optional. Idempotent request UUID.
212
+ # @param [String] fields
213
+ # Selector specifying which fields to include in a partial response.
214
+ # @param [String] quota_user
215
+ # Available to use for quota purposes for server-side applications. Can be any
216
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
217
+ # @param [Google::Apis::RequestOptions] options
218
+ # Request-specific options
219
+ #
220
+ # @yield [result, err] Result & error if block supplied
221
+ # @yieldparam result [Google::Apis::RedisV1beta1::Operation] parsed result object
222
+ # @yieldparam err [StandardError] error object if request failed
223
+ #
224
+ # @return [Google::Apis::RedisV1beta1::Operation]
225
+ #
226
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
227
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
228
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
229
+ def delete_project_location_backup_collection_backup(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
230
+ command = make_simple_command(:delete, 'v1beta1/{+name}', options)
231
+ command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
232
+ command.response_class = Google::Apis::RedisV1beta1::Operation
233
+ command.params['name'] = name unless name.nil?
234
+ command.query['requestId'] = request_id unless request_id.nil?
235
+ command.query['fields'] = fields unless fields.nil?
236
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
237
+ execute_or_queue_command(command, &block)
238
+ end
239
+
240
+ # Exports a specific backup to a customer target Cloud Storage URI.
241
+ # @param [String] name
242
+ # Required. Redis backup resource name using the form: `projects/`project_id`/
243
+ # locations/`location_id`/backupCollections/`backup_collection_id`/backups/`
244
+ # backup_id``
245
+ # @param [Google::Apis::RedisV1beta1::ExportBackupRequest] export_backup_request_object
246
+ # @param [String] fields
247
+ # Selector specifying which fields to include in a partial response.
248
+ # @param [String] quota_user
249
+ # Available to use for quota purposes for server-side applications. Can be any
250
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
251
+ # @param [Google::Apis::RequestOptions] options
252
+ # Request-specific options
253
+ #
254
+ # @yield [result, err] Result & error if block supplied
255
+ # @yieldparam result [Google::Apis::RedisV1beta1::Operation] parsed result object
256
+ # @yieldparam err [StandardError] error object if request failed
257
+ #
258
+ # @return [Google::Apis::RedisV1beta1::Operation]
259
+ #
260
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
261
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
262
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
263
+ def export_backup(name, export_backup_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
264
+ command = make_simple_command(:post, 'v1beta1/{+name}:export', options)
265
+ command.request_representation = Google::Apis::RedisV1beta1::ExportBackupRequest::Representation
266
+ command.request_object = export_backup_request_object
267
+ command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
268
+ command.response_class = Google::Apis::RedisV1beta1::Operation
269
+ command.params['name'] = name unless name.nil?
270
+ command.query['fields'] = fields unless fields.nil?
271
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
272
+ execute_or_queue_command(command, &block)
273
+ end
274
+
275
+ # Gets the details of a specific backup.
276
+ # @param [String] name
277
+ # Required. Redis backup resource name using the form: `projects/`project_id`/
278
+ # locations/`location_id`/backupCollections/`backup_collection_id`/backups/`
279
+ # backup_id``
280
+ # @param [String] fields
281
+ # Selector specifying which fields to include in a partial response.
282
+ # @param [String] quota_user
283
+ # Available to use for quota purposes for server-side applications. Can be any
284
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
285
+ # @param [Google::Apis::RequestOptions] options
286
+ # Request-specific options
287
+ #
288
+ # @yield [result, err] Result & error if block supplied
289
+ # @yieldparam result [Google::Apis::RedisV1beta1::Backup] parsed result object
290
+ # @yieldparam err [StandardError] error object if request failed
291
+ #
292
+ # @return [Google::Apis::RedisV1beta1::Backup]
293
+ #
294
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
295
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
296
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
297
+ def get_project_location_backup_collection_backup(name, fields: nil, quota_user: nil, options: nil, &block)
298
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
299
+ command.response_representation = Google::Apis::RedisV1beta1::Backup::Representation
300
+ command.response_class = Google::Apis::RedisV1beta1::Backup
301
+ command.params['name'] = name unless name.nil?
302
+ command.query['fields'] = fields unless fields.nil?
303
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
304
+ execute_or_queue_command(command, &block)
305
+ end
306
+
307
+ # Lists all backups owned by a backup collection.
308
+ # @param [String] parent
309
+ # Required. The resource name of the backupCollection using the form: `projects/`
310
+ # project_id`/locations/`location_id`/backupCollections/`backup_collection_id``
311
+ # @param [Fixnum] page_size
312
+ # Optional. The maximum number of items to return. If not specified, a default
313
+ # value of 1000 will be used by the service. Regardless of the page_size value,
314
+ # the response may include a partial list and a caller should only rely on
315
+ # response's `next_page_token` to determine if there are more clusters left to
316
+ # be queried.
317
+ # @param [String] page_token
318
+ # Optional. The `next_page_token` value returned from a previous [
319
+ # ListBackupCollections] request, if any.
320
+ # @param [String] fields
321
+ # Selector specifying which fields to include in a partial response.
322
+ # @param [String] quota_user
323
+ # Available to use for quota purposes for server-side applications. Can be any
324
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
325
+ # @param [Google::Apis::RequestOptions] options
326
+ # Request-specific options
327
+ #
328
+ # @yield [result, err] Result & error if block supplied
329
+ # @yieldparam result [Google::Apis::RedisV1beta1::ListBackupsResponse] parsed result object
330
+ # @yieldparam err [StandardError] error object if request failed
331
+ #
332
+ # @return [Google::Apis::RedisV1beta1::ListBackupsResponse]
333
+ #
334
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
335
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
336
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
337
+ def list_project_location_backup_collection_backups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
338
+ command = make_simple_command(:get, 'v1beta1/{+parent}/backups', options)
339
+ command.response_representation = Google::Apis::RedisV1beta1::ListBackupsResponse::Representation
340
+ command.response_class = Google::Apis::RedisV1beta1::ListBackupsResponse
341
+ command.params['parent'] = parent unless parent.nil?
342
+ command.query['pageSize'] = page_size unless page_size.nil?
343
+ command.query['pageToken'] = page_token unless page_token.nil?
344
+ command.query['fields'] = fields unless fields.nil?
345
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
346
+ execute_or_queue_command(command, &block)
347
+ end
348
+
349
+ # Backup Redis Cluster. If this is the first time a backup is being created, a
350
+ # backup collection will be created at the backend, and this backup belongs to
351
+ # this collection. Both collection and backup will have a resource name. Backup
352
+ # will be executed for each shard. A replica (primary if nonHA) will be selected
353
+ # to perform the execution. Backup call will be rejected if there is an ongoing
354
+ # backup or update operation. Be aware that during preview, if the cluster's
355
+ # internal software version is too old, critical update will be performed before
356
+ # actual backup. Once the internal software version is updated to the minimum
357
+ # version required by the backup feature, subsequent backups will not require
358
+ # critical update. After preview, there will be no critical update needed for
359
+ # backup.
360
+ # @param [String] name
361
+ # Required. Redis cluster resource name using the form: `projects/`project_id`/
362
+ # locations/`location_id`/clusters/`cluster_id`` where `location_id` refers to a
363
+ # GCP region.
364
+ # @param [Google::Apis::RedisV1beta1::BackupClusterRequest] backup_cluster_request_object
365
+ # @param [String] fields
366
+ # Selector specifying which fields to include in a partial response.
367
+ # @param [String] quota_user
368
+ # Available to use for quota purposes for server-side applications. Can be any
369
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
370
+ # @param [Google::Apis::RequestOptions] options
371
+ # Request-specific options
372
+ #
373
+ # @yield [result, err] Result & error if block supplied
374
+ # @yieldparam result [Google::Apis::RedisV1beta1::Operation] parsed result object
375
+ # @yieldparam err [StandardError] error object if request failed
376
+ #
377
+ # @return [Google::Apis::RedisV1beta1::Operation]
378
+ #
379
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
380
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
381
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
382
+ def backup_cluster(name, backup_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
383
+ command = make_simple_command(:post, 'v1beta1/{+name}:backup', options)
384
+ command.request_representation = Google::Apis::RedisV1beta1::BackupClusterRequest::Representation
385
+ command.request_object = backup_cluster_request_object
386
+ command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
387
+ command.response_class = Google::Apis::RedisV1beta1::Operation
388
+ command.params['name'] = name unless name.nil?
389
+ command.query['fields'] = fields unless fields.nil?
390
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
391
+ execute_or_queue_command(command, &block)
392
+ end
393
+
127
394
  # Creates a Redis cluster based on the specified properties. The creation is
128
395
  # executed asynchronously and callers may check the returned operation to track
129
396
  # its progress. Once the operation is completed the Redis cluster will be fully
@@ -365,6 +632,41 @@ module Google
365
632
  execute_or_queue_command(command, &block)
366
633
  end
367
634
 
635
+ # Reschedules upcoming maintenance event.
636
+ # @param [String] name
637
+ # Required. Redis Cluster instance resource name using the form: `projects/`
638
+ # project_id`/locations/`location_id`/clusters/`cluster_id`` where `location_id`
639
+ # refers to a GCP region.
640
+ # @param [Google::Apis::RedisV1beta1::RescheduleClusterMaintenanceRequest] reschedule_cluster_maintenance_request_object
641
+ # @param [String] fields
642
+ # Selector specifying which fields to include in a partial response.
643
+ # @param [String] quota_user
644
+ # Available to use for quota purposes for server-side applications. Can be any
645
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
646
+ # @param [Google::Apis::RequestOptions] options
647
+ # Request-specific options
648
+ #
649
+ # @yield [result, err] Result & error if block supplied
650
+ # @yieldparam result [Google::Apis::RedisV1beta1::Operation] parsed result object
651
+ # @yieldparam err [StandardError] error object if request failed
652
+ #
653
+ # @return [Google::Apis::RedisV1beta1::Operation]
654
+ #
655
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
656
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
657
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
658
+ def reschedule_cluster_maintenance(name, reschedule_cluster_maintenance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
659
+ command = make_simple_command(:post, 'v1beta1/{+name}:rescheduleClusterMaintenance', options)
660
+ command.request_representation = Google::Apis::RedisV1beta1::RescheduleClusterMaintenanceRequest::Representation
661
+ command.request_object = reschedule_cluster_maintenance_request_object
662
+ command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
663
+ command.response_class = Google::Apis::RedisV1beta1::Operation
664
+ command.params['name'] = name unless name.nil?
665
+ command.query['fields'] = fields unless fields.nil?
666
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
667
+ execute_or_queue_command(command, &block)
668
+ end
669
+
368
670
  # Creates a Redis instance based on the specified tier and memory size. By
369
671
  # default, the instance is accessible from the project's [default network](https:
370
672
  # //cloud.google.com/vpc/docs/vpc). The creation is executed asynchronously and
@@ -796,8 +1098,8 @@ module Google
796
1098
  # Clients can use Operations.GetOperation or other methods to check whether the
797
1099
  # cancellation succeeded or whether the operation completed despite cancellation.
798
1100
  # On successful cancellation, the operation is not deleted; instead, it becomes
799
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
800
- # corresponding to `Code.CANCELLED`.
1101
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
1102
+ # , corresponding to `Code.CANCELLED`.
801
1103
  # @param [String] name
802
1104
  # The name of the operation resource to be cancelled.
803
1105
  # @param [String] fields
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-redis_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.54.0
4
+ version: 0.56.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-07-25 00:00:00.000000000 Z
11
+ date: 2024-12-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -59,7 +59,7 @@ licenses:
59
59
  metadata:
60
60
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
61
61
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-redis_v1beta1/CHANGELOG.md
62
- documentation_uri: https://googleapis.dev/ruby/google-apis-redis_v1beta1/v0.54.0
62
+ documentation_uri: https://googleapis.dev/ruby/google-apis-redis_v1beta1/v0.56.0
63
63
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-redis_v1beta1
64
64
  post_install_message:
65
65
  rdoc_options: []
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
76
76
  - !ruby/object:Gem::Version
77
77
  version: '0'
78
78
  requirements: []
79
- rubygems_version: 3.5.6
79
+ rubygems_version: 3.5.23
80
80
  signing_key:
81
81
  specification_version: 4
82
82
  summary: Simple REST client for Google Cloud Memorystore for Redis API V1beta1