-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
storage_v1.objects.html
1985 lines (1886 loc) · 202 KB
/
storage_v1.objects.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="storage_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.objects.html">objects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#bulkRestore">bulkRestore(bucket, body=None)</a></code></p>
<p class="firstline">Initiates a long-running bulk restore operation on the specified bucket.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#compose">compose(destinationBucket, destinationObject, body=None, destinationPredefinedAcl=None, ifGenerationMatch=None, ifMetagenerationMatch=None, kmsKeyName=None, userProject=None)</a></code></p>
<p class="firstline">Concatenates a list of existing objects into a new object in the same bucket.</p>
<p class="toc_element">
<code><a href="#copy">copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body=None, destinationKmsKeyName=None, destinationPredefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationMatch=None, ifSourceMetagenerationNotMatch=None, projection=None, sourceGeneration=None, userProject=None)</a></code></p>
<p class="firstline">Copies a source object to a destination object. Optionally overrides metadata.</p>
<p class="toc_element">
<code><a href="#delete">delete(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, userProject=None)</a></code></p>
<p class="firstline">Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.</p>
<p class="toc_element">
<code><a href="#get">get(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, softDeleted=None, userProject=None)</a></code></p>
<p class="firstline">Retrieves an object or its metadata.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(bucket, object, generation=None, userProject=None)</a></code></p>
<p class="firstline">Returns an IAM policy for the specified object.</p>
<p class="toc_element">
<code><a href="#get_media">get_media(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, softDeleted=None, userProject=None)</a></code></p>
<p class="firstline">Retrieves an object or its metadata.</p>
<p class="toc_element">
<code><a href="#insert">insert(bucket, body=None, contentEncoding=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, kmsKeyName=None, media_body=None, media_mime_type=None, name=None, predefinedAcl=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Stores a new object and metadata.</p>
<p class="toc_element">
<code><a href="#list">list(bucket, delimiter=None, endOffset=None, includeFoldersAsPrefixes=None, includeTrailingDelimiter=None, matchGlob=None, maxResults=None, pageToken=None, prefix=None, projection=None, softDeleted=None, startOffset=None, userProject=None, versions=None)</a></code></p>
<p class="firstline">Retrieves a list of objects matching the criteria.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(bucket, object, body=None, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, overrideUnlockedRetention=None, predefinedAcl=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Patches an object's metadata.</p>
<p class="toc_element">
<code><a href="#restore">restore(bucket, object, generation, copySourceAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Restores a soft-deleted object.</p>
<p class="toc_element">
<code><a href="#rewrite">rewrite(sourceBucket, sourceObject, destinationBucket, destinationObject, body=None, destinationKmsKeyName=None, destinationPredefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationMatch=None, ifSourceMetagenerationNotMatch=None, maxBytesRewrittenPerCall=None, projection=None, rewriteToken=None, sourceGeneration=None, userProject=None)</a></code></p>
<p class="firstline">Rewrites a source object to a destination object. Optionally overrides metadata.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(bucket, object, body=None, generation=None, userProject=None)</a></code></p>
<p class="firstline">Updates an IAM policy for the specified object.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(bucket, object, permissions, generation=None, userProject=None)</a></code></p>
<p class="firstline">Tests a set of permissions on the given object to see which, if any, are held by the caller.</p>
<p class="toc_element">
<code><a href="#update">update(bucket, object, body=None, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, overrideUnlockedRetention=None, predefinedAcl=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Updates an object's metadata.</p>
<p class="toc_element">
<code><a href="#watchAll">watchAll(bucket, body=None, delimiter=None, endOffset=None, includeTrailingDelimiter=None, maxResults=None, pageToken=None, prefix=None, projection=None, startOffset=None, userProject=None, versions=None)</a></code></p>
<p class="firstline">Watch for changes on all objects in a bucket.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="bulkRestore">bulkRestore(bucket, body=None)</code>
<pre>Initiates a long-running bulk restore operation on the specified bucket.
Args:
bucket: string, Name of the bucket in which the object resides. (required)
body: object, The request body.
The object takes the form of:
{ # A bulk restore objects request.
"allowOverwrite": True or False, # If false (default), the restore will not overwrite live objects with the same name at the destination. This means some deleted objects may be skipped. If true, live objects will be overwritten resulting in a noncurrent object (if versioning is enabled). If versioning is not enabled, overwriting the object will result in a soft-deleted object. In either case, if a noncurrent object already exists with the same name, a live version can be written without issue.
"copySourceAcl": True or False, # If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.
"matchGlobs": [ # Restores only the objects matching any of the specified glob(s). If this parameter is not specified, all objects will be restored within the specified time range.
"A String",
],
"softDeletedAfterTime": "A String", # Restores only the objects that were soft-deleted after this time.
"softDeletedBeforeTime": "A String", # Restores only the objects that were soft-deleted before this time.
}
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is "false", it means the operation is still in progress. If "true", the operation is completed, and either "error" or "response" is available.
"error": { # The "Status" type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each "Status" message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the "name" should be a resource name ending with "operations/{operationId}".
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as "Delete", the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type "XxxResponse", where "Xxx" is the original method name. For example, if the original method name is "TakeSnapshot()", the inferred response type is "TakeSnapshotResponse".
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="compose">compose(destinationBucket, destinationObject, body=None, destinationPredefinedAcl=None, ifGenerationMatch=None, ifMetagenerationMatch=None, kmsKeyName=None, userProject=None)</code>
<pre>Concatenates a list of existing objects into a new object in the same bucket.
Args:
destinationBucket: string, Name of the bucket containing the source objects. The destination object is stored in this bucket. (required)
destinationObject: string, Name of the new object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
body: object, The request body.
The object takes the form of:
{ # A Compose request.
"destination": { # An object. # Properties of the resulting object.
"acl": [ # Access controls on the object.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
},
],
"bucket": "A String", # The name of the bucket containing this object.
"cacheControl": "A String", # Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"contentDisposition": "A String", # Content-Disposition of the object data.
"contentEncoding": "A String", # Content-Encoding of the object data.
"contentLanguage": "A String", # Content-Language of the object data.
"contentType": "A String", # Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
"crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
"customTime": "A String", # A timestamp in RFC 3339 format specified by the user for an object.
"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
"encryptionAlgorithm": "A String", # The encryption algorithm.
"keySha256": "A String", # SHA256 hash value of the encryption key.
},
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"eventBasedHold": True or False, # Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
"generation": "A String", # The content generation of this object. Used for object versioning.
"hardDeleteTime": "A String", # This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
"id": "A String", # The ID of the object, including the bucket name, object name, and generation number.
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
"kmsKeyName": "A String", # Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
"mediaLink": "A String", # Media download link.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
},
"metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
"name": "A String", # The name of the object. Required if not specified by URL parameter.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entity": "A String", # The entity, in the form user-userId.
"entityId": "A String", # The ID for the entity.
},
"retention": { # A collection of object level retention parameters.
"mode": "A String", # The bucket's object retention mode, can only be Unlocked or Locked.
"retainUntilTime": "A String", # A time in RFC 3339 format until which object retention protects this object.
},
"retentionExpirationTime": "A String", # A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
"selfLink": "A String", # The link to this object.
"size": "A String", # Content-Length of the data in bytes.
"softDeleteTime": "A String", # The time at which the object became soft-deleted in RFC 3339 format.
"storageClass": "A String", # Storage class of the object.
"temporaryHold": True or False, # Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
"timeCreated": "A String", # The creation time of the object in RFC 3339 format.
"timeDeleted": "A String", # The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
"updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
},
"kind": "storage#composeRequest", # The kind of item this is.
"sourceObjects": [ # The list of source objects that will be concatenated into a single object.
{
"generation": "A String", # The generation of this object to use as the source.
"name": "A String", # The source object's name. All source objects must reside in the same bucket.
"objectPreconditions": { # Conditions that must be met for this operation to execute.
"ifGenerationMatch": "A String", # Only perform the composition if the generation of the source object that would be used matches this value. If this value and a generation are both specified, they must be the same value or the call will fail.
},
},
],
}
destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
Allowed values
authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
private - Object owner gets OWNER access.
projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
publicRead - Object owner gets OWNER access, and allUsers get READER access.
ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
kmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An object.
"acl": [ # Access controls on the object.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
},
],
"bucket": "A String", # The name of the bucket containing this object.
"cacheControl": "A String", # Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"contentDisposition": "A String", # Content-Disposition of the object data.
"contentEncoding": "A String", # Content-Encoding of the object data.
"contentLanguage": "A String", # Content-Language of the object data.
"contentType": "A String", # Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
"crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
"customTime": "A String", # A timestamp in RFC 3339 format specified by the user for an object.
"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
"encryptionAlgorithm": "A String", # The encryption algorithm.
"keySha256": "A String", # SHA256 hash value of the encryption key.
},
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"eventBasedHold": True or False, # Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
"generation": "A String", # The content generation of this object. Used for object versioning.
"hardDeleteTime": "A String", # This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
"id": "A String", # The ID of the object, including the bucket name, object name, and generation number.
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
"kmsKeyName": "A String", # Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
"mediaLink": "A String", # Media download link.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
},
"metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
"name": "A String", # The name of the object. Required if not specified by URL parameter.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entity": "A String", # The entity, in the form user-userId.
"entityId": "A String", # The ID for the entity.
},
"retention": { # A collection of object level retention parameters.
"mode": "A String", # The bucket's object retention mode, can only be Unlocked or Locked.
"retainUntilTime": "A String", # A time in RFC 3339 format until which object retention protects this object.
},
"retentionExpirationTime": "A String", # A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
"selfLink": "A String", # The link to this object.
"size": "A String", # Content-Length of the data in bytes.
"softDeleteTime": "A String", # The time at which the object became soft-deleted in RFC 3339 format.
"storageClass": "A String", # Storage class of the object.
"temporaryHold": True or False, # Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
"timeCreated": "A String", # The creation time of the object in RFC 3339 format.
"timeDeleted": "A String", # The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
"updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
}</pre>
</div>
<div class="method">
<code class="details" id="copy">copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body=None, destinationKmsKeyName=None, destinationPredefinedAcl=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationMatch=None, ifSourceMetagenerationNotMatch=None, projection=None, sourceGeneration=None, userProject=None)</code>
<pre>Copies a source object to a destination object. Optionally overrides metadata.
Args:
sourceBucket: string, Name of the bucket in which to find the source object. (required)
sourceObject: string, Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
destinationBucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
destinationObject: string, Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. (required)
body: object, The request body.
The object takes the form of:
{ # An object.
"acl": [ # Access controls on the object.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
},
],
"bucket": "A String", # The name of the bucket containing this object.
"cacheControl": "A String", # Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"contentDisposition": "A String", # Content-Disposition of the object data.
"contentEncoding": "A String", # Content-Encoding of the object data.
"contentLanguage": "A String", # Content-Language of the object data.
"contentType": "A String", # Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
"crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
"customTime": "A String", # A timestamp in RFC 3339 format specified by the user for an object.
"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
"encryptionAlgorithm": "A String", # The encryption algorithm.
"keySha256": "A String", # SHA256 hash value of the encryption key.
},
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"eventBasedHold": True or False, # Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
"generation": "A String", # The content generation of this object. Used for object versioning.
"hardDeleteTime": "A String", # This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
"id": "A String", # The ID of the object, including the bucket name, object name, and generation number.
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
"kmsKeyName": "A String", # Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
"mediaLink": "A String", # Media download link.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
},
"metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
"name": "A String", # The name of the object. Required if not specified by URL parameter.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entity": "A String", # The entity, in the form user-userId.
"entityId": "A String", # The ID for the entity.
},
"retention": { # A collection of object level retention parameters.
"mode": "A String", # The bucket's object retention mode, can only be Unlocked or Locked.
"retainUntilTime": "A String", # A time in RFC 3339 format until which object retention protects this object.
},
"retentionExpirationTime": "A String", # A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
"selfLink": "A String", # The link to this object.
"size": "A String", # Content-Length of the data in bytes.
"softDeleteTime": "A String", # The time at which the object became soft-deleted in RFC 3339 format.
"storageClass": "A String", # Storage class of the object.
"temporaryHold": True or False, # Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
"timeCreated": "A String", # The creation time of the object in RFC 3339 format.
"timeDeleted": "A String", # The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
"updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
}
destinationKmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
destinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
Allowed values
authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
private - Object owner gets OWNER access.
projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
publicRead - Object owner gets OWNER access, and allUsers get READER access.
ifGenerationMatch: string, Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
ifGenerationNotMatch: string, Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
ifSourceGenerationMatch: string, Makes the operation conditional on whether the source object's current generation matches the given value.
ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's current generation does not match the given value.
ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source object's current metageneration matches the given value.
ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value.
projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
Allowed values
full - Include all properties.
noAcl - Omit the owner, acl property.
sourceGeneration: string, If present, selects a specific revision of the source object (as opposed to the latest version, the default).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An object.
"acl": [ # Access controls on the object.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
},
],
"bucket": "A String", # The name of the bucket containing this object.
"cacheControl": "A String", # Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"contentDisposition": "A String", # Content-Disposition of the object data.
"contentEncoding": "A String", # Content-Encoding of the object data.
"contentLanguage": "A String", # Content-Language of the object data.
"contentType": "A String", # Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
"crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
"customTime": "A String", # A timestamp in RFC 3339 format specified by the user for an object.
"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
"encryptionAlgorithm": "A String", # The encryption algorithm.
"keySha256": "A String", # SHA256 hash value of the encryption key.
},
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"eventBasedHold": True or False, # Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
"generation": "A String", # The content generation of this object. Used for object versioning.
"hardDeleteTime": "A String", # This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
"id": "A String", # The ID of the object, including the bucket name, object name, and generation number.
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
"kmsKeyName": "A String", # Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
"mediaLink": "A String", # Media download link.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
},
"metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
"name": "A String", # The name of the object. Required if not specified by URL parameter.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entity": "A String", # The entity, in the form user-userId.
"entityId": "A String", # The ID for the entity.
},
"retention": { # A collection of object level retention parameters.
"mode": "A String", # The bucket's object retention mode, can only be Unlocked or Locked.
"retainUntilTime": "A String", # A time in RFC 3339 format until which object retention protects this object.
},
"retentionExpirationTime": "A String", # A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
"selfLink": "A String", # The link to this object.
"size": "A String", # Content-Length of the data in bytes.
"softDeleteTime": "A String", # The time at which the object became soft-deleted in RFC 3339 format.
"storageClass": "A String", # Storage class of the object.
"temporaryHold": True or False, # Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
"timeCreated": "A String", # The creation time of the object in RFC 3339 format.
"timeDeleted": "A String", # The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
"updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, userProject=None)</code>
<pre>Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
Args:
bucket: string, Name of the bucket in which the object resides. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
generation: string, If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).
ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
</pre>
</div>
<div class="method">
<code class="details" id="get">get(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, softDeleted=None, userProject=None)</code>
<pre>Retrieves an object or its metadata.
Args:
bucket: string, Name of the bucket in which the object resides. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
projection: string, Set of properties to return. Defaults to noAcl.
Allowed values
full - Include all properties.
noAcl - Omit the owner, acl property.
softDeleted: boolean, If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An object.
"acl": [ # Access controls on the object.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
},
],
"bucket": "A String", # The name of the bucket containing this object.
"cacheControl": "A String", # Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"contentDisposition": "A String", # Content-Disposition of the object data.
"contentEncoding": "A String", # Content-Encoding of the object data.
"contentLanguage": "A String", # Content-Language of the object data.
"contentType": "A String", # Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
"crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
"customTime": "A String", # A timestamp in RFC 3339 format specified by the user for an object.
"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
"encryptionAlgorithm": "A String", # The encryption algorithm.
"keySha256": "A String", # SHA256 hash value of the encryption key.
},
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"eventBasedHold": True or False, # Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
"generation": "A String", # The content generation of this object. Used for object versioning.
"hardDeleteTime": "A String", # This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
"id": "A String", # The ID of the object, including the bucket name, object name, and generation number.
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
"kmsKeyName": "A String", # Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
"mediaLink": "A String", # Media download link.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
},
"metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
"name": "A String", # The name of the object. Required if not specified by URL parameter.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entity": "A String", # The entity, in the form user-userId.
"entityId": "A String", # The ID for the entity.
},
"retention": { # A collection of object level retention parameters.
"mode": "A String", # The bucket's object retention mode, can only be Unlocked or Locked.
"retainUntilTime": "A String", # A time in RFC 3339 format until which object retention protects this object.
},
"retentionExpirationTime": "A String", # A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
"selfLink": "A String", # The link to this object.
"size": "A String", # Content-Length of the data in bytes.
"softDeleteTime": "A String", # The time at which the object became soft-deleted in RFC 3339 format.
"storageClass": "A String", # Storage class of the object.
"temporaryHold": True or False, # Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
"timeCreated": "A String", # The creation time of the object in RFC 3339 format.
"timeDeleted": "A String", # The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
"updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(bucket, object, generation=None, userProject=None)</code>
<pre>Returns an IAM policy for the specified object.
Args:
bucket: string, Name of the bucket in which the object resides. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # A bucket/object/managedFolder IAM policy.
"bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
{
"condition": { # Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" # The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
"description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
"location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
# - allUsers — A special identifier that represents anyone on the internet; with or without a Google account.
# - allAuthenticatedUsers — A special identifier that represents anyone who is authenticated with a Google account or a service account.
# - user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com.
# - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
# - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
# - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
# - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
# - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
# - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
"A String",
],
"role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
# The new IAM roles are:
# - roles/storage.admin — Full control of Google Cloud Storage resources.
# - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
# - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
# - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
# - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
# - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
# - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
# - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
# - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
},
],
"etag": "A String", # HTTP 1.1 Entity tag for the policy.
"kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
"resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
"version": 42, # The IAM policy format version.
}</pre>
</div>
<div class="method">
<code class="details" id="get_media">get_media(bucket, object, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, softDeleted=None, userProject=None)</code>
<pre>Retrieves an object or its metadata.
Args:
bucket: string, Name of the bucket in which the object resides. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
projection: string, Set of properties to return. Defaults to noAcl.
Allowed values
full - Include all properties.
noAcl - Omit the owner, acl property.
softDeleted: boolean, If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
The media object as a string.
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(bucket, body=None, contentEncoding=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, kmsKeyName=None, media_body=None, media_mime_type=None, name=None, predefinedAcl=None, projection=None, userProject=None)</code>
<pre>Stores a new object and metadata.
Args:
bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
body: object, The request body.
The object takes the form of:
{ # An object.
"acl": [ # Access controls on the object.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
},
],
"bucket": "A String", # The name of the bucket containing this object.
"cacheControl": "A String", # Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"contentDisposition": "A String", # Content-Disposition of the object data.
"contentEncoding": "A String", # Content-Encoding of the object data.
"contentLanguage": "A String", # Content-Language of the object data.
"contentType": "A String", # Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
"crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
"customTime": "A String", # A timestamp in RFC 3339 format specified by the user for an object.
"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
"encryptionAlgorithm": "A String", # The encryption algorithm.
"keySha256": "A String", # SHA256 hash value of the encryption key.
},
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"eventBasedHold": True or False, # Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
"generation": "A String", # The content generation of this object. Used for object versioning.
"hardDeleteTime": "A String", # This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
"id": "A String", # The ID of the object, including the bucket name, object name, and generation number.
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
"kmsKeyName": "A String", # Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
"mediaLink": "A String", # Media download link.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
},
"metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
"name": "A String", # The name of the object. Required if not specified by URL parameter.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entity": "A String", # The entity, in the form user-userId.
"entityId": "A String", # The ID for the entity.
},
"retention": { # A collection of object level retention parameters.
"mode": "A String", # The bucket's object retention mode, can only be Unlocked or Locked.
"retainUntilTime": "A String", # A time in RFC 3339 format until which object retention protects this object.
},
"retentionExpirationTime": "A String", # A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
"selfLink": "A String", # The link to this object.
"size": "A String", # Content-Length of the data in bytes.
"softDeleteTime": "A String", # The time at which the object became soft-deleted in RFC 3339 format.
"storageClass": "A String", # Storage class of the object.
"temporaryHold": True or False, # Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
"timeCreated": "A String", # The creation time of the object in RFC 3339 format.
"timeDeleted": "A String", # The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
"updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
}
contentEncoding: string, If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.
ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
kmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
predefinedAcl: string, Apply a predefined set of access controls to this object.
Allowed values
authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
private - Object owner gets OWNER access.
projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles.
publicRead - Object owner gets OWNER access, and allUsers get READER access.
projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
Allowed values
full - Include all properties.
noAcl - Omit the owner, acl property.
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An object.
"acl": [ # Access controls on the object.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
},
],
"bucket": "A String", # The name of the bucket containing this object.
"cacheControl": "A String", # Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
"componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations.
"contentDisposition": "A String", # Content-Disposition of the object data.
"contentEncoding": "A String", # Content-Encoding of the object data.
"contentLanguage": "A String", # Content-Language of the object data.
"contentType": "A String", # Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
"crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
"customTime": "A String", # A timestamp in RFC 3339 format specified by the user for an object.
"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
"encryptionAlgorithm": "A String", # The encryption algorithm.
"keySha256": "A String", # SHA256 hash value of the encryption key.
},
"etag": "A String", # HTTP 1.1 Entity tag for the object.
"eventBasedHold": True or False, # Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
"generation": "A String", # The content generation of this object. Used for object versioning.
"hardDeleteTime": "A String", # This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
"id": "A String", # The ID of the object, including the bucket name, object name, and generation number.
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
"kmsKeyName": "A String", # Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
"md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
"mediaLink": "A String", # Media download link.
"metadata": { # User-provided metadata, in key/value pairs.
"a_key": "A String", # An individual metadata entry.
},
"metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
"name": "A String", # The name of the object. Required if not specified by URL parameter.
"owner": { # The owner of the object. This will always be the uploader of the object.
"entity": "A String", # The entity, in the form user-userId.
"entityId": "A String", # The ID for the entity.
},
"retention": { # A collection of object level retention parameters.
"mode": "A String", # The bucket's object retention mode, can only be Unlocked or Locked.
"retainUntilTime": "A String", # A time in RFC 3339 format until which object retention protects this object.
},
"retentionExpirationTime": "A String", # A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
"selfLink": "A String", # The link to this object.
"size": "A String", # Content-Length of the data in bytes.
"softDeleteTime": "A String", # The time at which the object became soft-deleted in RFC 3339 format.
"storageClass": "A String", # Storage class of the object.
"temporaryHold": True or False, # Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
"timeCreated": "A String", # The creation time of the object in RFC 3339 format.
"timeDeleted": "A String", # The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
"timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
"updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(bucket, delimiter=None, endOffset=None, includeFoldersAsPrefixes=None, includeTrailingDelimiter=None, matchGlob=None, maxResults=None, pageToken=None, prefix=None, projection=None, softDeleted=None, startOffset=None, userProject=None, versions=None)</code>
<pre>Retrieves a list of objects matching the criteria.
Args:
bucket: string, Name of the bucket in which to look for objects. (required)
delimiter: string, Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
endOffset: string, Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
includeFoldersAsPrefixes: boolean, Only applicable if delimiter is set to '/'. If true, will also include folders and managed folders (besides objects) in the returned prefixes.
includeTrailingDelimiter: boolean, If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
matchGlob: string, Filter results to objects and prefixes that match this glob pattern.
maxResults: integer, Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
pageToken: string, A previously-returned page token representing part of the larger set of results to view.
prefix: string, Filter results to objects whose names begin with this prefix.
projection: string, Set of properties to return. Defaults to noAcl.
Allowed values
full - Include all properties.
noAcl - Omit the owner, acl property.
softDeleted: boolean, If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
startOffset: string, Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
versions: boolean, If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
Returns:
An object of the form:
{ # A list of objects.
"items": [ # The list of items.
{ # An object.
"acl": [ # Access controls on the object.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.