• 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.bucketAccessControls.html">bucketAccessControls</a></h1>
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 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 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 ACL entry on the specified bucket.</p>
86<p class="toc_element">
87  <code><a href="#list">list(bucket)</a></code></p>
88<p class="firstline">Retrieves 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 an 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 an 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 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 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.
119      "bucket": "A String", # The name of the bucket.
120      "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
121      "entity": "A String", # The entity holding the permission, in one of the following forms:
122          # - user-userId
123          # - user-email
124          # - group-groupId
125          # - group-email
126          # - domain-domain
127          # - allUsers
128          # - allAuthenticatedUsers Examples:
129          # - The user liz@example.com would be user-liz@example.com.
130          # - The group example@googlegroups.com would be group-example@googlegroups.com.
131          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
132      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
133      "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
134      "id": "A String", # The ID of the access-control entry.
135      "entityId": "A String", # The ID for the entity, if any.
136      "email": "A String", # The email address associated with the entity, if any.
137      "selfLink": "A String", # The link to this access-control entry.
138    }</pre>
139</div>
140
141<div class="method">
142    <code class="details" id="insert">insert(bucket, body)</code>
143  <pre>Creates a new ACL entry on the specified bucket.
144
145Args:
146  bucket: string, Name of a bucket. (required)
147  body: object, The request body. (required)
148    The object takes the form of:
149
150{ # An access-control entry.
151    "domain": "A String", # The domain associated with the entity, if any.
152    "bucket": "A String", # The name of the bucket.
153    "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
154    "entity": "A String", # The entity holding the permission, in one of the following forms:
155        # - user-userId
156        # - user-email
157        # - group-groupId
158        # - group-email
159        # - domain-domain
160        # - allUsers
161        # - allAuthenticatedUsers Examples:
162        # - The user liz@example.com would be user-liz@example.com.
163        # - The group example@googlegroups.com would be group-example@googlegroups.com.
164        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
165    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
166    "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
167    "id": "A String", # The ID of the access-control entry.
168    "entityId": "A String", # The ID for the entity, if any.
169    "email": "A String", # The email address associated with the entity, if any.
170    "selfLink": "A String", # The link to this access-control entry.
171  }
172
173
174Returns:
175  An object of the form:
176
177    { # An access-control entry.
178      "domain": "A String", # The domain associated with the entity, if any.
179      "bucket": "A String", # The name of the bucket.
180      "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
181      "entity": "A String", # The entity holding the permission, in one of the following forms:
182          # - user-userId
183          # - user-email
184          # - group-groupId
185          # - group-email
186          # - domain-domain
187          # - allUsers
188          # - allAuthenticatedUsers Examples:
189          # - The user liz@example.com would be user-liz@example.com.
190          # - The group example@googlegroups.com would be group-example@googlegroups.com.
191          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
192      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
193      "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
194      "id": "A String", # The ID of the access-control entry.
195      "entityId": "A String", # The ID for the entity, if any.
196      "email": "A String", # The email address associated with the entity, if any.
197      "selfLink": "A String", # The link to this access-control entry.
198    }</pre>
199</div>
200
201<div class="method">
202    <code class="details" id="list">list(bucket)</code>
203  <pre>Retrieves ACL entries on the specified bucket.
204
205Args:
206  bucket: string, Name of a bucket. (required)
207
208Returns:
209  An object of the form:
210
211    { # An access-control list.
212    "items": [ # The list of items.
213      { # An access-control entry.
214          "domain": "A String", # The domain associated with the entity, if any.
215          "bucket": "A String", # The name of the bucket.
216          "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
217          "entity": "A String", # The entity holding the permission, in one of the following forms:
218              # - user-userId
219              # - user-email
220              # - group-groupId
221              # - group-email
222              # - domain-domain
223              # - allUsers
224              # - allAuthenticatedUsers Examples:
225              # - The user liz@example.com would be user-liz@example.com.
226              # - The group example@googlegroups.com would be group-example@googlegroups.com.
227              # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
228          "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
229          "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
230          "id": "A String", # The ID of the access-control entry.
231          "entityId": "A String", # The ID for the entity, if any.
232          "email": "A String", # The email address associated with the entity, if any.
233          "selfLink": "A String", # The link to this access-control entry.
234        },
235    ],
236    "kind": "storage#bucketAccessControls", # The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.
237  }</pre>
238</div>
239
240<div class="method">
241    <code class="details" id="patch">patch(bucket, entity, body)</code>
242  <pre>Updates an ACL entry on the specified bucket. This method supports patch semantics.
243
244Args:
245  bucket: string, Name of a bucket. (required)
246  entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
247  body: object, The request body. (required)
248    The object takes the form of:
249
250{ # An access-control entry.
251    "domain": "A String", # The domain associated with the entity, if any.
252    "bucket": "A String", # The name of the bucket.
253    "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
254    "entity": "A String", # The entity holding the permission, in one of the following forms:
255        # - user-userId
256        # - user-email
257        # - group-groupId
258        # - group-email
259        # - domain-domain
260        # - allUsers
261        # - allAuthenticatedUsers Examples:
262        # - The user liz@example.com would be user-liz@example.com.
263        # - The group example@googlegroups.com would be group-example@googlegroups.com.
264        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
265    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
266    "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
267    "id": "A String", # The ID of the access-control entry.
268    "entityId": "A String", # The ID for the entity, if any.
269    "email": "A String", # The email address associated with the entity, if any.
270    "selfLink": "A String", # The link to this access-control entry.
271  }
272
273
274Returns:
275  An object of the form:
276
277    { # An access-control entry.
278      "domain": "A String", # The domain associated with the entity, if any.
279      "bucket": "A String", # The name of the bucket.
280      "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
281      "entity": "A String", # The entity holding the permission, in one of the following forms:
282          # - user-userId
283          # - user-email
284          # - group-groupId
285          # - group-email
286          # - domain-domain
287          # - allUsers
288          # - allAuthenticatedUsers Examples:
289          # - The user liz@example.com would be user-liz@example.com.
290          # - The group example@googlegroups.com would be group-example@googlegroups.com.
291          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
292      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
293      "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
294      "id": "A String", # The ID of the access-control entry.
295      "entityId": "A String", # The ID for the entity, if any.
296      "email": "A String", # The email address associated with the entity, if any.
297      "selfLink": "A String", # The link to this access-control entry.
298    }</pre>
299</div>
300
301<div class="method">
302    <code class="details" id="update">update(bucket, entity, body)</code>
303  <pre>Updates an ACL entry on the specified bucket.
304
305Args:
306  bucket: string, Name of a bucket. (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    "bucket": "A String", # The name of the bucket.
314    "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
315    "entity": "A String", # The entity holding the permission, in one of the following forms:
316        # - user-userId
317        # - user-email
318        # - group-groupId
319        # - group-email
320        # - domain-domain
321        # - allUsers
322        # - allAuthenticatedUsers Examples:
323        # - The user liz@example.com would be user-liz@example.com.
324        # - The group example@googlegroups.com would be group-example@googlegroups.com.
325        # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
326    "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
327    "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
328    "id": "A String", # The ID of the access-control entry.
329    "entityId": "A String", # The ID for the entity, if any.
330    "email": "A String", # The email address associated with the entity, if any.
331    "selfLink": "A String", # The link to this access-control entry.
332  }
333
334
335Returns:
336  An object of the form:
337
338    { # An access-control entry.
339      "domain": "A String", # The domain associated with the entity, if any.
340      "bucket": "A String", # The name of the bucket.
341      "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
342      "entity": "A String", # The entity holding the permission, in one of the following forms:
343          # - user-userId
344          # - user-email
345          # - group-groupId
346          # - group-email
347          # - domain-domain
348          # - allUsers
349          # - allAuthenticatedUsers Examples:
350          # - The user liz@example.com would be user-liz@example.com.
351          # - The group example@googlegroups.com would be group-example@googlegroups.com.
352          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
353      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
354      "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
355      "id": "A String", # The ID of the access-control entry.
356      "entityId": "A String", # The ID for the entity, if any.
357      "email": "A String", # The email address associated with the entity, if any.
358      "selfLink": "A String", # The link to this access-control entry.
359    }</pre>
360</div>
361
362</body></html>