-
Notifications
You must be signed in to change notification settings - Fork 444
/
Copy pathstorage-v1.json
5811 lines (5811 loc) · 306 KB
/
storage-v1.json
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
{
"kind": "discovery#restDescription",
"version": "v1",
"id": "storage:v1",
"rootUrl": "https://storage.googleapis.com/",
"mtlsRootUrl": "https://storage.mtls.googleapis.com/",
"baseUrl": "https://storage.googleapis.com/storage/v1/",
"basePath": "/storage/v1/",
"servicePath": "storage/v1/",
"batchPath": "batch/storage/v1",
"discoveryVersion": "v1",
"name": "storage",
"title": "Cloud Storage JSON API",
"description": "Stores and retrieves potentially large, immutable data objects.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "https://www.google.com/images/icons/product/cloud_storage-16.png",
"x32": "https://www.google.com/images/icons/product/cloud_storage-32.png"
},
"documentationLink": "https://developers.google.com/storage/docs/json_api/",
"labels": [
"labs"
],
"endpoints": [
{
"endpointUrl": "https://storage.me-central2.rep.googleapis.com/",
"location": "me-central2",
"description": "Regional Endpoint"
}
],
"protocol": "rest",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
},
"uploadType": {
"type": "string",
"description": "Upload protocol for media (e.g. \"media\", \"multipart\", \"resumable\").",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/devstorage.full_control": {
"description": "Manage your data and permissions in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_only": {
"description": "View your data in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_write": {
"description": "Manage your data in Google Cloud Storage"
}
}
}
},
"schemas": {
"Bucket": {
"id": "Bucket",
"type": "object",
"description": "A bucket.",
"properties": {
"acl": {
"type": "array",
"description": "Access controls on the bucket.",
"items": {
"$ref": "BucketAccessControl"
},
"annotations": {
"required": [
"storage.buckets.update"
]
}
},
"billing": {
"type": "object",
"description": "The bucket's billing configuration.",
"properties": {
"requesterPays": {
"type": "boolean",
"description": "When set to true, Requester Pays is enabled for this bucket."
}
}
},
"cors": {
"type": "array",
"description": "The bucket's Cross-Origin Resource Sharing (CORS) configuration.",
"items": {
"type": "object",
"properties": {
"maxAgeSeconds": {
"type": "integer",
"description": "The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.",
"format": "int32"
},
"method": {
"type": "array",
"description": "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\".",
"items": {
"type": "string"
}
},
"origin": {
"type": "array",
"description": "The list of Origins eligible to receive CORS response headers. Note: \"*\" is permitted in the list of origins, and means \"any Origin\".",
"items": {
"type": "string"
}
},
"responseHeader": {
"type": "array",
"description": "The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.",
"items": {
"type": "string"
}
}
}
}
},
"customPlacementConfig": {
"type": "object",
"description": "The bucket's custom placement configuration for Custom Dual Regions.",
"properties": {
"dataLocations": {
"type": "array",
"description": "The list of regional locations in which data is placed.",
"items": {
"type": "string"
}
}
}
},
"defaultEventBasedHold": {
"type": "boolean",
"description": "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": {
"type": "array",
"description": "Default access controls to apply to new objects when no ACL is provided.",
"items": {
"$ref": "ObjectAccessControl"
}
},
"encryption": {
"type": "object",
"description": "Encryption configuration for a bucket.",
"properties": {
"defaultKmsKeyName": {
"type": "string",
"description": "A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified."
}
}
},
"etag": {
"type": "string",
"description": "HTTP 1.1 Entity tag for the bucket."
},
"hierarchicalNamespace": {
"type": "object",
"description": "The bucket's hierarchical namespace configuration.",
"properties": {
"enabled": {
"type": "boolean",
"description": "When set to true, hierarchical namespace is enabled for this bucket."
}
}
},
"iamConfiguration": {
"type": "object",
"description": "The bucket's IAM configuration.",
"properties": {
"bucketPolicyOnly": {
"type": "object",
"description": "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.",
"properties": {
"enabled": {
"type": "boolean",
"description": "If set, access is controlled only by bucket-level or above IAM policies."
},
"lockedTime": {
"type": "string",
"description": "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.",
"format": "date-time"
}
}
},
"uniformBucketLevelAccess": {
"type": "object",
"description": "The bucket's uniform bucket-level access configuration.",
"properties": {
"enabled": {
"type": "boolean",
"description": "If set, access is controlled only by bucket-level or above IAM policies."
},
"lockedTime": {
"type": "string",
"description": "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.",
"format": "date-time"
}
}
},
"publicAccessPrevention": {
"type": "string",
"description": "The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported."
}
}
},
"id": {
"type": "string",
"description": "The ID of the bucket. For buckets, the id and name properties are the same."
},
"kind": {
"type": "string",
"description": "The kind of item this is. For buckets, this is always storage#bucket.",
"default": "storage#bucket"
},
"labels": {
"type": "object",
"description": "User-provided labels, in key/value pairs.",
"additionalProperties": {
"type": "string",
"description": "An individual label entry."
}
},
"lifecycle": {
"type": "object",
"description": "The bucket's lifecycle configuration. See lifecycle management for more information.",
"properties": {
"rule": {
"type": "array",
"description": "A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.",
"items": {
"type": "object",
"properties": {
"action": {
"type": "object",
"description": "The action to take.",
"properties": {
"storageClass": {
"type": "string",
"description": "Target storage class. Required iff the type of the action is SetStorageClass."
},
"type": {
"type": "string",
"description": "Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported."
}
}
},
"condition": {
"type": "object",
"description": "The condition(s) under which the action will be taken.",
"properties": {
"age": {
"type": "integer",
"description": "Age of an object (in days). This condition is satisfied when an object reaches the specified age.",
"format": "int32"
},
"createdBefore": {
"type": "string",
"description": "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.",
"format": "date"
},
"customTimeBefore": {
"type": "string",
"description": "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.",
"format": "date"
},
"daysSinceCustomTime": {
"type": "integer",
"description": "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.",
"format": "int32"
},
"daysSinceNoncurrentTime": {
"type": "integer",
"description": "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.",
"format": "int32"
},
"isLive": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "array",
"description": "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.",
"items": {
"type": "string"
}
},
"matchesSuffix": {
"type": "array",
"description": "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.",
"items": {
"type": "string"
}
},
"matchesStorageClass": {
"type": "array",
"description": "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.",
"items": {
"type": "string"
}
},
"noncurrentTimeBefore": {
"type": "string",
"description": "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.",
"format": "date"
},
"numNewerVersions": {
"type": "integer",
"description": "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.",
"format": "int32"
}
}
}
}
}
}
}
},
"autoclass": {
"type": "object",
"description": "The bucket's Autoclass configuration.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not Autoclass is enabled on this bucket"
},
"toggleTime": {
"type": "string",
"description": "A date and time in RFC 3339 format representing the instant at which \"enabled\" was last toggled.",
"format": "date-time"
},
"terminalStorageClass": {
"type": "string",
"description": "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": {
"type": "string",
"description": "A date and time in RFC 3339 format representing the time of the most recent update to \"terminalStorageClass\".",
"format": "date-time"
}
}
},
"location": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The type of the bucket location."
},
"logging": {
"type": "object",
"description": "The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.",
"properties": {
"logBucket": {
"type": "string",
"description": "The destination bucket where the current bucket's logs should be placed."
},
"logObjectPrefix": {
"type": "string",
"description": "A prefix for log object names."
}
}
},
"metageneration": {
"type": "string",
"description": "The metadata generation of this bucket.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The name of the bucket.",
"annotations": {
"required": [
"storage.buckets.insert"
]
}
},
"generation": {
"type": "string",
"description": "The version of the bucket.",
"format": "int64"
},
"owner": {
"type": "object",
"description": "The owner of the bucket. This is always the project team's owner group.",
"properties": {
"entity": {
"type": "string",
"description": "The entity, in the form project-owner-projectId."
},
"entityId": {
"type": "string",
"description": "The ID for the entity."
}
}
},
"projectNumber": {
"type": "string",
"description": "The project number of the project the bucket belongs to.",
"format": "uint64"
},
"retentionPolicy": {
"type": "object",
"description": "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.",
"properties": {
"effectiveTime": {
"type": "string",
"description": "Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.",
"format": "date-time"
},
"isLocked": {
"type": "boolean",
"description": "Once locked, an object retention policy cannot be modified."
},
"retentionPeriod": {
"type": "string",
"description": "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.",
"format": "int64"
}
}
},
"objectRetention": {
"type": "object",
"description": "The bucket's object retention config.",
"properties": {
"mode": {
"type": "string",
"description": "The bucket's object retention mode. Can be Enabled."
}
}
},
"rpo": {
"type": "string",
"description": "The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket."
},
"selfLink": {
"type": "string",
"description": "The URI of this bucket."
},
"softDeletePolicy": {
"type": "object",
"description": "The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.",
"properties": {
"retentionDurationSeconds": {
"type": "string",
"description": "The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.",
"format": "int64"
},
"effectiveTime": {
"type": "string",
"description": "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.",
"format": "date-time"
}
}
},
"softDeleteTime": {
"type": "string",
"description": "The time at which the bucket was soft-deleted.",
"format": "date-time"
},
"hardDeleteTime": {
"type": "string",
"description": "The time when a soft-deleted bucket is permanently deleted and can no longer be restored.",
"format": "date-time"
},
"storageClass": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The creation time of the bucket in RFC 3339 format.",
"format": "date-time"
},
"updated": {
"type": "string",
"description": "The modification time of the bucket in RFC 3339 format.",
"format": "date-time"
},
"versioning": {
"type": "object",
"description": "The bucket's versioning configuration.",
"properties": {
"enabled": {
"type": "boolean",
"description": "While set to true, versioning is fully enabled for this bucket."
}
}
},
"website": {
"type": "object",
"description": "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.",
"properties": {
"mainPageSuffix": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
}
}
},
"satisfiesPZS": {
"type": "boolean",
"description": "Reserved for future use."
}
}
},
"AnywhereCache": {
"id": "AnywhereCache",
"type": "object",
"description": "An Anywhere Cache instance.",
"properties": {
"kind": {
"type": "string",
"description": "The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.",
"default": "storage#anywhereCache"
},
"id": {
"type": "string",
"description": "The ID of the resource, including the project number, bucket name and anywhere cache ID."
},
"selfLink": {
"type": "string",
"description": "The link to this cache instance."
},
"bucket": {
"type": "string",
"description": "The name of the bucket containing this cache instance."
},
"anywhereCacheId": {
"type": "string",
"description": "The ID of the Anywhere cache instance."
},
"zone": {
"type": "string",
"description": "The zone in which the cache instance is running. For example, us-central1-a."
},
"state": {
"type": "string",
"description": "The current state of the cache instance."
},
"createTime": {
"type": "string",
"description": "The creation time of the cache instance in RFC 3339 format.",
"format": "date-time"
},
"updateTime": {
"type": "string",
"description": "The modification time of the cache instance metadata in RFC 3339 format.",
"format": "date-time"
},
"ttl": {
"type": "string",
"description": "The TTL of all cache entries in whole seconds. e.g., \"7200s\". ",
"format": "google-duration"
},
"admissionPolicy": {
"type": "string",
"description": "The cache-level entry admission policy."
},
"pendingUpdate": {
"type": "boolean",
"description": "True if the cache instance has an active Update long-running operation."
}
}
},
"AnywhereCaches": {
"id": "AnywhereCaches",
"type": "object",
"description": "A list of Anywhere Caches.",
"properties": {
"kind": {
"type": "string",
"description": "The kind of item this is. For lists of Anywhere Caches, this is always storage#anywhereCaches.",
"default": "storage#anywhereCaches"
},
"nextPageToken": {
"type": "string",
"description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
},
"items": {
"type": "array",
"description": "The list of items.",
"items": {
"$ref": "AnywhereCache"
}
}
}
},
"BucketAccessControl": {
"id": "BucketAccessControl",
"type": "object",
"description": "An access-control entry.",
"properties": {
"bucket": {
"type": "string",
"description": "The name of the bucket."
},
"domain": {
"type": "string",
"description": "The domain associated with the entity, if any."
},
"email": {
"type": "string",
"description": "The email address associated with the entity, if any."
},
"entity": {
"type": "string",
"description": "The entity holding the permission, in one of the following forms: \n- user-userId \n- user-email \n- group-groupId \n- group-email \n- domain-domain \n- project-team-projectId \n- allUsers \n- allAuthenticatedUsers Examples: \n- The user [email protected] would be [email protected]. \n- The group [email protected] would be [email protected]. \n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.",
"annotations": {
"required": [
"storage.bucketAccessControls.insert"
]
}
},
"entityId": {
"type": "string",
"description": "The ID for the entity, if any."
},
"etag": {
"type": "string",
"description": "HTTP 1.1 Entity tag for the access-control entry."
},
"id": {
"type": "string",
"description": "The ID of the access-control entry."
},
"kind": {
"type": "string",
"description": "The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.",
"default": "storage#bucketAccessControl"
},
"projectTeam": {
"type": "object",
"description": "The project team associated with the entity, if any.",
"properties": {
"projectNumber": {
"type": "string",
"description": "The project number."
},
"team": {
"type": "string",
"description": "The team."
}
}
},
"role": {
"type": "string",
"description": "The access permission for the entity.",
"annotations": {
"required": [
"storage.bucketAccessControls.insert"
]
}
},
"selfLink": {
"type": "string",
"description": "The link to this access-control entry."
}
}
},
"BucketAccessControls": {
"id": "BucketAccessControls",
"type": "object",
"description": "An access-control list.",
"properties": {
"items": {
"type": "array",
"description": "The list of items.",
"items": {
"$ref": "BucketAccessControl"
}
},
"kind": {
"type": "string",
"description": "The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.",
"default": "storage#bucketAccessControls"
}
}
},
"Buckets": {
"id": "Buckets",
"type": "object",
"description": "A list of buckets.",
"properties": {
"items": {
"type": "array",
"description": "The list of items.",
"items": {
"$ref": "Bucket"
}
},
"kind": {
"type": "string",
"description": "The kind of item this is. For lists of buckets, this is always storage#buckets.",
"default": "storage#buckets"
},
"nextPageToken": {
"type": "string",
"description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
}
}
},
"Channel": {
"id": "Channel",
"type": "object",
"description": "An notification channel used to watch for resource changes.",
"properties": {
"address": {
"type": "string",
"description": "The address where notifications are delivered for this channel."
},
"expiration": {
"type": "string",
"description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
"format": "int64"
},
"id": {
"type": "string",
"description": "A UUID or similar unique string that identifies this channel."
},
"kind": {
"type": "string",
"description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".",
"default": "api#channel"
},
"params": {
"type": "object",
"description": "Additional parameters controlling delivery channel behavior. Optional.",
"additionalProperties": {
"type": "string",
"description": "Declares a new parameter by name."
}
},
"payload": {
"type": "boolean",
"description": "A Boolean value to indicate whether payload is wanted. Optional."
},
"resourceId": {
"type": "string",
"description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
},
"resourceUri": {
"type": "string",
"description": "A version-specific identifier for the watched resource."
},
"token": {
"type": "string",
"description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
},
"type": {
"type": "string",
"description": "The type of delivery mechanism used for this channel."
}
}
},
"ComposeRequest": {
"id": "ComposeRequest",
"type": "object",
"description": "A Compose request.",
"properties": {
"destination": {
"$ref": "Object",
"description": "Properties of the resulting object."
},
"kind": {
"type": "string",
"description": "The kind of item this is.",
"default": "storage#composeRequest"
},
"sourceObjects": {
"type": "array",
"description": "The list of source objects that will be concatenated into a single object.",
"items": {
"type": "object",
"properties": {
"generation": {
"type": "string",
"description": "The generation of this object to use as the source.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The source object's name. All source objects must reside in the same bucket.",
"annotations": {
"required": [
"storage.objects.compose"
]
}
},
"objectPreconditions": {
"type": "object",
"description": "Conditions that must be met for this operation to execute.",
"properties": {
"ifGenerationMatch": {
"type": "string",
"description": "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.",
"format": "int64"
}
}
}
}
},
"annotations": {
"required": [
"storage.objects.compose"
]
}
}
}
},
"Folder": {
"id": "Folder",
"type": "object",
"description": "A folder. Only available in buckets with hierarchical namespace enabled.",
"properties": {
"bucket": {
"type": "string",
"description": "The name of the bucket containing this folder."
},
"id": {
"type": "string",
"description": "The ID of the folder, including the bucket name, folder name."
},
"kind": {
"type": "string",
"description": "The kind of item this is. For folders, this is always storage#folder.",
"default": "storage#folder"
},
"metageneration": {
"type": "string",
"description": "The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The name of the folder. Required if not specified by URL parameter."
},
"selfLink": {
"type": "string",
"description": "The link to this folder."
},
"createTime": {
"type": "string",
"description": "The creation time of the folder in RFC 3339 format.",
"format": "date-time"
},
"updateTime": {
"type": "string",
"description": "The modification time of the folder metadata in RFC 3339 format.",
"format": "date-time"
},
"pendingRenameInfo": {
"type": "object",
"description": "Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.",
"properties": {
"operationId": {
"type": "string",
"description": "The ID of the rename folder operation."
}
}
}
}
},
"Folders": {
"id": "Folders",
"type": "object",
"description": "A list of folders.",
"properties": {
"items": {
"type": "array",
"description": "The list of items.",
"items": {
"$ref": "Folder"
}
},
"kind": {
"type": "string",
"description": "The kind of item this is. For lists of folders, this is always storage#folders.",
"default": "storage#folders"
},
"nextPageToken": {
"type": "string",
"description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
}
}
},
"Expr": {
"id": "Expr",
"type": "object",
"description": "Represents an expression text. Example: title: \"User account presence\" description: \"Determines whether the request has a user account\" expression: \"size(request.user) > 0\"",
"properties": {
"description": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file."
},
"title": {
"type": "string",
"description": "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."
}
}
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"done": {
"description": "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.",
"type": "boolean"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "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.",
"type": "object"
},
"name": {
"description": "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}\".",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "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\".",
"type": "object"
}
},
"type": "object"
},