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