Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(230)

Side by Side Diff: gslib/third_party/storage_apitools/storage_v1_messages.py

Issue 698893003: Update checked in version of gsutil to version 4.6 (Closed) Base URL: http://dart.googlecode.com/svn/third_party/gsutil/
Patch Set: Created 6 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
Property Changes:
Added: svn:eol-style
+ LF
OLDNEW
(Empty)
1 # Copyright 2014 Google Inc. All Rights Reserved.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 """Generated message classes for storage version v1.
15
16 Lets you store and retrieve potentially-large, immutable data objects.
17 """
18
19 from gslib.third_party.protorpc import message_types
20 from gslib.third_party.protorpc import messages
21
22 from gslib.third_party.storage_apitools import encoding
23
24
25 package = 'storage'
26
27
28 class Bucket(messages.Message):
29 """A bucket.
30
31 Messages:
32 CorsValueListEntry: A CorsValueListEntry object.
33 LifecycleValue: The bucket's lifecycle configuration. See lifecycle
34 management for more information.
35 LoggingValue: The bucket's logging configuration, which defines the
36 destination bucket and optional name prefix for the current bucket's
37 logs.
38 OwnerValue: The owner of the bucket. This is always the project team's
39 owner group.
40 VersioningValue: The bucket's versioning configuration.
41 WebsiteValue: The bucket's website configuration.
42
43 Fields:
44 acl: Access controls on the bucket.
45 cors: The bucket's Cross-Origin Resource Sharing (CORS) configuration.
46 defaultObjectAcl: Default access controls to apply to new objects when no
47 ACL is provided.
48 etag: HTTP 1.1 Entity tag for the bucket.
49 id: The ID of the bucket.
50 kind: The kind of item this is. For buckets, this is always
51 storage#bucket.
52 lifecycle: The bucket's lifecycle configuration. See lifecycle management
53 for more information.
54 location: The location of the bucket. Object data for objects in the
55 bucket resides in physical storage within this region. Defaults to US.
56 See the developer's guide for the authoritative list.
57 logging: The bucket's logging configuration, which defines the destination
58 bucket and optional name prefix for the current bucket's logs.
59 metageneration: The metadata generation of this bucket.
60 name: The name of the bucket.
61 owner: The owner of the bucket. This is always the project team's owner
62 group.
63 projectNumber: The project number of the project the bucket belongs to.
64 selfLink: The URI of this bucket.
65 storageClass: The bucket's storage class. This defines how objects in the
66 bucket are stored and determines the SLA and the cost of storage.
67 Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults
68 to STANDARD. See the developer's guide for the authoritative list.
69 timeCreated: Creation time of the bucket in RFC 3339 format.
70 versioning: The bucket's versioning configuration.
71 website: The bucket's website configuration.
72 """
73
74 class CorsValueListEntry(messages.Message):
75 """A CorsValueListEntry object.
76
77 Fields:
78 maxAgeSeconds: The value, in seconds, to return in the Access-Control-
79 Max-Age header used in preflight responses.
80 method: The list of HTTP methods on which to include CORS response
81 headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list
82 of methods, and means "any method".
83 origin: The list of Origins eligible to receive CORS response headers.
84 Note: "*" is permitted in the list of origins, and means "any Origin".
85 responseHeader: The list of HTTP headers other than the simple response
86 headers to give permission for the user-agent to share across domains.
87 """
88
89 maxAgeSeconds = messages.IntegerField(1, variant=messages.Variant.INT32)
90 method = messages.StringField(2, repeated=True)
91 origin = messages.StringField(3, repeated=True)
92 responseHeader = messages.StringField(4, repeated=True)
93
94 class LifecycleValue(messages.Message):
95 """The bucket's lifecycle configuration. See lifecycle management for more
96 information.
97
98 Messages:
99 RuleValueListEntry: A RuleValueListEntry object.
100
101 Fields:
102 rule: A lifecycle management rule, which is made of an action to take
103 and the condition(s) under which the action will be taken.
104 """
105
106 class RuleValueListEntry(messages.Message):
107 """A RuleValueListEntry object.
108
109 Messages:
110 ActionValue: The action to take.
111 ConditionValue: The condition(s) under which the action will be taken.
112
113 Fields:
114 action: The action to take.
115 condition: The condition(s) under which the action will be taken.
116 """
117
118 class ActionValue(messages.Message):
119 """The action to take.
120
121 Fields:
122 type: Type of the action. Currently, only Delete is supported.
123 """
124
125 type = messages.StringField(1)
126
127 class ConditionValue(messages.Message):
128 """The condition(s) under which the action will be taken.
129
130 Fields:
131 age: Age of an object (in days). This condition is satisfied when an
132 object reaches the specified age.
133 createdBefore: A date in RFC 3339 format with only the date part
134 (for instance, "2013-01-15"). This condition is satisfied when an
135 object is created before midnight of the specified date in UTC.
136 isLive: Relevant only for versioned objects. If the value is true,
137 this condition matches live objects; if the value is false, it
138 matches archived objects.
139 numNewerVersions: Relevant only for versioned objects. If the value
140 is N, this condition is satisfied when there are at least N
141 versions (including the live version) newer than this version of
142 the object.
143 """
144
145 age = messages.IntegerField(1, variant=messages.Variant.INT32)
146 createdBefore = message_types.DateTimeField(2)
147 isLive = messages.BooleanField(3)
148 numNewerVersions = messages.IntegerField(4, variant=messages.Variant.INT 32)
149
150 action = messages.MessageField('ActionValue', 1)
151 condition = messages.MessageField('ConditionValue', 2)
152
153 rule = messages.MessageField('RuleValueListEntry', 1, repeated=True)
154
155 class LoggingValue(messages.Message):
156 """The bucket's logging configuration, which defines the destination
157 bucket and optional name prefix for the current bucket's logs.
158
159 Fields:
160 logBucket: The destination bucket where the current bucket's logs should
161 be placed.
162 logObjectPrefix: A prefix for log object names.
163 """
164
165 logBucket = messages.StringField(1)
166 logObjectPrefix = messages.StringField(2)
167
168 class OwnerValue(messages.Message):
169 """The owner of the bucket. This is always the project team's owner group.
170
171 Fields:
172 entity: The entity, in the form project-owner-projectId.
173 entityId: The ID for the entity.
174 """
175
176 entity = messages.StringField(1)
177 entityId = messages.StringField(2)
178
179 class VersioningValue(messages.Message):
180 """The bucket's versioning configuration.
181
182 Fields:
183 enabled: While set to true, versioning is fully enabled for this bucket.
184 """
185
186 enabled = messages.BooleanField(1)
187
188 class WebsiteValue(messages.Message):
189 """The bucket's website configuration.
190
191 Fields:
192 mainPageSuffix: Behaves as the bucket's directory index where missing
193 objects are treated as potential directories.
194 notFoundPage: The custom object to return when a requested resource is
195 not found.
196 """
197
198 mainPageSuffix = messages.StringField(1)
199 notFoundPage = messages.StringField(2)
200
201 acl = messages.MessageField('BucketAccessControl', 1, repeated=True)
202 cors = messages.MessageField('CorsValueListEntry', 2, repeated=True)
203 defaultObjectAcl = messages.MessageField('ObjectAccessControl', 3, repeated=Tr ue)
204 etag = messages.StringField(4)
205 id = messages.StringField(5)
206 kind = messages.StringField(6, default=u'storage#bucket')
207 lifecycle = messages.MessageField('LifecycleValue', 7)
208 location = messages.StringField(8)
209 logging = messages.MessageField('LoggingValue', 9)
210 metageneration = messages.IntegerField(10)
211 name = messages.StringField(11)
212 owner = messages.MessageField('OwnerValue', 12)
213 projectNumber = messages.IntegerField(13, variant=messages.Variant.UINT64)
214 selfLink = messages.StringField(14)
215 storageClass = messages.StringField(15)
216 timeCreated = message_types.DateTimeField(16)
217 versioning = messages.MessageField('VersioningValue', 17)
218 website = messages.MessageField('WebsiteValue', 18)
219
220
221 class BucketAccessControl(messages.Message):
222 """An access-control entry.
223
224 Messages:
225 ProjectTeamValue: The project team associated with the entity, if any.
226
227 Fields:
228 bucket: The name of the bucket.
229 domain: The domain associated with the entity, if any.
230 email: The email address associated with the entity, if any.
231 entity: The entity holding the permission, in one of the following forms:
232 - user-userId - user-email - group-groupId - group-email - domain-
233 domain - project-team-projectId - allUsers - allAuthenticatedUsers
234 Examples: - The user liz@example.com would be user-liz@example.com. -
235 The group example@googlegroups.com would be group-
236 example@googlegroups.com. - To refer to all members of the Google Apps
237 for Business domain example.com, the entity would be domain-example.com.
238 entityId: The ID for the entity, if any.
239 etag: HTTP 1.1 Entity tag for the access-control entry.
240 id: The ID of the access-control entry.
241 kind: The kind of item this is. For bucket access control entries, this is
242 always storage#bucketAccessControl.
243 projectTeam: The project team associated with the entity, if any.
244 role: The access permission for the entity. Can be READER, WRITER, or
245 OWNER.
246 selfLink: The link to this access-control entry.
247 """
248
249 class ProjectTeamValue(messages.Message):
250 """The project team associated with the entity, if any.
251
252 Fields:
253 projectNumber: The project number.
254 team: The team. Can be owners, editors, or viewers.
255 """
256
257 projectNumber = messages.StringField(1)
258 team = messages.StringField(2)
259
260 bucket = messages.StringField(1)
261 domain = messages.StringField(2)
262 email = messages.StringField(3)
263 entity = messages.StringField(4)
264 entityId = messages.StringField(5)
265 etag = messages.StringField(6)
266 id = messages.StringField(7)
267 kind = messages.StringField(8, default=u'storage#bucketAccessControl')
268 projectTeam = messages.MessageField('ProjectTeamValue', 9)
269 role = messages.StringField(10)
270 selfLink = messages.StringField(11)
271
272
273 class BucketAccessControls(messages.Message):
274 """An access-control list.
275
276 Fields:
277 items: The list of items.
278 kind: The kind of item this is. For lists of bucket access control
279 entries, this is always storage#bucketAccessControls.
280 """
281
282 items = messages.MessageField('BucketAccessControl', 1, repeated=True)
283 kind = messages.StringField(2, default=u'storage#bucketAccessControls')
284
285
286 class Buckets(messages.Message):
287 """A list of buckets.
288
289 Fields:
290 items: The list of items.
291 kind: The kind of item this is. For lists of buckets, this is always
292 storage#buckets.
293 nextPageToken: The continuation token, used to page through large result
294 sets. Provide this value in a subsequent request to return the next page
295 of results.
296 """
297
298 items = messages.MessageField('Bucket', 1, repeated=True)
299 kind = messages.StringField(2, default=u'storage#buckets')
300 nextPageToken = messages.StringField(3)
301
302
303 class Channel(messages.Message):
304 """An notification channel used to watch for resource changes.
305
306 Messages:
307 ParamsValue: Additional parameters controlling delivery channel behavior.
308 Optional.
309
310 Fields:
311 address: The address where notifications are delivered for this channel.
312 expiration: Date and time of notification channel expiration, expressed as
313 a Unix timestamp, in milliseconds. Optional.
314 id: A UUID or similar unique string that identifies this channel.
315 kind: Identifies this as a notification channel used to watch for changes
316 to a resource. Value: the fixed string "api#channel".
317 params: Additional parameters controlling delivery channel behavior.
318 Optional.
319 payload: A Boolean value to indicate whether payload is wanted. Optional.
320 resourceId: An opaque ID that identifies the resource being watched on
321 this channel. Stable across different API versions.
322 resourceUri: A version-specific identifier for the watched resource.
323 token: An arbitrary string delivered to the target address with each
324 notification delivered over this channel. Optional.
325 type: The type of delivery mechanism used for this channel.
326 """
327
328 @encoding.MapUnrecognizedFields('additionalProperties')
329 class ParamsValue(messages.Message):
330 """Additional parameters controlling delivery channel behavior. Optional.
331
332 Messages:
333 AdditionalProperty: An additional property for a ParamsValue object.
334
335 Fields:
336 additionalProperties: Declares a new parameter by name.
337 """
338
339 class AdditionalProperty(messages.Message):
340 """An additional property for a ParamsValue object.
341
342 Fields:
343 key: Name of the additional property.
344 value: A string attribute.
345 """
346
347 key = messages.StringField(1)
348 value = messages.StringField(2)
349
350 additionalProperties = messages.MessageField('AdditionalProperty', 1, repeat ed=True)
351
352 address = messages.StringField(1)
353 expiration = messages.IntegerField(2)
354 id = messages.StringField(3)
355 kind = messages.StringField(4, default=u'api#channel')
356 params = messages.MessageField('ParamsValue', 5)
357 payload = messages.BooleanField(6)
358 resourceId = messages.StringField(7)
359 resourceUri = messages.StringField(8)
360 token = messages.StringField(9)
361 type = messages.StringField(10)
362
363
364 class ComposeRequest(messages.Message):
365 """A Compose request.
366
367 Messages:
368 SourceObjectsValueListEntry: A SourceObjectsValueListEntry object.
369
370 Fields:
371 destination: Properties of the resulting object.
372 kind: The kind of item this is.
373 sourceObjects: The list of source objects that will be concatenated into a
374 single object.
375 """
376
377 class SourceObjectsValueListEntry(messages.Message):
378 """A SourceObjectsValueListEntry object.
379
380 Messages:
381 ObjectPreconditionsValue: Conditions that must be met for this operation
382 to execute.
383
384 Fields:
385 generation: The generation of this object to use as the source.
386 name: The source object's name. The source object's bucket is implicitly
387 the destination bucket.
388 objectPreconditions: Conditions that must be met for this operation to
389 execute.
390 """
391
392 class ObjectPreconditionsValue(messages.Message):
393 """Conditions that must be met for this operation to execute.
394
395 Fields:
396 ifGenerationMatch: Only perform the composition if the generation of
397 the source object that would be used matches this value. If this
398 value and a generation are both specified, they must be the same
399 value or the call will fail.
400 """
401
402 ifGenerationMatch = messages.IntegerField(1)
403
404 generation = messages.IntegerField(1)
405 name = messages.StringField(2)
406 objectPreconditions = messages.MessageField('ObjectPreconditionsValue', 3)
407
408 destination = messages.MessageField('Object', 1)
409 kind = messages.StringField(2, default=u'storage#composeRequest')
410 sourceObjects = messages.MessageField('SourceObjectsValueListEntry', 3, repeat ed=True)
411
412
413 class Object(messages.Message):
414 """An object.
415
416 Messages:
417 MetadataValue: User-provided metadata, in key/value pairs.
418 OwnerValue: The owner of the object. This will always be the uploader of
419 the object.
420
421 Fields:
422 acl: Access controls on the object.
423 bucket: The name of the bucket containing this object.
424 cacheControl: Cache-Control directive for the object data.
425 componentCount: Number of underlying components that make up this object.
426 Components are accumulated by compose operations.
427 contentDisposition: Content-Disposition of the object data.
428 contentEncoding: Content-Encoding of the object data.
429 contentLanguage: Content-Language of the object data.
430 contentType: Content-Type of the object data.
431 crc32c: CRC32c checksum, as described in RFC 4960, Appendix B; encoded
432 using base64.
433 etag: HTTP 1.1 Entity tag for the object.
434 generation: The content generation of this object. Used for object
435 versioning.
436 id: The ID of the object.
437 kind: The kind of item this is. For objects, this is always
438 storage#object.
439 md5Hash: MD5 hash of the data; encoded using base64.
440 mediaLink: Media download link.
441 metadata: User-provided metadata, in key/value pairs.
442 metageneration: The version of the metadata for this object at this
443 generation. Used for preconditions and for detecting changes in
444 metadata. A metageneration number is only meaningful in the context of a
445 particular generation of a particular object.
446 name: The name of this object. Required if not specified by URL parameter.
447 owner: The owner of the object. This will always be the uploader of the
448 object.
449 selfLink: The link to this object.
450 size: Content-Length of the data in bytes.
451 storageClass: Storage class of the object.
452 timeDeleted: Deletion time of the object in RFC 3339 format. Will be
453 returned if and only if this version of the object has been deleted.
454 updated: Modification time of the object metadata in RFC 3339 format.
455 """
456
457 @encoding.MapUnrecognizedFields('additionalProperties')
458 class MetadataValue(messages.Message):
459 """User-provided metadata, in key/value pairs.
460
461 Messages:
462 AdditionalProperty: An additional property for a MetadataValue object.
463
464 Fields:
465 additionalProperties: An individual metadata entry.
466 """
467
468 class AdditionalProperty(messages.Message):
469 """An additional property for a MetadataValue object.
470
471 Fields:
472 key: Name of the additional property.
473 value: A string attribute.
474 """
475
476 key = messages.StringField(1)
477 value = messages.StringField(2)
478
479 additionalProperties = messages.MessageField('AdditionalProperty', 1, repeat ed=True)
480
481 class OwnerValue(messages.Message):
482 """The owner of the object. This will always be the uploader of the
483 object.
484
485 Fields:
486 entity: The entity, in the form user-userId.
487 entityId: The ID for the entity.
488 """
489
490 entity = messages.StringField(1)
491 entityId = messages.StringField(2)
492
493 acl = messages.MessageField('ObjectAccessControl', 1, repeated=True)
494 bucket = messages.StringField(2)
495 cacheControl = messages.StringField(3)
496 componentCount = messages.IntegerField(4, variant=messages.Variant.INT32)
497 contentDisposition = messages.StringField(5)
498 contentEncoding = messages.StringField(6)
499 contentLanguage = messages.StringField(7)
500 contentType = messages.StringField(8)
501 crc32c = messages.StringField(9)
502 etag = messages.StringField(10)
503 generation = messages.IntegerField(11)
504 id = messages.StringField(12)
505 kind = messages.StringField(13, default=u'storage#object')
506 md5Hash = messages.StringField(14)
507 mediaLink = messages.StringField(15)
508 metadata = messages.MessageField('MetadataValue', 16)
509 metageneration = messages.IntegerField(17)
510 name = messages.StringField(18)
511 owner = messages.MessageField('OwnerValue', 19)
512 selfLink = messages.StringField(20)
513 size = messages.IntegerField(21, variant=messages.Variant.UINT64)
514 storageClass = messages.StringField(22)
515 timeDeleted = message_types.DateTimeField(23)
516 updated = message_types.DateTimeField(24)
517
518
519 class ObjectAccessControl(messages.Message):
520 """An access-control entry.
521
522 Messages:
523 ProjectTeamValue: The project team associated with the entity, if any.
524
525 Fields:
526 bucket: The name of the bucket.
527 domain: The domain associated with the entity, if any.
528 email: The email address associated with the entity, if any.
529 entity: The entity holding the permission, in one of the following forms:
530 - user-userId - user-email - group-groupId - group-email - domain-
531 domain - project-team-projectId - allUsers - allAuthenticatedUsers
532 Examples: - The user liz@example.com would be user-liz@example.com. -
533 The group example@googlegroups.com would be group-
534 example@googlegroups.com. - To refer to all members of the Google Apps
535 for Business domain example.com, the entity would be domain-example.com.
536 entityId: The ID for the entity, if any.
537 etag: HTTP 1.1 Entity tag for the access-control entry.
538 generation: The content generation of the object.
539 id: The ID of the access-control entry.
540 kind: The kind of item this is. For object access control entries, this is
541 always storage#objectAccessControl.
542 object: The name of the object.
543 projectTeam: The project team associated with the entity, if any.
544 role: The access permission for the entity. Can be READER or OWNER.
545 selfLink: The link to this access-control entry.
546 """
547
548 class ProjectTeamValue(messages.Message):
549 """The project team associated with the entity, if any.
550
551 Fields:
552 projectNumber: The project number.
553 team: The team. Can be owners, editors, or viewers.
554 """
555
556 projectNumber = messages.StringField(1)
557 team = messages.StringField(2)
558
559 bucket = messages.StringField(1)
560 domain = messages.StringField(2)
561 email = messages.StringField(3)
562 entity = messages.StringField(4)
563 entityId = messages.StringField(5)
564 etag = messages.StringField(6)
565 generation = messages.IntegerField(7)
566 id = messages.StringField(8)
567 kind = messages.StringField(9, default=u'storage#objectAccessControl')
568 object = messages.StringField(10)
569 projectTeam = messages.MessageField('ProjectTeamValue', 11)
570 role = messages.StringField(12)
571 selfLink = messages.StringField(13)
572
573
574 class ObjectAccessControls(messages.Message):
575 """An access-control list.
576
577 Fields:
578 items: The list of items.
579 kind: The kind of item this is. For lists of object access control
580 entries, this is always storage#objectAccessControls.
581 """
582
583 items = messages.MessageField('extra_types.JsonValue', 1, repeated=True)
584 kind = messages.StringField(2, default=u'storage#objectAccessControls')
585
586
587 class Objects(messages.Message):
588 """A list of objects.
589
590 Fields:
591 items: The list of items.
592 kind: The kind of item this is. For lists of objects, this is always
593 storage#objects.
594 nextPageToken: The continuation token, used to page through large result
595 sets. Provide this value in a subsequent request to return the next page
596 of results.
597 prefixes: The list of prefixes of objects matching-but-not-listed up to
598 and including the requested delimiter.
599 """
600
601 items = messages.MessageField('Object', 1, repeated=True)
602 kind = messages.StringField(2, default=u'storage#objects')
603 nextPageToken = messages.StringField(3)
604 prefixes = messages.StringField(4, repeated=True)
605
606
607 class StandardQueryParameters(messages.Message):
608 """Query parameters accepted by all methods.
609
610 Enums:
611 AltValueValuesEnum: Data format for the response.
612
613 Fields:
614 alt: Data format for the response.
615 fields: Selector specifying which fields to include in a partial response.
616 key: API key. Your API key identifies your project and provides you with
617 API access, quota, and reports. Required unless you provide an OAuth 2.0
618 token.
619 oauth_token: OAuth 2.0 token for the current user.
620 prettyPrint: Returns response with indentations and line breaks.
621 quotaUser: Available to use for quota purposes for server-side
622 applications. Can be any arbitrary string assigned to a user, but should
623 not exceed 40 characters. Overrides userIp if both are provided.
624 trace: A tracing token of the form "token:<tokenid>" or "email:<ldap>" to
625 include in api requests.
626 userIp: IP address of the site where the request originates. Use this if
627 you want to enforce per-user limits.
628 """
629
630 class AltValueValuesEnum(messages.Enum):
631 """Data format for the response.
632
633 Values:
634 json: Responses with Content-Type of application/json
635 """
636 json = 0
637
638 alt = messages.EnumField('AltValueValuesEnum', 1, default=u'json')
639 fields = messages.StringField(2)
640 key = messages.StringField(3)
641 oauth_token = messages.StringField(4)
642 prettyPrint = messages.BooleanField(5, default=True)
643 quotaUser = messages.StringField(6)
644 trace = messages.StringField(7)
645 userIp = messages.StringField(8)
646
647
648 class StorageBucketAccessControlsDeleteRequest(messages.Message):
649 """A StorageBucketAccessControlsDeleteRequest object.
650
651 Fields:
652 bucket: Name of a bucket.
653 entity: The entity holding the permission. Can be user-userId, user-
654 emailAddress, group-groupId, group-emailAddress, allUsers, or
655 allAuthenticatedUsers.
656 """
657
658 bucket = messages.StringField(1, required=True)
659 entity = messages.StringField(2, required=True)
660
661
662 class StorageBucketAccessControlsDeleteResponse(messages.Message):
663 """An empty StorageBucketAccessControlsDelete response."""
664
665
666 class StorageBucketAccessControlsGetRequest(messages.Message):
667 """A StorageBucketAccessControlsGetRequest object.
668
669 Fields:
670 bucket: Name of a bucket.
671 entity: The entity holding the permission. Can be user-userId, user-
672 emailAddress, group-groupId, group-emailAddress, allUsers, or
673 allAuthenticatedUsers.
674 """
675
676 bucket = messages.StringField(1, required=True)
677 entity = messages.StringField(2, required=True)
678
679
680 class StorageBucketAccessControlsListRequest(messages.Message):
681 """A StorageBucketAccessControlsListRequest object.
682
683 Fields:
684 bucket: Name of a bucket.
685 """
686
687 bucket = messages.StringField(1, required=True)
688
689
690 class StorageBucketsDeleteRequest(messages.Message):
691 """A StorageBucketsDeleteRequest object.
692
693 Fields:
694 bucket: Name of a bucket.
695 ifMetagenerationMatch: If set, only deletes the bucket if its
696 metageneration matches this value.
697 ifMetagenerationNotMatch: If set, only deletes the bucket if its
698 metageneration does not match this value.
699 """
700
701 bucket = messages.StringField(1, required=True)
702 ifMetagenerationMatch = messages.IntegerField(2)
703 ifMetagenerationNotMatch = messages.IntegerField(3)
704
705
706 class StorageBucketsDeleteResponse(messages.Message):
707 """An empty StorageBucketsDelete response."""
708
709
710 class StorageBucketsGetRequest(messages.Message):
711 """A StorageBucketsGetRequest object.
712
713 Enums:
714 ProjectionValueValuesEnum: Set of properties to return. Defaults to noAcl.
715
716 Fields:
717 bucket: Name of a bucket.
718 ifMetagenerationMatch: Makes the return of the bucket metadata conditional
719 on whether the bucket's current metageneration matches the given value.
720 ifMetagenerationNotMatch: Makes the return of the bucket metadata
721 conditional on whether the bucket's current metageneration does not
722 match the given value.
723 projection: Set of properties to return. Defaults to noAcl.
724 """
725
726 class ProjectionValueValuesEnum(messages.Enum):
727 """Set of properties to return. Defaults to noAcl.
728
729 Values:
730 full: Include all properties.
731 noAcl: Omit acl and defaultObjectAcl properties.
732 """
733 full = 0
734 noAcl = 1
735
736 bucket = messages.StringField(1, required=True)
737 ifMetagenerationMatch = messages.IntegerField(2)
738 ifMetagenerationNotMatch = messages.IntegerField(3)
739 projection = messages.EnumField('ProjectionValueValuesEnum', 4)
740
741
742 class StorageBucketsInsertRequest(messages.Message):
743 """A StorageBucketsInsertRequest object.
744
745 Enums:
746 PredefinedAclValueValuesEnum: Apply a predefined set of access controls to
747 this bucket.
748 ProjectionValueValuesEnum: Set of properties to return. Defaults to noAcl,
749 unless the bucket resource specifies acl or defaultObjectAcl properties,
750 when it defaults to full.
751
752 Fields:
753 bucket: A Bucket resource to be passed as the request body.
754 predefinedAcl: Apply a predefined set of access controls to this bucket.
755 project: A valid API project identifier.
756 projection: Set of properties to return. Defaults to noAcl, unless the
757 bucket resource specifies acl or defaultObjectAcl properties, when it
758 defaults to full.
759 """
760
761 class PredefinedAclValueValuesEnum(messages.Enum):
762 """Apply a predefined set of access controls to this bucket.
763
764 Values:
765 authenticatedRead: Project team owners get OWNER access, and
766 allAuthenticatedUsers get READER access.
767 private: Project team owners get OWNER access.
768 projectPrivate: Project team members get access according to their
769 roles.
770 publicRead: Project team owners get OWNER access, and allUsers get
771 READER access.
772 publicReadWrite: Project team owners get OWNER access, and allUsers get
773 WRITER access.
774 """
775 authenticatedRead = 0
776 private = 1
777 projectPrivate = 2
778 publicRead = 3
779 publicReadWrite = 4
780
781 class ProjectionValueValuesEnum(messages.Enum):
782 """Set of properties to return. Defaults to noAcl, unless the bucket
783 resource specifies acl or defaultObjectAcl properties, when it defaults to
784 full.
785
786 Values:
787 full: Include all properties.
788 noAcl: Omit acl and defaultObjectAcl properties.
789 """
790 full = 0
791 noAcl = 1
792
793 bucket = messages.MessageField('Bucket', 1)
794 predefinedAcl = messages.EnumField('PredefinedAclValueValuesEnum', 2)
795 project = messages.StringField(3, required=True)
796 projection = messages.EnumField('ProjectionValueValuesEnum', 4)
797
798
799 class StorageBucketsListRequest(messages.Message):
800 """A StorageBucketsListRequest object.
801
802 Enums:
803 ProjectionValueValuesEnum: Set of properties to return. Defaults to noAcl.
804
805 Fields:
806 maxResults: Maximum number of buckets to return.
807 pageToken: A previously-returned page token representing part of the
808 larger set of results to view.
809 project: A valid API project identifier.
810 projection: Set of properties to return. Defaults to noAcl.
811 """
812
813 class ProjectionValueValuesEnum(messages.Enum):
814 """Set of properties to return. Defaults to noAcl.
815
816 Values:
817 full: Include all properties.
818 noAcl: Omit acl and defaultObjectAcl properties.
819 """
820 full = 0
821 noAcl = 1
822
823 maxResults = messages.IntegerField(1, variant=messages.Variant.UINT32)
824 pageToken = messages.StringField(2)
825 project = messages.StringField(3, required=True)
826 projection = messages.EnumField('ProjectionValueValuesEnum', 4)
827
828
829 class StorageBucketsPatchRequest(messages.Message):
830 """A StorageBucketsPatchRequest object.
831
832 Enums:
833 PredefinedAclValueValuesEnum: Apply a predefined set of access controls to
834 this bucket.
835 ProjectionValueValuesEnum: Set of properties to return. Defaults to full.
836
837 Fields:
838 bucket: Name of a bucket.
839 bucketResource: A Bucket resource to be passed as the request body.
840 ifMetagenerationMatch: Makes the return of the bucket metadata conditional
841 on whether the bucket's current metageneration matches the given value.
842 ifMetagenerationNotMatch: Makes the return of the bucket metadata
843 conditional on whether the bucket's current metageneration does not
844 match the given value.
845 predefinedAcl: Apply a predefined set of access controls to this bucket.
846 projection: Set of properties to return. Defaults to full.
847 """
848
849 class PredefinedAclValueValuesEnum(messages.Enum):
850 """Apply a predefined set of access controls to this bucket.
851
852 Values:
853 authenticatedRead: Project team owners get OWNER access, and
854 allAuthenticatedUsers get READER access.
855 private: Project team owners get OWNER access.
856 projectPrivate: Project team members get access according to their
857 roles.
858 publicRead: Project team owners get OWNER access, and allUsers get
859 READER access.
860 publicReadWrite: Project team owners get OWNER access, and allUsers get
861 WRITER access.
862 """
863 authenticatedRead = 0
864 private = 1
865 projectPrivate = 2
866 publicRead = 3
867 publicReadWrite = 4
868
869 class ProjectionValueValuesEnum(messages.Enum):
870 """Set of properties to return. Defaults to full.
871
872 Values:
873 full: Include all properties.
874 noAcl: Omit acl and defaultObjectAcl properties.
875 """
876 full = 0
877 noAcl = 1
878
879 bucket = messages.StringField(1, required=True)
880 bucketResource = messages.MessageField('Bucket', 2)
881 ifMetagenerationMatch = messages.IntegerField(3)
882 ifMetagenerationNotMatch = messages.IntegerField(4)
883 predefinedAcl = messages.EnumField('PredefinedAclValueValuesEnum', 5)
884 projection = messages.EnumField('ProjectionValueValuesEnum', 6)
885
886
887 class StorageBucketsUpdateRequest(messages.Message):
888 """A StorageBucketsUpdateRequest object.
889
890 Enums:
891 PredefinedAclValueValuesEnum: Apply a predefined set of access controls to
892 this bucket.
893 ProjectionValueValuesEnum: Set of properties to return. Defaults to full.
894
895 Fields:
896 bucket: Name of a bucket.
897 bucketResource: A Bucket resource to be passed as the request body.
898 ifMetagenerationMatch: Makes the return of the bucket metadata conditional
899 on whether the bucket's current metageneration matches the given value.
900 ifMetagenerationNotMatch: Makes the return of the bucket metadata
901 conditional on whether the bucket's current metageneration does not
902 match the given value.
903 predefinedAcl: Apply a predefined set of access controls to this bucket.
904 projection: Set of properties to return. Defaults to full.
905 """
906
907 class PredefinedAclValueValuesEnum(messages.Enum):
908 """Apply a predefined set of access controls to this bucket.
909
910 Values:
911 authenticatedRead: Project team owners get OWNER access, and
912 allAuthenticatedUsers get READER access.
913 private: Project team owners get OWNER access.
914 projectPrivate: Project team members get access according to their
915 roles.
916 publicRead: Project team owners get OWNER access, and allUsers get
917 READER access.
918 publicReadWrite: Project team owners get OWNER access, and allUsers get
919 WRITER access.
920 """
921 authenticatedRead = 0
922 private = 1
923 projectPrivate = 2
924 publicRead = 3
925 publicReadWrite = 4
926
927 class ProjectionValueValuesEnum(messages.Enum):
928 """Set of properties to return. Defaults to full.
929
930 Values:
931 full: Include all properties.
932 noAcl: Omit acl and defaultObjectAcl properties.
933 """
934 full = 0
935 noAcl = 1
936
937 bucket = messages.StringField(1, required=True)
938 bucketResource = messages.MessageField('Bucket', 2)
939 ifMetagenerationMatch = messages.IntegerField(3)
940 ifMetagenerationNotMatch = messages.IntegerField(4)
941 predefinedAcl = messages.EnumField('PredefinedAclValueValuesEnum', 5)
942 projection = messages.EnumField('ProjectionValueValuesEnum', 6)
943
944
945 class StorageChannelsStopResponse(messages.Message):
946 """An empty StorageChannelsStop response."""
947
948
949 class StorageDefaultObjectAccessControlsDeleteRequest(messages.Message):
950 """A StorageDefaultObjectAccessControlsDeleteRequest object.
951
952 Fields:
953 bucket: Name of a bucket.
954 entity: The entity holding the permission. Can be user-userId, user-
955 emailAddress, group-groupId, group-emailAddress, allUsers, or
956 allAuthenticatedUsers.
957 """
958
959 bucket = messages.StringField(1, required=True)
960 entity = messages.StringField(2, required=True)
961
962
963 class StorageDefaultObjectAccessControlsDeleteResponse(messages.Message):
964 """An empty StorageDefaultObjectAccessControlsDelete response."""
965
966
967 class StorageDefaultObjectAccessControlsGetRequest(messages.Message):
968 """A StorageDefaultObjectAccessControlsGetRequest object.
969
970 Fields:
971 bucket: Name of a bucket.
972 entity: The entity holding the permission. Can be user-userId, user-
973 emailAddress, group-groupId, group-emailAddress, allUsers, or
974 allAuthenticatedUsers.
975 """
976
977 bucket = messages.StringField(1, required=True)
978 entity = messages.StringField(2, required=True)
979
980
981 class StorageDefaultObjectAccessControlsListRequest(messages.Message):
982 """A StorageDefaultObjectAccessControlsListRequest object.
983
984 Fields:
985 bucket: Name of a bucket.
986 ifMetagenerationMatch: If present, only return default ACL listing if the
987 bucket's current metageneration matches this value.
988 ifMetagenerationNotMatch: If present, only return default ACL listing if
989 the bucket's current metageneration does not match the given value.
990 """
991
992 bucket = messages.StringField(1, required=True)
993 ifMetagenerationMatch = messages.IntegerField(2)
994 ifMetagenerationNotMatch = messages.IntegerField(3)
995
996
997 class StorageObjectAccessControlsDeleteRequest(messages.Message):
998 """A StorageObjectAccessControlsDeleteRequest object.
999
1000 Fields:
1001 bucket: Name of a bucket.
1002 entity: The entity holding the permission. Can be user-userId, user-
1003 emailAddress, group-groupId, group-emailAddress, allUsers, or
1004 allAuthenticatedUsers.
1005 generation: If present, selects a specific revision of this object (as
1006 opposed to the latest version, the default).
1007 object: Name of the object.
1008 """
1009
1010 bucket = messages.StringField(1, required=True)
1011 entity = messages.StringField(2, required=True)
1012 generation = messages.IntegerField(3)
1013 object = messages.StringField(4, required=True)
1014
1015
1016 class StorageObjectAccessControlsDeleteResponse(messages.Message):
1017 """An empty StorageObjectAccessControlsDelete response."""
1018
1019
1020 class StorageObjectAccessControlsGetRequest(messages.Message):
1021 """A StorageObjectAccessControlsGetRequest object.
1022
1023 Fields:
1024 bucket: Name of a bucket.
1025 entity: The entity holding the permission. Can be user-userId, user-
1026 emailAddress, group-groupId, group-emailAddress, allUsers, or
1027 allAuthenticatedUsers.
1028 generation: If present, selects a specific revision of this object (as
1029 opposed to the latest version, the default).
1030 object: Name of the object.
1031 """
1032
1033 bucket = messages.StringField(1, required=True)
1034 entity = messages.StringField(2, required=True)
1035 generation = messages.IntegerField(3)
1036 object = messages.StringField(4, required=True)
1037
1038
1039 class StorageObjectAccessControlsInsertRequest(messages.Message):
1040 """A StorageObjectAccessControlsInsertRequest object.
1041
1042 Fields:
1043 bucket: Name of a bucket.
1044 generation: If present, selects a specific revision of this object (as
1045 opposed to the latest version, the default).
1046 object: Name of the object.
1047 objectAccessControl: A ObjectAccessControl resource to be passed as the
1048 request body.
1049 """
1050
1051 bucket = messages.StringField(1, required=True)
1052 generation = messages.IntegerField(2)
1053 object = messages.StringField(3, required=True)
1054 objectAccessControl = messages.MessageField('ObjectAccessControl', 4)
1055
1056
1057 class StorageObjectAccessControlsListRequest(messages.Message):
1058 """A StorageObjectAccessControlsListRequest object.
1059
1060 Fields:
1061 bucket: Name of a bucket.
1062 generation: If present, selects a specific revision of this object (as
1063 opposed to the latest version, the default).
1064 object: Name of the object.
1065 """
1066
1067 bucket = messages.StringField(1, required=True)
1068 generation = messages.IntegerField(2)
1069 object = messages.StringField(3, required=True)
1070
1071
1072 class StorageObjectAccessControlsPatchRequest(messages.Message):
1073 """A StorageObjectAccessControlsPatchRequest object.
1074
1075 Fields:
1076 bucket: Name of a bucket.
1077 entity: The entity holding the permission. Can be user-userId, user-
1078 emailAddress, group-groupId, group-emailAddress, allUsers, or
1079 allAuthenticatedUsers.
1080 generation: If present, selects a specific revision of this object (as
1081 opposed to the latest version, the default).
1082 object: Name of the object.
1083 objectAccessControl: A ObjectAccessControl resource to be passed as the
1084 request body.
1085 """
1086
1087 bucket = messages.StringField(1, required=True)
1088 entity = messages.StringField(2, required=True)
1089 generation = messages.IntegerField(3)
1090 object = messages.StringField(4, required=True)
1091 objectAccessControl = messages.MessageField('ObjectAccessControl', 5)
1092
1093
1094 class StorageObjectAccessControlsUpdateRequest(messages.Message):
1095 """A StorageObjectAccessControlsUpdateRequest object.
1096
1097 Fields:
1098 bucket: Name of a bucket.
1099 entity: The entity holding the permission. Can be user-userId, user-
1100 emailAddress, group-groupId, group-emailAddress, allUsers, or
1101 allAuthenticatedUsers.
1102 generation: If present, selects a specific revision of this object (as
1103 opposed to the latest version, the default).
1104 object: Name of the object.
1105 objectAccessControl: A ObjectAccessControl resource to be passed as the
1106 request body.
1107 """
1108
1109 bucket = messages.StringField(1, required=True)
1110 entity = messages.StringField(2, required=True)
1111 generation = messages.IntegerField(3)
1112 object = messages.StringField(4, required=True)
1113 objectAccessControl = messages.MessageField('ObjectAccessControl', 5)
1114
1115
1116 class StorageObjectsComposeRequest(messages.Message):
1117 """A StorageObjectsComposeRequest object.
1118
1119 Enums:
1120 DestinationPredefinedAclValueValuesEnum: Apply a predefined set of access
1121 controls to the destination object.
1122
1123 Fields:
1124 composeRequest: A ComposeRequest resource to be passed as the request
1125 body.
1126 destinationBucket: Name of the bucket in which to store the new object.
1127 destinationObject: Name of the new object.
1128 destinationPredefinedAcl: Apply a predefined set of access controls to the
1129 destination object.
1130 ifGenerationMatch: Makes the operation conditional on whether the object's
1131 current generation matches the given value.
1132 ifMetagenerationMatch: Makes the operation conditional on whether the
1133 object's current metageneration matches the given value.
1134 """
1135
1136 class DestinationPredefinedAclValueValuesEnum(messages.Enum):
1137 """Apply a predefined set of access controls to the destination object.
1138
1139 Values:
1140 authenticatedRead: Object owner gets OWNER access, and
1141 allAuthenticatedUsers get READER access.
1142 bucketOwnerFullControl: Object owner gets OWNER access, and project team
1143 owners get OWNER access.
1144 bucketOwnerRead: Object owner gets OWNER access, and project team owners
1145 get READER access.
1146 private: Object owner gets OWNER access.
1147 projectPrivate: Object owner gets OWNER access, and project team members
1148 get access according to their roles.
1149 publicRead: Object owner gets OWNER access, and allUsers get READER
1150 access.
1151 """
1152 authenticatedRead = 0
1153 bucketOwnerFullControl = 1
1154 bucketOwnerRead = 2
1155 private = 3
1156 projectPrivate = 4
1157 publicRead = 5
1158
1159 composeRequest = messages.MessageField('ComposeRequest', 1)
1160 destinationBucket = messages.StringField(2, required=True)
1161 destinationObject = messages.StringField(3, required=True)
1162 destinationPredefinedAcl = messages.EnumField('DestinationPredefinedAclValueVa luesEnum', 4)
1163 ifGenerationMatch = messages.IntegerField(5)
1164 ifMetagenerationMatch = messages.IntegerField(6)
1165
1166
1167 class StorageObjectsCopyRequest(messages.Message):
1168 """A StorageObjectsCopyRequest object.
1169
1170 Enums:
1171 DestinationPredefinedAclValueValuesEnum: Apply a predefined set of access
1172 controls to the destination object.
1173 ProjectionValueValuesEnum: Set of properties to return. Defaults to noAcl,
1174 unless the object resource specifies the acl property, when it defaults
1175 to full.
1176
1177 Fields:
1178 destinationBucket: Name of the bucket in which to store the new object.
1179 Overrides the provided object metadata's bucket value, if any.
1180 destinationObject: Name of the new object. Required when the object
1181 metadata is not otherwise provided. Overrides the object metadata's name
1182 value, if any.
1183 destinationPredefinedAcl: Apply a predefined set of access controls to the
1184 destination object.
1185 ifGenerationMatch: Makes the operation conditional on whether the
1186 destination object's current generation matches the given value.
1187 ifGenerationNotMatch: Makes the operation conditional on whether the
1188 destination object's current generation does not match the given value.
1189 ifMetagenerationMatch: Makes the operation conditional on whether the
1190 destination object's current metageneration matches the given value.
1191 ifMetagenerationNotMatch: Makes the operation conditional on whether the
1192 destination object's current metageneration does not match the given
1193 value.
1194 ifSourceGenerationMatch: Makes the operation conditional on whether the
1195 source object's generation matches the given value.
1196 ifSourceGenerationNotMatch: Makes the operation conditional on whether the
1197 source object's generation does not match the given value.
1198 ifSourceMetagenerationMatch: Makes the operation conditional on whether
1199 the source object's current metageneration matches the given value.
1200 ifSourceMetagenerationNotMatch: Makes the operation conditional on whether
1201 the source object's current metageneration does not match the given
1202 value.
1203 object: A Object resource to be passed as the request body.
1204 projection: Set of properties to return. Defaults to noAcl, unless the
1205 object resource specifies the acl property, when it defaults to full.
1206 sourceBucket: Name of the bucket in which to find the source object.
1207 sourceGeneration: If present, selects a specific revision of the source
1208 object (as opposed to the latest version, the default).
1209 sourceObject: Name of the source object.
1210 """
1211
1212 class DestinationPredefinedAclValueValuesEnum(messages.Enum):
1213 """Apply a predefined set of access controls to the destination object.
1214
1215 Values:
1216 authenticatedRead: Object owner gets OWNER access, and
1217 allAuthenticatedUsers get READER access.
1218 bucketOwnerFullControl: Object owner gets OWNER access, and project team
1219 owners get OWNER access.
1220 bucketOwnerRead: Object owner gets OWNER access, and project team owners
1221 get READER access.
1222 private: Object owner gets OWNER access.
1223 projectPrivate: Object owner gets OWNER access, and project team members
1224 get access according to their roles.
1225 publicRead: Object owner gets OWNER access, and allUsers get READER
1226 access.
1227 """
1228 authenticatedRead = 0
1229 bucketOwnerFullControl = 1
1230 bucketOwnerRead = 2
1231 private = 3
1232 projectPrivate = 4
1233 publicRead = 5
1234
1235 class ProjectionValueValuesEnum(messages.Enum):
1236 """Set of properties to return. Defaults to noAcl, unless the object
1237 resource specifies the acl property, when it defaults to full.
1238
1239 Values:
1240 full: Include all properties.
1241 noAcl: Omit the acl property.
1242 """
1243 full = 0
1244 noAcl = 1
1245
1246 destinationBucket = messages.StringField(1, required=True)
1247 destinationObject = messages.StringField(2, required=True)
1248 destinationPredefinedAcl = messages.EnumField('DestinationPredefinedAclValueVa luesEnum', 3)
1249 ifGenerationMatch = messages.IntegerField(4)
1250 ifGenerationNotMatch = messages.IntegerField(5)
1251 ifMetagenerationMatch = messages.IntegerField(6)
1252 ifMetagenerationNotMatch = messages.IntegerField(7)
1253 ifSourceGenerationMatch = messages.IntegerField(8)
1254 ifSourceGenerationNotMatch = messages.IntegerField(9)
1255 ifSourceMetagenerationMatch = messages.IntegerField(10)
1256 ifSourceMetagenerationNotMatch = messages.IntegerField(11)
1257 object = messages.MessageField('Object', 12)
1258 projection = messages.EnumField('ProjectionValueValuesEnum', 13)
1259 sourceBucket = messages.StringField(14, required=True)
1260 sourceGeneration = messages.IntegerField(15)
1261 sourceObject = messages.StringField(16, required=True)
1262
1263
1264 class StorageObjectsDeleteRequest(messages.Message):
1265 """A StorageObjectsDeleteRequest object.
1266
1267 Fields:
1268 bucket: Name of the bucket in which the object resides.
1269 generation: If present, permanently deletes a specific revision of this
1270 object (as opposed to the latest version, the default).
1271 ifGenerationMatch: Makes the operation conditional on whether the object's
1272 current generation matches the given value.
1273 ifGenerationNotMatch: Makes the operation conditional on whether the
1274 object's current generation does not match the given value.
1275 ifMetagenerationMatch: Makes the operation conditional on whether the
1276 object's current metageneration matches the given value.
1277 ifMetagenerationNotMatch: Makes the operation conditional on whether the
1278 object's current metageneration does not match the given value.
1279 object: Name of the object.
1280 """
1281
1282 bucket = messages.StringField(1, required=True)
1283 generation = messages.IntegerField(2)
1284 ifGenerationMatch = messages.IntegerField(3)
1285 ifGenerationNotMatch = messages.IntegerField(4)
1286 ifMetagenerationMatch = messages.IntegerField(5)
1287 ifMetagenerationNotMatch = messages.IntegerField(6)
1288 object = messages.StringField(7, required=True)
1289
1290
1291 class StorageObjectsDeleteResponse(messages.Message):
1292 """An empty StorageObjectsDelete response."""
1293
1294
1295 class StorageObjectsGetRequest(messages.Message):
1296 """A StorageObjectsGetRequest object.
1297
1298 Enums:
1299 ProjectionValueValuesEnum: Set of properties to return. Defaults to noAcl.
1300
1301 Fields:
1302 bucket: Name of the bucket in which the object resides.
1303 generation: If present, selects a specific revision of this object (as
1304 opposed to the latest version, the default).
1305 ifGenerationMatch: Makes the operation conditional on whether the object's
1306 generation matches the given value.
1307 ifGenerationNotMatch: Makes the operation conditional on whether the
1308 object's generation does not match the given value.
1309 ifMetagenerationMatch: Makes the operation conditional on whether the
1310 object's current metageneration matches the given value.
1311 ifMetagenerationNotMatch: Makes the operation conditional on whether the
1312 object's current metageneration does not match the given value.
1313 object: Name of the object.
1314 projection: Set of properties to return. Defaults to noAcl.
1315 """
1316
1317 class ProjectionValueValuesEnum(messages.Enum):
1318 """Set of properties to return. Defaults to noAcl.
1319
1320 Values:
1321 full: Include all properties.
1322 noAcl: Omit the acl property.
1323 """
1324 full = 0
1325 noAcl = 1
1326
1327 bucket = messages.StringField(1, required=True)
1328 generation = messages.IntegerField(2)
1329 ifGenerationMatch = messages.IntegerField(3)
1330 ifGenerationNotMatch = messages.IntegerField(4)
1331 ifMetagenerationMatch = messages.IntegerField(5)
1332 ifMetagenerationNotMatch = messages.IntegerField(6)
1333 object = messages.StringField(7, required=True)
1334 projection = messages.EnumField('ProjectionValueValuesEnum', 8)
1335
1336
1337 class StorageObjectsInsertRequest(messages.Message):
1338 """A StorageObjectsInsertRequest object.
1339
1340 Enums:
1341 PredefinedAclValueValuesEnum: Apply a predefined set of access controls to
1342 this object.
1343 ProjectionValueValuesEnum: Set of properties to return. Defaults to noAcl,
1344 unless the object resource specifies the acl property, when it defaults
1345 to full.
1346
1347 Fields:
1348 bucket: Name of the bucket in which to store the new object. Overrides the
1349 provided object metadata's bucket value, if any.
1350 contentEncoding: If set, sets the contentEncoding property of the final
1351 object to this value. Setting this parameter is equivalent to setting
1352 the contentEncoding metadata property. This can be useful when uploading
1353 an object with uploadType=media to indicate the encoding of the content
1354 being uploaded.
1355 ifGenerationMatch: Makes the operation conditional on whether the object's
1356 current generation matches the given value.
1357 ifGenerationNotMatch: Makes the operation conditional on whether the
1358 object's current generation does not match the given value.
1359 ifMetagenerationMatch: Makes the operation conditional on whether the
1360 object's current metageneration matches the given value.
1361 ifMetagenerationNotMatch: Makes the operation conditional on whether the
1362 object's current metageneration does not match the given value.
1363 name: Name of the object. Required when the object metadata is not
1364 otherwise provided. Overrides the object metadata's name value, if any.
1365 object: A Object resource to be passed as the request body.
1366 predefinedAcl: Apply a predefined set of access controls to this object.
1367 projection: Set of properties to return. Defaults to noAcl, unless the
1368 object resource specifies the acl property, when it defaults to full.
1369 """
1370
1371 class PredefinedAclValueValuesEnum(messages.Enum):
1372 """Apply a predefined set of access controls to this object.
1373
1374 Values:
1375 authenticatedRead: Object owner gets OWNER access, and
1376 allAuthenticatedUsers get READER access.
1377 bucketOwnerFullControl: Object owner gets OWNER access, and project team
1378 owners get OWNER access.
1379 bucketOwnerRead: Object owner gets OWNER access, and project team owners
1380 get READER access.
1381 private: Object owner gets OWNER access.
1382 projectPrivate: Object owner gets OWNER access, and project team members
1383 get access according to their roles.
1384 publicRead: Object owner gets OWNER access, and allUsers get READER
1385 access.
1386 """
1387 authenticatedRead = 0
1388 bucketOwnerFullControl = 1
1389 bucketOwnerRead = 2
1390 private = 3
1391 projectPrivate = 4
1392 publicRead = 5
1393
1394 class ProjectionValueValuesEnum(messages.Enum):
1395 """Set of properties to return. Defaults to noAcl, unless the object
1396 resource specifies the acl property, when it defaults to full.
1397
1398 Values:
1399 full: Include all properties.
1400 noAcl: Omit the acl property.
1401 """
1402 full = 0
1403 noAcl = 1
1404
1405 bucket = messages.StringField(1, required=True)
1406 contentEncoding = messages.StringField(2)
1407 ifGenerationMatch = messages.IntegerField(3)
1408 ifGenerationNotMatch = messages.IntegerField(4)
1409 ifMetagenerationMatch = messages.IntegerField(5)
1410 ifMetagenerationNotMatch = messages.IntegerField(6)
1411 name = messages.StringField(7)
1412 object = messages.MessageField('Object', 8)
1413 predefinedAcl = messages.EnumField('PredefinedAclValueValuesEnum', 9)
1414 projection = messages.EnumField('ProjectionValueValuesEnum', 10)
1415
1416
1417 class StorageObjectsListRequest(messages.Message):
1418 """A StorageObjectsListRequest object.
1419
1420 Enums:
1421 ProjectionValueValuesEnum: Set of properties to return. Defaults to noAcl.
1422
1423 Fields:
1424 bucket: Name of the bucket in which to look for objects.
1425 delimiter: Returns results in a directory-like mode. items will contain
1426 only objects whose names, aside from the prefix, do not contain
1427 delimiter. Objects whose names, aside from the prefix, contain delimiter
1428 will have their name, truncated after the delimiter, returned in
1429 prefixes. Duplicate prefixes are omitted.
1430 maxResults: Maximum number of items plus prefixes to return. As duplicate
1431 prefixes are omitted, fewer total results may be returned than
1432 requested.
1433 pageToken: A previously-returned page token representing part of the
1434 larger set of results to view.
1435 prefix: Filter results to objects whose names begin with this prefix.
1436 projection: Set of properties to return. Defaults to noAcl.
1437 versions: If true, lists all versions of a file as distinct results.
1438 """
1439
1440 class ProjectionValueValuesEnum(messages.Enum):
1441 """Set of properties to return. Defaults to noAcl.
1442
1443 Values:
1444 full: Include all properties.
1445 noAcl: Omit the acl property.
1446 """
1447 full = 0
1448 noAcl = 1
1449
1450 bucket = messages.StringField(1, required=True)
1451 delimiter = messages.StringField(2)
1452 maxResults = messages.IntegerField(3, variant=messages.Variant.UINT32)
1453 pageToken = messages.StringField(4)
1454 prefix = messages.StringField(5)
1455 projection = messages.EnumField('ProjectionValueValuesEnum', 6)
1456 versions = messages.BooleanField(7)
1457
1458
1459 class StorageObjectsPatchRequest(messages.Message):
1460 """A StorageObjectsPatchRequest object.
1461
1462 Enums:
1463 PredefinedAclValueValuesEnum: Apply a predefined set of access controls to
1464 this object.
1465 ProjectionValueValuesEnum: Set of properties to return. Defaults to full.
1466
1467 Fields:
1468 bucket: Name of the bucket in which the object resides.
1469 generation: If present, selects a specific revision of this object (as
1470 opposed to the latest version, the default).
1471 ifGenerationMatch: Makes the operation conditional on whether the object's
1472 current generation matches the given value.
1473 ifGenerationNotMatch: Makes the operation conditional on whether the
1474 object's current generation does not match the given value.
1475 ifMetagenerationMatch: Makes the operation conditional on whether the
1476 object's current metageneration matches the given value.
1477 ifMetagenerationNotMatch: Makes the operation conditional on whether the
1478 object's current metageneration does not match the given value.
1479 object: Name of the object.
1480 objectResource: A Object resource to be passed as the request body.
1481 predefinedAcl: Apply a predefined set of access controls to this object.
1482 projection: Set of properties to return. Defaults to full.
1483 """
1484
1485 class PredefinedAclValueValuesEnum(messages.Enum):
1486 """Apply a predefined set of access controls to this object.
1487
1488 Values:
1489 authenticatedRead: Object owner gets OWNER access, and
1490 allAuthenticatedUsers get READER access.
1491 bucketOwnerFullControl: Object owner gets OWNER access, and project team
1492 owners get OWNER access.
1493 bucketOwnerRead: Object owner gets OWNER access, and project team owners
1494 get READER access.
1495 private: Object owner gets OWNER access.
1496 projectPrivate: Object owner gets OWNER access, and project team members
1497 get access according to their roles.
1498 publicRead: Object owner gets OWNER access, and allUsers get READER
1499 access.
1500 """
1501 authenticatedRead = 0
1502 bucketOwnerFullControl = 1
1503 bucketOwnerRead = 2
1504 private = 3
1505 projectPrivate = 4
1506 publicRead = 5
1507
1508 class ProjectionValueValuesEnum(messages.Enum):
1509 """Set of properties to return. Defaults to full.
1510
1511 Values:
1512 full: Include all properties.
1513 noAcl: Omit the acl property.
1514 """
1515 full = 0
1516 noAcl = 1
1517
1518 bucket = messages.StringField(1, required=True)
1519 generation = messages.IntegerField(2)
1520 ifGenerationMatch = messages.IntegerField(3)
1521 ifGenerationNotMatch = messages.IntegerField(4)
1522 ifMetagenerationMatch = messages.IntegerField(5)
1523 ifMetagenerationNotMatch = messages.IntegerField(6)
1524 object = messages.StringField(7, required=True)
1525 objectResource = messages.MessageField('Object', 8)
1526 predefinedAcl = messages.EnumField('PredefinedAclValueValuesEnum', 9)
1527 projection = messages.EnumField('ProjectionValueValuesEnum', 10)
1528
1529
1530 class StorageObjectsUpdateRequest(messages.Message):
1531 """A StorageObjectsUpdateRequest object.
1532
1533 Enums:
1534 PredefinedAclValueValuesEnum: Apply a predefined set of access controls to
1535 this object.
1536 ProjectionValueValuesEnum: Set of properties to return. Defaults to full.
1537
1538 Fields:
1539 bucket: Name of the bucket in which the object resides.
1540 generation: If present, selects a specific revision of this object (as
1541 opposed to the latest version, the default).
1542 ifGenerationMatch: Makes the operation conditional on whether the object's
1543 current generation matches the given value.
1544 ifGenerationNotMatch: Makes the operation conditional on whether the
1545 object's current generation does not match the given value.
1546 ifMetagenerationMatch: Makes the operation conditional on whether the
1547 object's current metageneration matches the given value.
1548 ifMetagenerationNotMatch: Makes the operation conditional on whether the
1549 object's current metageneration does not match the given value.
1550 object: Name of the object.
1551 objectResource: A Object resource to be passed as the request body.
1552 predefinedAcl: Apply a predefined set of access controls to this object.
1553 projection: Set of properties to return. Defaults to full.
1554 """
1555
1556 class PredefinedAclValueValuesEnum(messages.Enum):
1557 """Apply a predefined set of access controls to this object.
1558
1559 Values:
1560 authenticatedRead: Object owner gets OWNER access, and
1561 allAuthenticatedUsers get READER access.
1562 bucketOwnerFullControl: Object owner gets OWNER access, and project team
1563 owners get OWNER access.
1564 bucketOwnerRead: Object owner gets OWNER access, and project team owners
1565 get READER access.
1566 private: Object owner gets OWNER access.
1567 projectPrivate: Object owner gets OWNER access, and project team members
1568 get access according to their roles.
1569 publicRead: Object owner gets OWNER access, and allUsers get READER
1570 access.
1571 """
1572 authenticatedRead = 0
1573 bucketOwnerFullControl = 1
1574 bucketOwnerRead = 2
1575 private = 3
1576 projectPrivate = 4
1577 publicRead = 5
1578
1579 class ProjectionValueValuesEnum(messages.Enum):
1580 """Set of properties to return. Defaults to full.
1581
1582 Values:
1583 full: Include all properties.
1584 noAcl: Omit the acl property.
1585 """
1586 full = 0
1587 noAcl = 1
1588
1589 bucket = messages.StringField(1, required=True)
1590 generation = messages.IntegerField(2)
1591 ifGenerationMatch = messages.IntegerField(3)
1592 ifGenerationNotMatch = messages.IntegerField(4)
1593 ifMetagenerationMatch = messages.IntegerField(5)
1594 ifMetagenerationNotMatch = messages.IntegerField(6)
1595 object = messages.StringField(7, required=True)
1596 objectResource = messages.MessageField('Object', 8)
1597 predefinedAcl = messages.EnumField('PredefinedAclValueValuesEnum', 9)
1598 projection = messages.EnumField('ProjectionValueValuesEnum', 10)
1599
1600
1601 class StorageObjectsWatchAllRequest(messages.Message):
1602 """A StorageObjectsWatchAllRequest object.
1603
1604 Enums:
1605 ProjectionValueValuesEnum: Set of properties to return. Defaults to noAcl.
1606
1607 Fields:
1608 bucket: Name of the bucket in which to look for objects.
1609 channel: A Channel resource to be passed as the request body.
1610 delimiter: Returns results in a directory-like mode. items will contain
1611 only objects whose names, aside from the prefix, do not contain
1612 delimiter. Objects whose names, aside from the prefix, contain delimiter
1613 will have their name, truncated after the delimiter, returned in
1614 prefixes. Duplicate prefixes are omitted.
1615 maxResults: Maximum number of items plus prefixes to return. As duplicate
1616 prefixes are omitted, fewer total results may be returned than
1617 requested.
1618 pageToken: A previously-returned page token representing part of the
1619 larger set of results to view.
1620 prefix: Filter results to objects whose names begin with this prefix.
1621 projection: Set of properties to return. Defaults to noAcl.
1622 versions: If true, lists all versions of a file as distinct results.
1623 """
1624
1625 class ProjectionValueValuesEnum(messages.Enum):
1626 """Set of properties to return. Defaults to noAcl.
1627
1628 Values:
1629 full: Include all properties.
1630 noAcl: Omit the acl property.
1631 """
1632 full = 0
1633 noAcl = 1
1634
1635 bucket = messages.StringField(1, required=True)
1636 channel = messages.MessageField('Channel', 2)
1637 delimiter = messages.StringField(3)
1638 maxResults = messages.IntegerField(4, variant=messages.Variant.UINT32)
1639 pageToken = messages.StringField(5)
1640 prefix = messages.StringField(6)
1641 projection = messages.EnumField('ProjectionValueValuesEnum', 7)
1642 versions = messages.BooleanField(8)
1643
1644
OLDNEW
« no previous file with comments | « gslib/third_party/storage_apitools/storage_v1_client.py ('k') | gslib/third_party/storage_apitools/stream_slice.py » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698