-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
storage_v1.buckets.html
2116 lines (2051 loc) · 198 KB
/
storage_v1.buckets.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.buckets.html">buckets</a></h1>
<h2>Instance Methods</h2>
<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="#delete">delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, userProject=None)</a></code></p>
<p class="firstline">Permanently deletes an empty bucket.</p>
<p class="toc_element">
<code><a href="#get">get(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Returns metadata for the specified bucket.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(bucket, optionsRequestedPolicyVersion=None, userProject=None)</a></code></p>
<p class="firstline">Returns an IAM policy for the specified bucket.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body=None, enableObjectRetention=None, predefinedAcl=None, predefinedDefaultObjectAcl=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Creates a new bucket.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, prefix=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Retrieves a list of buckets for a given project.</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="#lockRetentionPolicy">lockRetentionPolicy(bucket, ifMetagenerationMatch, userProject=None)</a></code></p>
<p class="firstline">Locks retention policy on a bucket.</p>
<p class="toc_element">
<code><a href="#patch">patch(bucket, body=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, predefinedAcl=None, predefinedDefaultObjectAcl=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(bucket, body=None, userProject=None)</a></code></p>
<p class="firstline">Updates an IAM policy for the specified bucket.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(bucket, permissions, userProject=None)</a></code></p>
<p class="firstline">Tests a set of permissions on the given bucket to see which, if any, are held by the caller.</p>
<p class="toc_element">
<code><a href="#update">update(bucket, body=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, predefinedAcl=None, predefinedDefaultObjectAcl=None, projection=None, userProject=None)</a></code></p>
<p class="firstline">Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, userProject=None)</code>
<pre>Permanently deletes an empty bucket.
Args:
bucket: string, Name of a bucket. (required)
ifMetagenerationMatch: string, If set, only deletes the bucket if its metageneration matches this value.
ifMetagenerationNotMatch: string, If set, only deletes the bucket if its metageneration does not match this 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, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, projection=None, userProject=None)</code>
<pre>Returns metadata for the specified bucket.
Args:
bucket: string, Name of a bucket. (required)
ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket'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 owner, acl and defaultObjectAcl properties.
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # A bucket.
"acl": [ # Access controls on the bucket.
{ # 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.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
"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.
},
],
"autoclass": { # The bucket's Autoclass configuration.
"enabled": True or False, # Whether or not Autoclass is enabled on this bucket
"terminalStorageClass": "A String", # The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Valid values are NEARLINE and ARCHIVE.
"terminalStorageClassUpdateTime": "A String", # A date and time in RFC 3339 format representing the time of the most recent update to "terminalStorageClass".
"toggleTime": "A String", # A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.
},
"billing": { # The bucket's billing configuration.
"requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket.
},
"cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
{
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
"method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
"A String",
],
"origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
"A String",
],
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
},
],
"customPlacementConfig": { # The bucket's custom placement configuration for Custom Dual Regions.
"dataLocations": [ # The list of regional locations in which data is placed.
"A String",
],
},
"defaultEventBasedHold": True or False, # The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, 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 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. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # 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.
},
],
"encryption": { # Encryption configuration for a bucket.
"defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.
},
"etag": "A String", # HTTP 1.1 Entity tag for the bucket.
"iamConfiguration": { # The bucket's IAM configuration.
"bucketPolicyOnly": { # The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
"enabled": True or False, # If set, access is controlled only by bucket-level or above IAM policies.
"lockedTime": "A String", # The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.
},
"publicAccessPrevention": "A String", # The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
"uniformBucketLevelAccess": { # The bucket's uniform bucket-level access configuration.
"enabled": True or False, # If set, access is controlled only by bucket-level or above IAM policies.
"lockedTime": "A String", # The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.
},
},
"id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same.
"kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
"labels": { # User-provided labels, in key/value pairs.
"a_key": "A String", # An individual label entry.
},
"lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information.
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
"storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
"type": "A String", # Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.
},
"condition": { # The condition(s) under which the action will be taken.
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
"customTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
"daysSinceCustomTime": 42, # Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
"daysSinceNoncurrentTime": 42, # Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
"matchesPattern": "A String", # A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
"matchesPrefix": [ # List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
"A String",
],
"matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
"A String",
],
"matchesSuffix": [ # List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
"A String",
],
"noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
"numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
},
},
],
},
"location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
"locationType": "A String", # The type of the bucket location.
"logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
"logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
"logObjectPrefix": "A String", # A prefix for log object names.
},
"metageneration": "A String", # The metadata generation of this bucket.
"name": "A String", # The name of the bucket.
"objectRetention": { # The bucket's object retention config.
"mode": "A String", # The bucket's object retention mode. Can be Enabled.
},
"owner": { # The owner of the bucket. This is always the project team's owner group.
"entity": "A String", # The entity, in the form project-owner-projectId.
"entityId": "A String", # The ID for the entity.
},
"projectNumber": "A String", # The project number of the project the bucket belongs to.
"retentionPolicy": { # The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
"effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
"isLocked": True or False, # Once locked, an object retention policy cannot be modified.
"retentionPeriod": "A String", # The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.
},
"rpo": "A String", # The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
"satisfiesPZS": True or False, # Reserved for future use.
"selfLink": "A String", # The URI of this bucket.
"softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.
"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
"retentionDurationSeconds": "A String", # The period of time in seconds, that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.
},
"storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
},
"website": { # The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
"mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
"notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
},
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(bucket, optionsRequestedPolicyVersion=None, userProject=None)</code>
<pre>Returns an IAM policy for the specified bucket.
Args:
bucket: string, Name of a bucket. (required)
optionsRequestedPolicyVersion: integer, The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
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="insert">insert(project, body=None, enableObjectRetention=None, predefinedAcl=None, predefinedDefaultObjectAcl=None, projection=None, userProject=None)</code>
<pre>Creates a new bucket.
Args:
project: string, A valid API project identifier. (required)
body: object, The request body.
The object takes the form of:
{ # A bucket.
"acl": [ # Access controls on the bucket.
{ # 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.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
"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.
},
],
"autoclass": { # The bucket's Autoclass configuration.
"enabled": True or False, # Whether or not Autoclass is enabled on this bucket
"terminalStorageClass": "A String", # The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Valid values are NEARLINE and ARCHIVE.
"terminalStorageClassUpdateTime": "A String", # A date and time in RFC 3339 format representing the time of the most recent update to "terminalStorageClass".
"toggleTime": "A String", # A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.
},
"billing": { # The bucket's billing configuration.
"requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket.
},
"cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
{
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
"method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
"A String",
],
"origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
"A String",
],
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
},
],
"customPlacementConfig": { # The bucket's custom placement configuration for Custom Dual Regions.
"dataLocations": [ # The list of regional locations in which data is placed.
"A String",
],
},
"defaultEventBasedHold": True or False, # The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, 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 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. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # 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.
},
],
"encryption": { # Encryption configuration for a bucket.
"defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.
},
"etag": "A String", # HTTP 1.1 Entity tag for the bucket.
"iamConfiguration": { # The bucket's IAM configuration.
"bucketPolicyOnly": { # The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
"enabled": True or False, # If set, access is controlled only by bucket-level or above IAM policies.
"lockedTime": "A String", # The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.
},
"publicAccessPrevention": "A String", # The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
"uniformBucketLevelAccess": { # The bucket's uniform bucket-level access configuration.
"enabled": True or False, # If set, access is controlled only by bucket-level or above IAM policies.
"lockedTime": "A String", # The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.
},
},
"id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same.
"kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
"labels": { # User-provided labels, in key/value pairs.
"a_key": "A String", # An individual label entry.
},
"lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information.
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
"storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
"type": "A String", # Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.
},
"condition": { # The condition(s) under which the action will be taken.
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
"customTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
"daysSinceCustomTime": 42, # Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
"daysSinceNoncurrentTime": 42, # Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
"matchesPattern": "A String", # A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
"matchesPrefix": [ # List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
"A String",
],
"matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
"A String",
],
"matchesSuffix": [ # List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
"A String",
],
"noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
"numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
},
},
],
},
"location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
"locationType": "A String", # The type of the bucket location.
"logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
"logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
"logObjectPrefix": "A String", # A prefix for log object names.
},
"metageneration": "A String", # The metadata generation of this bucket.
"name": "A String", # The name of the bucket.
"objectRetention": { # The bucket's object retention config.
"mode": "A String", # The bucket's object retention mode. Can be Enabled.
},
"owner": { # The owner of the bucket. This is always the project team's owner group.
"entity": "A String", # The entity, in the form project-owner-projectId.
"entityId": "A String", # The ID for the entity.
},
"projectNumber": "A String", # The project number of the project the bucket belongs to.
"retentionPolicy": { # The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
"effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
"isLocked": True or False, # Once locked, an object retention policy cannot be modified.
"retentionPeriod": "A String", # The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.
},
"rpo": "A String", # The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
"satisfiesPZS": True or False, # Reserved for future use.
"selfLink": "A String", # The URI of this bucket.
"softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.
"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
"retentionDurationSeconds": "A String", # The period of time in seconds, that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.
},
"storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
},
"website": { # The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
"mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
"notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
},
}
enableObjectRetention: boolean, When set to true, object retention is enabled for this bucket.
predefinedAcl: string, Apply a predefined set of access controls to this bucket.
Allowed values
authenticatedRead - Project team owners get OWNER access, and allAuthenticatedUsers get READER access.
private - Project team owners get OWNER access.
projectPrivate - Project team members get access according to their roles.
publicRead - Project team owners get OWNER access, and allUsers get READER access.
publicReadWrite - Project team owners get OWNER access, and allUsers get WRITER access.
predefinedDefaultObjectAcl: string, Apply a predefined set of default object access controls to this bucket.
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 bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
Allowed values
full - Include all properties.
noAcl - Omit owner, acl and defaultObjectAcl properties.
userProject: string, The project to be billed for this request.
Returns:
An object of the form:
{ # A bucket.
"acl": [ # Access controls on the bucket.
{ # 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.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
"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.
},
],
"autoclass": { # The bucket's Autoclass configuration.
"enabled": True or False, # Whether or not Autoclass is enabled on this bucket
"terminalStorageClass": "A String", # The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Valid values are NEARLINE and ARCHIVE.
"terminalStorageClassUpdateTime": "A String", # A date and time in RFC 3339 format representing the time of the most recent update to "terminalStorageClass".
"toggleTime": "A String", # A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.
},
"billing": { # The bucket's billing configuration.
"requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket.
},
"cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
{
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
"method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
"A String",
],
"origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
"A String",
],
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
},
],
"customPlacementConfig": { # The bucket's custom placement configuration for Custom Dual Regions.
"dataLocations": [ # The list of regional locations in which data is placed.
"A String",
],
},
"defaultEventBasedHold": True or False, # The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, 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 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. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # 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.
},
],
"encryption": { # Encryption configuration for a bucket.
"defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.
},
"etag": "A String", # HTTP 1.1 Entity tag for the bucket.
"iamConfiguration": { # The bucket's IAM configuration.
"bucketPolicyOnly": { # The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
"enabled": True or False, # If set, access is controlled only by bucket-level or above IAM policies.
"lockedTime": "A String", # The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.
},
"publicAccessPrevention": "A String", # The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
"uniformBucketLevelAccess": { # The bucket's uniform bucket-level access configuration.
"enabled": True or False, # If set, access is controlled only by bucket-level or above IAM policies.
"lockedTime": "A String", # The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.
},
},
"id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same.
"kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
"labels": { # User-provided labels, in key/value pairs.
"a_key": "A String", # An individual label entry.
},
"lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information.
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
"storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
"type": "A String", # Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.
},
"condition": { # The condition(s) under which the action will be taken.
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
"customTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
"daysSinceCustomTime": 42, # Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
"daysSinceNoncurrentTime": 42, # Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
"matchesPattern": "A String", # A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
"matchesPrefix": [ # List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
"A String",
],
"matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
"A String",
],
"matchesSuffix": [ # List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
"A String",
],
"noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
"numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
},
},
],
},
"location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
"locationType": "A String", # The type of the bucket location.
"logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
"logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
"logObjectPrefix": "A String", # A prefix for log object names.
},
"metageneration": "A String", # The metadata generation of this bucket.
"name": "A String", # The name of the bucket.
"objectRetention": { # The bucket's object retention config.
"mode": "A String", # The bucket's object retention mode. Can be Enabled.
},
"owner": { # The owner of the bucket. This is always the project team's owner group.
"entity": "A String", # The entity, in the form project-owner-projectId.
"entityId": "A String", # The ID for the entity.
},
"projectNumber": "A String", # The project number of the project the bucket belongs to.
"retentionPolicy": { # The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
"effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
"isLocked": True or False, # Once locked, an object retention policy cannot be modified.
"retentionPeriod": "A String", # The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.
},
"rpo": "A String", # The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
"satisfiesPZS": True or False, # Reserved for future use.
"selfLink": "A String", # The URI of this bucket.
"softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.
"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
"retentionDurationSeconds": "A String", # The period of time in seconds, that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.
},
"storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
},
"website": { # The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
"mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
"notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, prefix=None, projection=None, userProject=None)</code>
<pre>Retrieves a list of buckets for a given project.
Args:
project: string, A valid API project identifier. (required)
maxResults: integer, Maximum number of buckets to return in a single response. 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 buckets whose names begin with this prefix.
projection: string, Set of properties to return. Defaults to noAcl.
Allowed values
full - Include all properties.
noAcl - Omit owner, acl and defaultObjectAcl properties.
userProject: string, The project to be billed for this request.
Returns:
An object of the form:
{ # A list of buckets.
"items": [ # The list of items.
{ # A bucket.
"acl": [ # Access controls on the bucket.
{ # 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.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
"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.
},
],
"autoclass": { # The bucket's Autoclass configuration.
"enabled": True or False, # Whether or not Autoclass is enabled on this bucket
"terminalStorageClass": "A String", # The storage class that objects in the bucket eventually transition to if they are not read for a certain length of time. Valid values are NEARLINE and ARCHIVE.
"terminalStorageClassUpdateTime": "A String", # A date and time in RFC 3339 format representing the time of the most recent update to "terminalStorageClass".
"toggleTime": "A String", # A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.
},
"billing": { # The bucket's billing configuration.
"requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket.
},
"cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
{
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
"method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
"A String",
],
"origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
"A String",
],
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
},
],
"customPlacementConfig": { # The bucket's custom placement configuration for Custom Dual Regions.
"dataLocations": [ # The list of regional locations in which data is placed.
"A String",
],
},
"defaultEventBasedHold": True or False, # The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, 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 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. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
"defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
{ # 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.
},
],
"encryption": { # Encryption configuration for a bucket.
"defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.
},
"etag": "A String", # HTTP 1.1 Entity tag for the bucket.
"iamConfiguration": { # The bucket's IAM configuration.
"bucketPolicyOnly": { # The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
"enabled": True or False, # If set, access is controlled only by bucket-level or above IAM policies.
"lockedTime": "A String", # The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.
},
"publicAccessPrevention": "A String", # The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
"uniformBucketLevelAccess": { # The bucket's uniform bucket-level access configuration.
"enabled": True or False, # If set, access is controlled only by bucket-level or above IAM policies.
"lockedTime": "A String", # The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.
},
},
"id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same.
"kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
"labels": { # User-provided labels, in key/value pairs.
"a_key": "A String", # An individual label entry.
},
"lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information.
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
"storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
"type": "A String", # Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.
},
"condition": { # The condition(s) under which the action will be taken.
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
"customTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
"daysSinceCustomTime": 42, # Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
"daysSinceNoncurrentTime": 42, # Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
"matchesPattern": "A String", # A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
"matchesPrefix": [ # List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
"A String",
],
"matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
"A String",
],
"matchesSuffix": [ # List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
"A String",
],
"noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
"numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
},
},
],
},
"location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
"locationType": "A String", # The type of the bucket location.
"logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
"logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
"logObjectPrefix": "A String", # A prefix for log object names.
},
"metageneration": "A String", # The metadata generation of this bucket.
"name": "A String", # The name of the bucket.
"objectRetention": { # The bucket's object retention config.
"mode": "A String", # The bucket's object retention mode. Can be Enabled.
},
"owner": { # The owner of the bucket. This is always the project team's owner group.
"entity": "A String", # The entity, in the form project-owner-projectId.
"entityId": "A String", # The ID for the entity.
},
"projectNumber": "A String", # The project number of the project the bucket belongs to.
"retentionPolicy": { # The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
"effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
"isLocked": True or False, # Once locked, an object retention policy cannot be modified.
"retentionPeriod": "A String", # The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.
},
"rpo": "A String", # The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
"satisfiesPZS": True or False, # Reserved for future use.
"selfLink": "A String", # The URI of this bucket.
"softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.
"effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
"retentionDurationSeconds": "A String", # The period of time in seconds, that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.
},
"storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
"timeCreated": "A String", # The creation time of the bucket in RFC 3339 format.
"updated": "A String", # The modification time of the bucket in RFC 3339 format.
"versioning": { # The bucket's versioning configuration.
"enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
},
"website": { # The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
"mainPageSuffix": "A String", # If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
"notFoundPage": "A String", # If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
},
},
],
"kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets.
"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="lockRetentionPolicy">lockRetentionPolicy(bucket, ifMetagenerationMatch, userProject=None)</code>
<pre>Locks retention policy on a bucket.
Args: