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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="storage_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.objectAccessControls.html">objectAccessControls</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(bucket, object, entity, generation=None, userProject=None)</a></code></p>
<p class="firstline">Permanently deletes the ACL entry for the specified entity on the specified object.</p>
<p class="toc_element">
<code><a href="#get">get(bucket, object, entity, generation=None, userProject=None)</a></code></p>
<p class="firstline">Returns the ACL entry for the specified entity on the specified object.</p>
<p class="toc_element">
<code><a href="#insert">insert(bucket, object, body=None, generation=None, userProject=None)</a></code></p>
<p class="firstline">Creates a new ACL entry on the specified object.</p>
<p class="toc_element">
<code><a href="#list">list(bucket, object, generation=None, userProject=None)</a></code></p>
<p class="firstline">Retrieves ACL entries on the specified object.</p>
<p class="toc_element">
<code><a href="#patch">patch(bucket, object, entity, body=None, generation=None, userProject=None)</a></code></p>
<p class="firstline">Patches an ACL entry on the specified object.</p>
<p class="toc_element">
<code><a href="#update">update(bucket, object, entity, body=None, generation=None, userProject=None)</a></code></p>
<p class="firstline">Updates an ACL entry on the specified object.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(bucket, object, entity, generation=None, userProject=None)</code>
<pre>Permanently deletes the ACL entry for the specified entity on the specified object.
Args:
bucket: string, Name of a bucket. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
</pre>
</div>
<div class="method">
<code class="details" id="get">get(bucket, object, entity, generation=None, userProject=None)</code>
<pre>Returns the ACL entry for the specified entity on the specified object.
Args:
bucket: string, Name of a bucket. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(bucket, object, body=None, generation=None, userProject=None)</code>
<pre>Creates a new ACL entry on the specified object.
Args:
bucket: string, Name of a bucket. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
body: object, The request body.
The object takes the form of:
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
}
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(bucket, object, generation=None, userProject=None)</code>
<pre>Retrieves ACL entries on the specified object.
Args:
bucket: string, Name of a bucket. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An access-control list.
"items": [ # The list of items.
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
},
],
"kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(bucket, object, entity, body=None, generation=None, userProject=None)</code>
<pre>Patches an ACL entry on the specified object.
Args:
bucket: string, Name of a bucket. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
body: object, The request body.
The object takes the form of:
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
}
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(bucket, object, entity, body=None, generation=None, userProject=None)</code>
<pre>Updates an ACL entry on the specified object.
Args:
bucket: string, Name of a bucket. (required)
object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
body: object, The request body.
The object takes the form of:
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
}
generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
Returns:
An object of the form:
{ # An access-control entry.
"bucket": "A String", # The name of the bucket.
"domain": "A String", # The domain associated with the entity, if any.
"email": "A String", # The email address associated with the entity, if any.
"entity": "A String", # The entity holding the permission, in one of the following forms:
# - user-userId
# - user-email
# - group-groupId
# - group-email
# - domain-domain
# - project-team-projectId
# - allUsers
# - allAuthenticatedUsers Examples:
# - The user liz@example.com would be user-liz@example.com.
# - The group example@googlegroups.com would be group-example@googlegroups.com.
# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
"entityId": "A String", # The ID for the entity, if any.
"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
"generation": "A String", # The content generation of the object, if applied to an object.
"id": "A String", # The ID of the access-control entry.
"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
"object": "A String", # The name of the object, if applied to an object.
"projectTeam": { # The project team associated with the entity, if any.
"projectNumber": "A String", # The project number.
"team": "A String", # The team.
},
"role": "A String", # The access permission for the entity.
"selfLink": "A String", # The link to this access-control entry.
}</pre>
</div>
</body></html>
|
