• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
75<h1><a href="storage_v1beta2.html">Cloud Storage JSON API</a> . <a href="storage_v1beta2.objectAccessControls.html">objectAccessControls</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(bucket, object, entity, generation=None)</a></code></p>
79<p class="firstline">Permanently deletes the ACL entry for the specified entity on the specified object.</p>
80<p class="toc_element">
81  <code><a href="#get">get(bucket, object, entity, generation=None)</a></code></p>
82<p class="firstline">Returns the ACL entry for the specified entity on the specified object.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(bucket, object, body, generation=None)</a></code></p>
85<p class="firstline">Creates a new ACL entry on the specified object.</p>
86<p class="toc_element">
87  <code><a href="#list">list(bucket, object, generation=None)</a></code></p>
88<p class="firstline">Retrieves ACL entries on the specified object.</p>
89<p class="toc_element">
90  <code><a href="#patch">patch(bucket, object, entity, body, generation=None)</a></code></p>
91<p class="firstline">Updates an ACL entry on the specified object. This method supports patch semantics.</p>
92<p class="toc_element">
93  <code><a href="#update">update(bucket, object, entity, body, generation=None)</a></code></p>
94<p class="firstline">Updates an ACL entry on the specified object.</p>
95<h3>Method Details</h3>
96<div class="method">
97    <code class="details" id="delete">delete(bucket, object, entity, generation=None)</code>
98  <pre>Permanently deletes the ACL entry for the specified entity on the specified object.
99
100Args:
101  bucket: string, Name of a bucket. (required)
102  object: string, Name of the object. (required)
103  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
104  generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
105</pre>
106</div>
107
108<div class="method">
109    <code class="details" id="get">get(bucket, object, entity, generation=None)</code>
110  <pre>Returns the ACL entry for the specified entity on the specified object.
111
112Args:
113  bucket: string, Name of a bucket. (required)
114  object: string, Name of the object. (required)
115  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
116  generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
117
118Returns:
119  An object of the form:
120
121    { # An access-control entry.
122    "domain": "A String", # The domain associated with the entity, if any.
123    "generation": "A String", # The content generation of the object.
124    "object": "A String", # The name of the object.
125    "bucket": "A String", # The name of the bucket.
126    "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
127    "entity": "A String", # The entity holding the permission, in one of the following forms:
128        # - user-userId
129        # - user-email
130        # - group-groupId
131        # - group-email
132        # - domain-domain
133        # - allUsers
134        # - allAuthenticatedUsers Examples:
135        # - The user liz@example.com would be user-liz@example.com.
136        # - The group example@googlegroups.com would be group-example@googlegroups.com.
137        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
138    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
139    "role": "A String", # The access permission for the entity. Can be READER or OWNER.
140    "id": "A String", # The ID of the access-control entry.
141    "entityId": "A String", # The ID for the entity, if any.
142    "email": "A String", # The email address associated with the entity, if any.
143    "selfLink": "A String", # The link to this access-control entry.
144  }</pre>
145</div>
146
147<div class="method">
148    <code class="details" id="insert">insert(bucket, object, body, generation=None)</code>
149  <pre>Creates a new ACL entry on the specified object.
150
151Args:
152  bucket: string, Name of a bucket. (required)
153  object: string, Name of the object. (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.
159  "generation": "A String", # The content generation of the object.
160  "object": "A String", # The name of the object.
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      # - allUsers
170      # - allAuthenticatedUsers Examples:
171      # - The user liz@example.com would be user-liz@example.com.
172      # - The group example@googlegroups.com would be group-example@googlegroups.com.
173      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
174  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
175  "role": "A String", # The access permission for the entity. Can be READER or OWNER.
176  "id": "A String", # The ID of the access-control entry.
177  "entityId": "A String", # The ID for the entity, if any.
178  "email": "A String", # The email address associated with the entity, if any.
179  "selfLink": "A String", # The link to this access-control entry.
180}
181
182  generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
183
184Returns:
185  An object of the form:
186
187    { # An access-control entry.
188    "domain": "A String", # The domain associated with the entity, if any.
189    "generation": "A String", # The content generation of the object.
190    "object": "A String", # The name of the object.
191    "bucket": "A String", # The name of the bucket.
192    "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
193    "entity": "A String", # The entity holding the permission, in one of the following forms:
194        # - user-userId
195        # - user-email
196        # - group-groupId
197        # - group-email
198        # - domain-domain
199        # - allUsers
200        # - allAuthenticatedUsers Examples:
201        # - The user liz@example.com would be user-liz@example.com.
202        # - The group example@googlegroups.com would be group-example@googlegroups.com.
203        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
204    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
205    "role": "A String", # The access permission for the entity. Can be READER or OWNER.
206    "id": "A String", # The ID of the access-control entry.
207    "entityId": "A String", # The ID for the entity, if any.
208    "email": "A String", # The email address associated with the entity, if any.
209    "selfLink": "A String", # The link to this access-control entry.
210  }</pre>
211</div>
212
213<div class="method">
214    <code class="details" id="list">list(bucket, object, generation=None)</code>
215  <pre>Retrieves ACL entries on the specified object.
216
217Args:
218  bucket: string, Name of a bucket. (required)
219  object: string, Name of the object. (required)
220  generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
221
222Returns:
223  An object of the form:
224
225    { # An access-control list.
226    "items": [ # The list of items.
227      "",
228    ],
229    "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
230  }</pre>
231</div>
232
233<div class="method">
234    <code class="details" id="patch">patch(bucket, object, entity, body, generation=None)</code>
235  <pre>Updates an ACL entry on the specified object. This method supports patch semantics.
236
237Args:
238  bucket: string, Name of a bucket. (required)
239  object: string, Name of the object. (required)
240  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
241  body: object, The request body. (required)
242    The object takes the form of:
243
244{ # An access-control entry.
245  "domain": "A String", # The domain associated with the entity, if any.
246  "generation": "A String", # The content generation of the object.
247  "object": "A String", # The name of the object.
248  "bucket": "A String", # The name of the bucket.
249  "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
250  "entity": "A String", # The entity holding the permission, in one of the following forms:
251      # - user-userId
252      # - user-email
253      # - group-groupId
254      # - group-email
255      # - domain-domain
256      # - allUsers
257      # - allAuthenticatedUsers Examples:
258      # - The user liz@example.com would be user-liz@example.com.
259      # - The group example@googlegroups.com would be group-example@googlegroups.com.
260      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
261  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
262  "role": "A String", # The access permission for the entity. Can be READER or OWNER.
263  "id": "A String", # The ID of the access-control entry.
264  "entityId": "A String", # The ID for the entity, if any.
265  "email": "A String", # The email address associated with the entity, if any.
266  "selfLink": "A String", # The link to this access-control entry.
267}
268
269  generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
270
271Returns:
272  An object of the form:
273
274    { # An access-control entry.
275    "domain": "A String", # The domain associated with the entity, if any.
276    "generation": "A String", # The content generation of the object.
277    "object": "A String", # The name of the object.
278    "bucket": "A String", # The name of the bucket.
279    "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
280    "entity": "A String", # The entity holding the permission, in one of the following forms:
281        # - user-userId
282        # - user-email
283        # - group-groupId
284        # - group-email
285        # - domain-domain
286        # - allUsers
287        # - allAuthenticatedUsers Examples:
288        # - The user liz@example.com would be user-liz@example.com.
289        # - The group example@googlegroups.com would be group-example@googlegroups.com.
290        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
291    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
292    "role": "A String", # The access permission for the entity. Can be READER or OWNER.
293    "id": "A String", # The ID of the access-control entry.
294    "entityId": "A String", # The ID for the entity, if any.
295    "email": "A String", # The email address associated with the entity, if any.
296    "selfLink": "A String", # The link to this access-control entry.
297  }</pre>
298</div>
299
300<div class="method">
301    <code class="details" id="update">update(bucket, object, entity, body, generation=None)</code>
302  <pre>Updates an ACL entry on the specified object.
303
304Args:
305  bucket: string, Name of a bucket. (required)
306  object: string, Name of the object. (required)
307  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
308  body: object, The request body. (required)
309    The object takes the form of:
310
311{ # An access-control entry.
312  "domain": "A String", # The domain associated with the entity, if any.
313  "generation": "A String", # The content generation of the object.
314  "object": "A String", # The name of the object.
315  "bucket": "A String", # The name of the bucket.
316  "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
317  "entity": "A String", # The entity holding the permission, in one of the following forms:
318      # - user-userId
319      # - user-email
320      # - group-groupId
321      # - group-email
322      # - domain-domain
323      # - allUsers
324      # - allAuthenticatedUsers Examples:
325      # - The user liz@example.com would be user-liz@example.com.
326      # - The group example@googlegroups.com would be group-example@googlegroups.com.
327      # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
328  "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
329  "role": "A String", # The access permission for the entity. Can be READER or OWNER.
330  "id": "A String", # The ID of the access-control entry.
331  "entityId": "A String", # The ID for the entity, if any.
332  "email": "A String", # The email address associated with the entity, if any.
333  "selfLink": "A String", # The link to this access-control entry.
334}
335
336  generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
337
338Returns:
339  An object of the form:
340
341    { # An access-control entry.
342    "domain": "A String", # The domain associated with the entity, if any.
343    "generation": "A String", # The content generation of the object.
344    "object": "A String", # The name of the object.
345    "bucket": "A String", # The name of the bucket.
346    "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
347    "entity": "A String", # The entity holding the permission, in one of the following forms:
348        # - user-userId
349        # - user-email
350        # - group-groupId
351        # - group-email
352        # - domain-domain
353        # - allUsers
354        # - allAuthenticatedUsers Examples:
355        # - The user liz@example.com would be user-liz@example.com.
356        # - The group example@googlegroups.com would be group-example@googlegroups.com.
357        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
358    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
359    "role": "A String", # The access permission for the entity. Can be READER or OWNER.
360    "id": "A String", # The ID of the access-control entry.
361    "entityId": "A String", # The ID for the entity, if any.
362    "email": "A String", # The email address associated with the entity, if any.
363    "selfLink": "A String", # The link to this access-control entry.
364  }</pre>
365</div>
366
367</body></html>