Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ea3a5e1b5572e5438ba86ec0074f60029bd94855 / . / docs / dyn / storage_v1.defaultObjectAccessControls.html
blob: 555edc0dc6dc4e379d91950e08730fe74dc04f57 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]75<h1><a href="storage_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.defaultObjectAccessControls.html">defaultObjectAccessControls</a></h1>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(bucket, entity)</a></code></p>
79<p class="firstline">Permanently deletes the default object ACL entry for the specified entity on the specified bucket.</p>
80<p class="toc_element">
81 <code><a href="#get">get(bucket, entity)</a></code></p>
82<p class="firstline">Returns the default object ACL entry for the specified entity on the specified bucket.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(bucket, body)</a></code></p>
85<p class="firstline">Creates a new default object ACL entry on the specified bucket.</p>
86<p class="toc_element">
87 <code><a href="#list">list(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
88<p class="firstline">Retrieves default object ACL entries on the specified bucket.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(bucket, entity, body)</a></code></p>
91<p class="firstline">Updates a default object ACL entry on the specified bucket. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(bucket, entity, body)</a></code></p>
94<p class="firstline">Updates a default object ACL entry on the specified bucket.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(bucket, entity)</code>
98 <pre>Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
99
100Args:
101 bucket: string, Name of a bucket. (required)
102 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
103</pre>
104</div>
105
106<div class="method">
107 <code class="details" id="get">get(bucket, entity)</code>
108 <pre>Returns the default object ACL entry for the specified entity on the specified bucket.
109
110Args:
111 bucket: string, Name of a bucket. (required)
112 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
113
114Returns:
115 An object of the form:
116
117 { # An access-control entry.
118 "domain": "A String", # The domain associated with the entity, if any.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]119 "generation": "A String", # The content generation of the object, if applied to an object.
120 "object": "A String", # The name of the object, if applied to an object.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]121 "bucket": "A String", # The name of the bucket.
122 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
123 "entity": "A String", # The entity holding the permission, in one of the following forms:
124 # - user-userId
125 # - user-email
126 # - group-groupId
127 # - group-email
128 # - domain-domain
129 # - project-team-projectId
130 # - allUsers
131 # - allAuthenticatedUsers Examples:
132 # - The user liz@example.com would be user-liz@example.com.
133 # - The group example@googlegroups.com would be group-example@googlegroups.com.
134 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
135 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]136 "role": "A String", # The access permission for the entity.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]137 "id": "A String", # The ID of the access-control entry.
138 "entityId": "A String", # The ID for the entity, if any.
139 "projectTeam": { # The project team associated with the entity, if any.
140 "projectNumber": "A String", # The project number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]141 "team": "A String", # The team.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]142 },
143 "email": "A String", # The email address associated with the entity, if any.
144 "selfLink": "A String", # The link to this access-control entry.
145 }</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="insert">insert(bucket, body)</code>
150 <pre>Creates a new default object ACL entry on the specified bucket.
151
152Args:
153 bucket: string, Name of a bucket. (required)
154 body: object, The request body. (required)
155 The object takes the form of:
156
157{ # An access-control entry.
158 "domain": "A String", # The domain associated with the entity, if any.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]159 "generation": "A String", # The content generation of the object, if applied to an object.
160 "object": "A String", # The name of the object, if applied to an object.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]161 "bucket": "A String", # The name of the bucket.
162 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
163 "entity": "A String", # The entity holding the permission, in one of the following forms:
164 # - user-userId
165 # - user-email
166 # - group-groupId
167 # - group-email
168 # - domain-domain
169 # - project-team-projectId
170 # - allUsers
171 # - allAuthenticatedUsers Examples:
172 # - The user liz@example.com would be user-liz@example.com.
173 # - The group example@googlegroups.com would be group-example@googlegroups.com.
174 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
175 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]176 "role": "A String", # The access permission for the entity.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]177 "id": "A String", # The ID of the access-control entry.
178 "entityId": "A String", # The ID for the entity, if any.
179 "projectTeam": { # The project team associated with the entity, if any.
180 "projectNumber": "A String", # The project number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]181 "team": "A String", # The team.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 },
183 "email": "A String", # The email address associated with the entity, if any.
184 "selfLink": "A String", # The link to this access-control entry.
185}
186
187
188Returns:
189 An object of the form:
190
191 { # An access-control entry.
192 "domain": "A String", # The domain associated with the entity, if any.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]193 "generation": "A String", # The content generation of the object, if applied to an object.
194 "object": "A String", # The name of the object, if applied to an object.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]195 "bucket": "A String", # The name of the bucket.
196 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
197 "entity": "A String", # The entity holding the permission, in one of the following forms:
198 # - user-userId
199 # - user-email
200 # - group-groupId
201 # - group-email
202 # - domain-domain
203 # - project-team-projectId
204 # - allUsers
205 # - allAuthenticatedUsers Examples:
206 # - The user liz@example.com would be user-liz@example.com.
207 # - The group example@googlegroups.com would be group-example@googlegroups.com.
208 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
209 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]210 "role": "A String", # The access permission for the entity.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]211 "id": "A String", # The ID of the access-control entry.
212 "entityId": "A String", # The ID for the entity, if any.
213 "projectTeam": { # The project team associated with the entity, if any.
214 "projectNumber": "A String", # The project number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]215 "team": "A String", # The team.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]216 },
217 "email": "A String", # The email address associated with the entity, if any.
218 "selfLink": "A String", # The link to this access-control entry.
219 }</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="list">list(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
224 <pre>Retrieves default object ACL entries on the specified bucket.
225
226Args:
227 bucket: string, Name of a bucket. (required)
228 ifMetagenerationMatch: string, If present, only return default ACL listing if the bucket's current metageneration matches this value.
229 ifMetagenerationNotMatch: string, If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
230
231Returns:
232 An object of the form:
233
234 { # An access-control list.
235 "items": [ # The list of items.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]236 { # An access-control entry.
237 "domain": "A String", # The domain associated with the entity, if any.
238 "generation": "A String", # The content generation of the object, if applied to an object.
239 "object": "A String", # The name of the object, if applied to an object.
240 "bucket": "A String", # The name of the bucket.
241 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
242 "entity": "A String", # The entity holding the permission, in one of the following forms:
243 # - user-userId
244 # - user-email
245 # - group-groupId
246 # - group-email
247 # - domain-domain
248 # - project-team-projectId
249 # - allUsers
250 # - allAuthenticatedUsers Examples:
251 # - The user liz@example.com would be user-liz@example.com.
252 # - The group example@googlegroups.com would be group-example@googlegroups.com.
253 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
254 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
255 "role": "A String", # The access permission for the entity.
256 "id": "A String", # The ID of the access-control entry.
257 "entityId": "A String", # The ID for the entity, if any.
258 "projectTeam": { # The project team associated with the entity, if any.
259 "projectNumber": "A String", # The project number.
260 "team": "A String", # The team.
261 },
262 "email": "A String", # The email address associated with the entity, if any.
263 "selfLink": "A String", # The link to this access-control entry.
264 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]265 ],
266 "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
267 }</pre>
268</div>
269
270<div class="method">
271 <code class="details" id="patch">patch(bucket, entity, body)</code>
272 <pre>Updates a default object ACL entry on the specified bucket. This method supports patch semantics.
273
274Args:
275 bucket: string, Name of a bucket. (required)
276 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
277 body: object, The request body. (required)
278 The object takes the form of:
279
280{ # An access-control entry.
281 "domain": "A String", # The domain associated with the entity, if any.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]282 "generation": "A String", # The content generation of the object, if applied to an object.
283 "object": "A String", # The name of the object, if applied to an object.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]284 "bucket": "A String", # The name of the bucket.
285 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
286 "entity": "A String", # The entity holding the permission, in one of the following forms:
287 # - user-userId
288 # - user-email
289 # - group-groupId
290 # - group-email
291 # - domain-domain
292 # - project-team-projectId
293 # - allUsers
294 # - allAuthenticatedUsers Examples:
295 # - The user liz@example.com would be user-liz@example.com.
296 # - The group example@googlegroups.com would be group-example@googlegroups.com.
297 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
298 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]299 "role": "A String", # The access permission for the entity.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]300 "id": "A String", # The ID of the access-control entry.
301 "entityId": "A String", # The ID for the entity, if any.
302 "projectTeam": { # The project team associated with the entity, if any.
303 "projectNumber": "A String", # The project number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]304 "team": "A String", # The team.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]305 },
306 "email": "A String", # The email address associated with the entity, if any.
307 "selfLink": "A String", # The link to this access-control entry.
308}
309
310
311Returns:
312 An object of the form:
313
314 { # An access-control entry.
315 "domain": "A String", # The domain associated with the entity, if any.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]316 "generation": "A String", # The content generation of the object, if applied to an object.
317 "object": "A String", # The name of the object, if applied to an object.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]318 "bucket": "A String", # The name of the bucket.
319 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
320 "entity": "A String", # The entity holding the permission, in one of the following forms:
321 # - user-userId
322 # - user-email
323 # - group-groupId
324 # - group-email
325 # - domain-domain
326 # - project-team-projectId
327 # - allUsers
328 # - allAuthenticatedUsers Examples:
329 # - The user liz@example.com would be user-liz@example.com.
330 # - The group example@googlegroups.com would be group-example@googlegroups.com.
331 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
332 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]333 "role": "A String", # The access permission for the entity.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]334 "id": "A String", # The ID of the access-control entry.
335 "entityId": "A String", # The ID for the entity, if any.
336 "projectTeam": { # The project team associated with the entity, if any.
337 "projectNumber": "A String", # The project number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]338 "team": "A String", # The team.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]339 },
340 "email": "A String", # The email address associated with the entity, if any.
341 "selfLink": "A String", # The link to this access-control entry.
342 }</pre>
343</div>
344
345<div class="method">
346 <code class="details" id="update">update(bucket, entity, body)</code>
347 <pre>Updates a default object ACL entry on the specified bucket.
348
349Args:
350 bucket: string, Name of a bucket. (required)
351 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
352 body: object, The request body. (required)
353 The object takes the form of:
354
355{ # An access-control entry.
356 "domain": "A String", # The domain associated with the entity, if any.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]357 "generation": "A String", # The content generation of the object, if applied to an object.
358 "object": "A String", # The name of the object, if applied to an object.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]359 "bucket": "A String", # The name of the bucket.
360 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
361 "entity": "A String", # The entity holding the permission, in one of the following forms:
362 # - user-userId
363 # - user-email
364 # - group-groupId
365 # - group-email
366 # - domain-domain
367 # - project-team-projectId
368 # - allUsers
369 # - allAuthenticatedUsers Examples:
370 # - The user liz@example.com would be user-liz@example.com.
371 # - The group example@googlegroups.com would be group-example@googlegroups.com.
372 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
373 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]374 "role": "A String", # The access permission for the entity.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]375 "id": "A String", # The ID of the access-control entry.
376 "entityId": "A String", # The ID for the entity, if any.
377 "projectTeam": { # The project team associated with the entity, if any.
378 "projectNumber": "A String", # The project number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]379 "team": "A String", # The team.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]380 },
381 "email": "A String", # The email address associated with the entity, if any.
382 "selfLink": "A String", # The link to this access-control entry.
383}
384
385
386Returns:
387 An object of the form:
388
389 { # An access-control entry.
390 "domain": "A String", # The domain associated with the entity, if any.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]391 "generation": "A String", # The content generation of the object, if applied to an object.
392 "object": "A String", # The name of the object, if applied to an object.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]393 "bucket": "A String", # The name of the bucket.
394 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
395 "entity": "A String", # The entity holding the permission, in one of the following forms:
396 # - user-userId
397 # - user-email
398 # - group-groupId
399 # - group-email
400 # - domain-domain
401 # - project-team-projectId
402 # - allUsers
403 # - allAuthenticatedUsers Examples:
404 # - The user liz@example.com would be user-liz@example.com.
405 # - The group example@googlegroups.com would be group-example@googlegroups.com.
406 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
407 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]408 "role": "A String", # The access permission for the entity.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]409 "id": "A String", # The ID of the access-control entry.
410 "entityId": "A String", # The ID for the entity, if any.
411 "projectTeam": { # The project team associated with the entity, if any.
412 "projectNumber": "A String", # The project number.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]413 "team": "A String", # The team.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]414 },
415 "email": "A String", # The email address associated with the entity, if any.
416 "selfLink": "A String", # The link to this access-control entry.
417 }</pre>
418</div>
419
420</body></html>