google-cloud-storage 1.36.2 → 1.39.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -0
- data/OVERVIEW.md +30 -0
- data/lib/google/cloud/storage/bucket/lifecycle.rb +88 -10
- data/lib/google/cloud/storage/bucket.rb +14 -0
- data/lib/google/cloud/storage/file/signer_v2.rb +1 -1
- data/lib/google/cloud/storage/file/signer_v4.rb +1 -1
- data/lib/google/cloud/storage/project.rb +6 -4
- data/lib/google/cloud/storage/service.rb +164 -226
- data/lib/google/cloud/storage/version.rb +1 -1
- data/lib/google/cloud/storage.rb +43 -14
- data/lib/google-cloud-storage.rb +31 -5
- metadata +7 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a376f2dab9dec5118be28f8fa76c2684e0606aee749fa8387eb6672ba5fb8023
|
|
4
|
+
data.tar.gz: 1dc9bcc3f0c2cee2ee822211ea8a67f740fdd30f827715da6a8e50b98a64b21b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 26b8b0c1544f7e0b1d20b82e539ddaf9431caeb359b177f637f3642eccb58b089b4a9e6202b3c9f051d6c75b01b31cba4b53870b9bf3e190934c0b2d3767e302
|
|
7
|
+
data.tar.gz: 7d1b0bcfc59f1ad50831489bf2c6f1740ddae969869e221eb809be0b9107f66170f14cb9ed16d50b6d73d76621e59c6b2f5bbb8018725b2d50643fa665645177
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# Release History
|
|
2
2
|
|
|
3
|
+
### 1.39.0 (2022-08-24)
|
|
4
|
+
|
|
5
|
+
#### Features
|
|
6
|
+
|
|
7
|
+
* add support for conditional idempotent operations ([#18834](https://github.com/googleapis/google-cloud-ruby/issues/18834))
|
|
8
|
+
|
|
9
|
+
### 1.38.0 (2022-07-31)
|
|
10
|
+
|
|
11
|
+
#### Features
|
|
12
|
+
|
|
13
|
+
* Add support for dual region gcs buckets ([#18862](https://github.com/googleapis/google-cloud-ruby/issues/18862))
|
|
14
|
+
|
|
15
|
+
### 1.37.0 (2022-06-30)
|
|
16
|
+
|
|
17
|
+
#### Features
|
|
18
|
+
|
|
19
|
+
* support OLM Prefix/Suffix ([#18190](https://github.com/googleapis/google-cloud-ruby/issues/18190))
|
|
20
|
+
* allow retry options to be configurable on client initialization ([#18332](https://github.com/googleapis/google-cloud-ruby/issues/18332))
|
|
21
|
+
#### Bug Fixes
|
|
22
|
+
|
|
23
|
+
* update object path parsing to handle hashes in them
|
|
24
|
+
|
|
3
25
|
### 1.36.2 (2022-04-20)
|
|
4
26
|
|
|
5
27
|
#### Documentation
|
data/OVERVIEW.md
CHANGED
|
@@ -563,6 +563,36 @@ require "google/cloud/storage"
|
|
|
563
563
|
storage = Google::Cloud::Storage.new retries: 10, timeout: 120
|
|
564
564
|
```
|
|
565
565
|
|
|
566
|
+
The library by default retries all API requests which are always idempotent on a
|
|
567
|
+
"transient" error.
|
|
568
|
+
|
|
569
|
+
For API requests which are idempotent only if the some conditions are satisfied
|
|
570
|
+
(For ex. a file has the same "generation"), the library retries only if the
|
|
571
|
+
condition is specified.
|
|
572
|
+
|
|
573
|
+
Rather than using this default behaviour, you may choose to disable the retries
|
|
574
|
+
on your own.
|
|
575
|
+
|
|
576
|
+
You can pass `retries` as `0` to disable retries for all operations regardless
|
|
577
|
+
of their idempotencies.
|
|
578
|
+
|
|
579
|
+
```ruby
|
|
580
|
+
require "google/cloud/storage"
|
|
581
|
+
|
|
582
|
+
storage = Google::Cloud::Storage.new retries: 0
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
You can also disable retries for a particular operation by passing `retries` as
|
|
586
|
+
`0` in the `options` field.
|
|
587
|
+
|
|
588
|
+
```ruby
|
|
589
|
+
require "google/cloud/storage"
|
|
590
|
+
|
|
591
|
+
storage = Google::Cloud::Storage.new
|
|
592
|
+
service = storage.service
|
|
593
|
+
service.get_bucket bucket_name, options: {retries: 0}
|
|
594
|
+
```
|
|
595
|
+
|
|
566
596
|
See the [Storage status and error
|
|
567
597
|
codes](https://cloud.google.com/storage/docs/json_api/v1/status-codes)
|
|
568
598
|
for a list of error conditions.
|
|
@@ -53,6 +53,8 @@ module Google
|
|
|
53
53
|
# rule.storage_class #=> "COLDLINE"
|
|
54
54
|
# rule.age #=> 10
|
|
55
55
|
# rule.matches_storage_class #=> ["STANDARD", "NEARLINE"]
|
|
56
|
+
# rule.matches_prefix #=> ["myprefix/foo"]
|
|
57
|
+
# rule.matches_suffix #=> [".jpg", ".png"]
|
|
56
58
|
#
|
|
57
59
|
# @example Updating the bucket's lifecycle management rules in a block.
|
|
58
60
|
# require "google/cloud/storage"
|
|
@@ -138,6 +140,12 @@ module Google
|
|
|
138
140
|
# files. If the value is N, this condition is satisfied when there
|
|
139
141
|
# are at least N versions (including the live version) newer than
|
|
140
142
|
# this version of the file.
|
|
143
|
+
# @param [Array<String,Symbol>] matches_prefix
|
|
144
|
+
# Files having their name with the specified list of prefixs will be matched.
|
|
145
|
+
# Arguments will be converted from symbols to strings.
|
|
146
|
+
# @param [Array<String,Symbol>] matches_suffix
|
|
147
|
+
# Files having their name with the specified list of suffixes will be matched.
|
|
148
|
+
# Arguments will be converted from symbols to strings.
|
|
141
149
|
#
|
|
142
150
|
# @example
|
|
143
151
|
# require "google/cloud/storage"
|
|
@@ -157,7 +165,9 @@ module Google
|
|
|
157
165
|
is_live: nil,
|
|
158
166
|
matches_storage_class: nil,
|
|
159
167
|
noncurrent_time_before: nil,
|
|
160
|
-
num_newer_versions: nil
|
|
168
|
+
num_newer_versions: nil,
|
|
169
|
+
matches_prefix: nil,
|
|
170
|
+
matches_suffix: nil
|
|
161
171
|
push Rule.new(
|
|
162
172
|
"SetStorageClass",
|
|
163
173
|
storage_class: storage_class_for(storage_class),
|
|
@@ -169,12 +179,14 @@ module Google
|
|
|
169
179
|
is_live: is_live,
|
|
170
180
|
matches_storage_class: storage_class_for(matches_storage_class),
|
|
171
181
|
noncurrent_time_before: noncurrent_time_before,
|
|
172
|
-
num_newer_versions: num_newer_versions
|
|
182
|
+
num_newer_versions: num_newer_versions,
|
|
183
|
+
matches_prefix: Array(matches_prefix),
|
|
184
|
+
matches_suffix: Array(matches_suffix)
|
|
173
185
|
)
|
|
174
186
|
end
|
|
175
187
|
|
|
176
188
|
##
|
|
177
|
-
# Adds a
|
|
189
|
+
# Adds a Delete lifecycle rule to the Object Lifecycle
|
|
178
190
|
# Management rules for a bucket.
|
|
179
191
|
#
|
|
180
192
|
# @see https://cloud.google.com/storage/docs/lifecycle Object
|
|
@@ -221,6 +233,12 @@ module Google
|
|
|
221
233
|
# files. If the value is N, this condition is satisfied when there
|
|
222
234
|
# are at least N versions (including the live version) newer than
|
|
223
235
|
# this version of the file.
|
|
236
|
+
# @param [Array<String,Symbol>] matches_prefix
|
|
237
|
+
# Files having their name with the specified list of prefixs will be matched.
|
|
238
|
+
# Arguments will be converted from symbols to strings.
|
|
239
|
+
# @param [Array<String,Symbol>] matches_suffix
|
|
240
|
+
# Files having their name with the specified list of suffixes will be matched.
|
|
241
|
+
# Arguments will be converted from symbols to strings.
|
|
224
242
|
#
|
|
225
243
|
# @example
|
|
226
244
|
# require "google/cloud/storage"
|
|
@@ -239,7 +257,9 @@ module Google
|
|
|
239
257
|
is_live: nil,
|
|
240
258
|
matches_storage_class: nil,
|
|
241
259
|
noncurrent_time_before: nil,
|
|
242
|
-
num_newer_versions: nil
|
|
260
|
+
num_newer_versions: nil,
|
|
261
|
+
matches_prefix: nil,
|
|
262
|
+
matches_suffix: nil
|
|
243
263
|
push Rule.new(
|
|
244
264
|
"Delete",
|
|
245
265
|
age: age,
|
|
@@ -250,7 +270,49 @@ module Google
|
|
|
250
270
|
is_live: is_live,
|
|
251
271
|
matches_storage_class: storage_class_for(matches_storage_class),
|
|
252
272
|
noncurrent_time_before: noncurrent_time_before,
|
|
253
|
-
num_newer_versions: num_newer_versions
|
|
273
|
+
num_newer_versions: num_newer_versions,
|
|
274
|
+
matches_prefix: Array(matches_prefix),
|
|
275
|
+
matches_suffix: Array(matches_suffix)
|
|
276
|
+
)
|
|
277
|
+
end
|
|
278
|
+
|
|
279
|
+
##
|
|
280
|
+
# Adds a AbortIncompleteMultipartUpload lifecycle rule to the Object Lifecycle
|
|
281
|
+
# Management rules for a bucket.
|
|
282
|
+
#
|
|
283
|
+
# @see https://cloud.google.com/storage/docs/lifecycle Object
|
|
284
|
+
# Lifecycle Management
|
|
285
|
+
# @see https://cloud.google.com/storage/docs/managing-lifecycles
|
|
286
|
+
# Managing Object Lifecycles
|
|
287
|
+
#
|
|
288
|
+
# @param [Integer] age The age of a file (in days). This condition is
|
|
289
|
+
# satisfied when a file reaches the specified age.
|
|
290
|
+
# @param [Array<String,Symbol>] matches_prefix
|
|
291
|
+
# Files having their name with the specified list of prefixs will be matched.
|
|
292
|
+
# Arguments will be converted from symbols to strings.
|
|
293
|
+
# @param [Array<String,Symbol>] matches_suffix
|
|
294
|
+
# Files having their name with the specified list of suffixes will be matched.
|
|
295
|
+
# Arguments will be converted from symbols to strings.
|
|
296
|
+
#
|
|
297
|
+
# @example
|
|
298
|
+
# require "google/cloud/storage"
|
|
299
|
+
#
|
|
300
|
+
# storage = Google::Cloud::Storage.new
|
|
301
|
+
#
|
|
302
|
+
# bucket = storage.create_bucket "my-bucket" do |b|
|
|
303
|
+
# b.lifecycle.add_abort_incomplete_multipart_upload_rule age: 10,
|
|
304
|
+
# matches_prefix: ["images/"],
|
|
305
|
+
# matches_suffix: [".pdf"]
|
|
306
|
+
# end
|
|
307
|
+
#
|
|
308
|
+
def add_abort_incomplete_multipart_upload_rule age: nil,
|
|
309
|
+
matches_prefix: nil,
|
|
310
|
+
matches_suffix: nil
|
|
311
|
+
push Rule.new(
|
|
312
|
+
"AbortIncompleteMultipartUpload",
|
|
313
|
+
age: age,
|
|
314
|
+
matches_prefix: Array(matches_prefix),
|
|
315
|
+
matches_suffix: Array(matches_suffix)
|
|
254
316
|
)
|
|
255
317
|
end
|
|
256
318
|
|
|
@@ -346,6 +408,8 @@ module Google
|
|
|
346
408
|
# rule.storage_class #=> "COLDLINE"
|
|
347
409
|
# rule.age #=> 10
|
|
348
410
|
# rule.matches_storage_class #=> ["STANDARD", "NEARLINE"]
|
|
411
|
+
# rule.matches_prefix #=> ["myprefix/foo"]
|
|
412
|
+
# rule.matches_suffix #=> [".jpg", ".png"]
|
|
349
413
|
#
|
|
350
414
|
# @example Updating the bucket's lifecycle rules in a block.
|
|
351
415
|
# require "google/cloud/storage"
|
|
@@ -382,6 +446,8 @@ module Google
|
|
|
382
446
|
attr_accessor :matches_storage_class
|
|
383
447
|
attr_accessor :noncurrent_time_before
|
|
384
448
|
attr_accessor :num_newer_versions
|
|
449
|
+
attr_accessor :matches_prefix
|
|
450
|
+
attr_accessor :matches_suffix
|
|
385
451
|
|
|
386
452
|
# @private
|
|
387
453
|
def initialize action,
|
|
@@ -394,7 +460,9 @@ module Google
|
|
|
394
460
|
is_live: nil,
|
|
395
461
|
matches_storage_class: nil,
|
|
396
462
|
noncurrent_time_before: nil,
|
|
397
|
-
num_newer_versions: nil
|
|
463
|
+
num_newer_versions: nil,
|
|
464
|
+
matches_prefix: nil,
|
|
465
|
+
matches_suffix: nil
|
|
398
466
|
@action = action
|
|
399
467
|
@storage_class = storage_class
|
|
400
468
|
@age = age
|
|
@@ -406,6 +474,8 @@ module Google
|
|
|
406
474
|
@matches_storage_class = Array(matches_storage_class)
|
|
407
475
|
@noncurrent_time_before = noncurrent_time_before
|
|
408
476
|
@num_newer_versions = num_newer_versions
|
|
477
|
+
@matches_prefix = Array(matches_prefix)
|
|
478
|
+
@matches_suffix = Array(matches_suffix)
|
|
409
479
|
end
|
|
410
480
|
|
|
411
481
|
# @private
|
|
@@ -420,7 +490,9 @@ module Google
|
|
|
420
490
|
is_live,
|
|
421
491
|
matches_storage_class,
|
|
422
492
|
noncurrent_time_before,
|
|
423
|
-
num_newer_versions
|
|
493
|
+
num_newer_versions,
|
|
494
|
+
matches_prefix,
|
|
495
|
+
matches_suffix
|
|
424
496
|
)
|
|
425
497
|
Google::Apis::StorageV1::Bucket::Lifecycle::Rule.new(
|
|
426
498
|
action: action_gapi(action, storage_class),
|
|
@@ -445,7 +517,9 @@ module Google
|
|
|
445
517
|
is_live,
|
|
446
518
|
matches_storage_class,
|
|
447
519
|
noncurrent_time_before,
|
|
448
|
-
num_newer_versions
|
|
520
|
+
num_newer_versions,
|
|
521
|
+
matches_prefix,
|
|
522
|
+
matches_suffix
|
|
449
523
|
Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Condition.new(
|
|
450
524
|
age: age,
|
|
451
525
|
created_before: created_before,
|
|
@@ -455,7 +529,9 @@ module Google
|
|
|
455
529
|
is_live: is_live,
|
|
456
530
|
matches_storage_class: Array(matches_storage_class),
|
|
457
531
|
noncurrent_time_before: noncurrent_time_before,
|
|
458
|
-
num_newer_versions: num_newer_versions
|
|
532
|
+
num_newer_versions: num_newer_versions,
|
|
533
|
+
matches_prefix: Array(matches_prefix),
|
|
534
|
+
matches_suffix: Array(matches_suffix)
|
|
459
535
|
)
|
|
460
536
|
end
|
|
461
537
|
|
|
@@ -475,7 +551,9 @@ module Google
|
|
|
475
551
|
is_live: c.is_live,
|
|
476
552
|
matches_storage_class: c.matches_storage_class,
|
|
477
553
|
noncurrent_time_before: c.noncurrent_time_before,
|
|
478
|
-
num_newer_versions: c.num_newer_versions
|
|
554
|
+
num_newer_versions: c.num_newer_versions,
|
|
555
|
+
matches_prefix: c.matches_prefix,
|
|
556
|
+
matches_suffix: c.matches_suffix
|
|
479
557
|
)
|
|
480
558
|
end
|
|
481
559
|
|
|
@@ -301,6 +301,20 @@ module Google
|
|
|
301
301
|
@gapi.location_type
|
|
302
302
|
end
|
|
303
303
|
|
|
304
|
+
##
|
|
305
|
+
# Returns the list of regional locations for custom dual-region buckets.
|
|
306
|
+
#
|
|
307
|
+
# @return [String, nil] Returns nil if the property has not been set before creation,
|
|
308
|
+
# if the bucket's resource has not been loaded from the server,
|
|
309
|
+
# or if the bucket is not a dual-regions bucket.
|
|
310
|
+
|
|
311
|
+
# @see https://cloud.google.com/storage/docs/json_api/v1/buckets and
|
|
312
|
+
# https://cloud.google.com/storage/docs/locations
|
|
313
|
+
#
|
|
314
|
+
def data_locations
|
|
315
|
+
@gapi.custom_placement_config&.data_locations
|
|
316
|
+
end
|
|
317
|
+
|
|
304
318
|
##
|
|
305
319
|
# The destination bucket name for the bucket's logs.
|
|
306
320
|
#
|
|
@@ -48,7 +48,7 @@ module Google
|
|
|
48
48
|
#
|
|
49
49
|
def ext_path
|
|
50
50
|
path = "/#{@bucket}/#{@path}"
|
|
51
|
-
escaped = Addressable::URI.
|
|
51
|
+
escaped = Addressable::URI.encode_component path, Addressable::URI::CharacterClasses::PATH
|
|
52
52
|
special_var = "${filename}"
|
|
53
53
|
# Restore the unencoded `${filename}` variable, if present.
|
|
54
54
|
if path.include? special_var
|
|
@@ -326,7 +326,7 @@ module Google
|
|
|
326
326
|
#
|
|
327
327
|
def post_object_ext_path
|
|
328
328
|
path = "/#{@bucket_name}/#{@file_name}"
|
|
329
|
-
escaped = Addressable::URI.
|
|
329
|
+
escaped = Addressable::URI.encode_component path, Addressable::URI::CharacterClasses::PATH
|
|
330
330
|
special_var = "${filename}"
|
|
331
331
|
# Restore the unencoded `${filename}` variable, if present.
|
|
332
332
|
if path.include? special_var
|
|
@@ -290,9 +290,9 @@ module Google
|
|
|
290
290
|
# access, and allUsers get READER access.
|
|
291
291
|
# @param [String] location The location of the bucket. Optional.
|
|
292
292
|
# If not passed, the default location, 'US', will be used.
|
|
293
|
-
# If specifying a dual-region location, the
|
|
294
|
-
#
|
|
295
|
-
# [Storage
|
|
293
|
+
# If specifying a dual-region location, the `customPlacementConfig`
|
|
294
|
+
# property should be set in conjunction. See:
|
|
295
|
+
# [Storage Locations](https://cloud.google.com/storage/docs/locations).
|
|
296
296
|
# @param [String] logging_bucket The destination bucket for the bucket's
|
|
297
297
|
# logs. For more information, see [Access
|
|
298
298
|
# Logs](https://cloud.google.com/storage/docs/access-logs).
|
|
@@ -367,6 +367,7 @@ module Google
|
|
|
367
367
|
acl: nil,
|
|
368
368
|
default_acl: nil,
|
|
369
369
|
location: nil,
|
|
370
|
+
custom_placement_config: nil,
|
|
370
371
|
storage_class: nil,
|
|
371
372
|
logging_bucket: nil,
|
|
372
373
|
logging_prefix: nil,
|
|
@@ -377,7 +378,8 @@ module Google
|
|
|
377
378
|
user_project: nil
|
|
378
379
|
params = {
|
|
379
380
|
name: bucket_name,
|
|
380
|
-
location: location
|
|
381
|
+
location: location,
|
|
382
|
+
custom_placement_config: custom_placement_config
|
|
381
383
|
}.delete_if { |_, v| v.nil? }
|
|
382
384
|
new_bucket = Google::Apis::StorageV1::Bucket.new(**params)
|
|
383
385
|
storage_class = storage_class_for storage_class
|