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_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.defaultObjectAccessControls.html">defaultObjectAccessControls</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(bucket, entity, provisionalUserProject=None, userProject=None)</a></code></p> 82<p class="firstline">Permanently deletes the default object ACL entry for the specified entity on the specified bucket.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(bucket, entity, provisionalUserProject=None, userProject=None)</a></code></p> 85<p class="firstline">Returns the default object ACL entry for the specified entity on the specified bucket.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(bucket, body=None, provisionalUserProject=None, userProject=None)</a></code></p> 88<p class="firstline">Creates a new default object ACL entry on the specified bucket.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, provisionalUserProject=None, userProject=None)</a></code></p> 91<p class="firstline">Retrieves default object ACL entries on the specified bucket.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</a></code></p> 94<p class="firstline">Patches a default object ACL entry on the specified bucket.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</a></code></p> 97<p class="firstline">Updates a default object ACL entry on the specified bucket.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="delete">delete(bucket, entity, provisionalUserProject=None, userProject=None)</code> 106 <pre>Permanently deletes the default object ACL entry for the specified entity on the specified bucket. 107 108Args: 109 bucket: string, Name of a bucket. (required) 110 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 111 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 112 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 113</pre> 114</div> 115 116<div class="method"> 117 <code class="details" id="get">get(bucket, entity, provisionalUserProject=None, userProject=None)</code> 118 <pre>Returns the default object ACL entry for the specified entity on the specified bucket. 119 120Args: 121 bucket: string, Name of a bucket. (required) 122 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 123 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 124 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 125 126Returns: 127 An object of the form: 128 129 { # An access-control entry. 130 "bucket": "A String", # The name of the bucket. 131 "domain": "A String", # The domain associated with the entity, if any. 132 "email": "A String", # The email address associated with the entity, if any. 133 "entity": "A String", # The entity holding the permission, in one of the following forms: 134 # - user-userId 135 # - user-email 136 # - group-groupId 137 # - group-email 138 # - domain-domain 139 # - project-team-projectId 140 # - allUsers 141 # - allAuthenticatedUsers Examples: 142 # - The user liz@example.com would be user-liz@example.com. 143 # - The group example@googlegroups.com would be group-example@googlegroups.com. 144 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 145 "entityId": "A String", # The ID for the entity, if any. 146 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 147 "generation": "A String", # The content generation of the object, if applied to an object. 148 "id": "A String", # The ID of the access-control entry. 149 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 150 "object": "A String", # The name of the object, if applied to an object. 151 "projectTeam": { # The project team associated with the entity, if any. 152 "projectNumber": "A String", # The project number. 153 "team": "A String", # The team. 154 }, 155 "role": "A String", # The access permission for the entity. 156 "selfLink": "A String", # The link to this access-control entry. 157}</pre> 158</div> 159 160<div class="method"> 161 <code class="details" id="insert">insert(bucket, body=None, provisionalUserProject=None, userProject=None)</code> 162 <pre>Creates a new default object ACL entry on the specified bucket. 163 164Args: 165 bucket: string, Name of a bucket. (required) 166 body: object, The request body. 167 The object takes the form of: 168 169{ # An access-control entry. 170 "bucket": "A String", # The name of the bucket. 171 "domain": "A String", # The domain associated with the entity, if any. 172 "email": "A String", # The email address associated with the entity, if any. 173 "entity": "A String", # The entity holding the permission, in one of the following forms: 174 # - user-userId 175 # - user-email 176 # - group-groupId 177 # - group-email 178 # - domain-domain 179 # - project-team-projectId 180 # - allUsers 181 # - allAuthenticatedUsers Examples: 182 # - The user liz@example.com would be user-liz@example.com. 183 # - The group example@googlegroups.com would be group-example@googlegroups.com. 184 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 185 "entityId": "A String", # The ID for the entity, if any. 186 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 187 "generation": "A String", # The content generation of the object, if applied to an object. 188 "id": "A String", # The ID of the access-control entry. 189 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 190 "object": "A String", # The name of the object, if applied to an object. 191 "projectTeam": { # The project team associated with the entity, if any. 192 "projectNumber": "A String", # The project number. 193 "team": "A String", # The team. 194 }, 195 "role": "A String", # The access permission for the entity. 196 "selfLink": "A String", # The link to this access-control entry. 197} 198 199 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 200 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 201 202Returns: 203 An object of the form: 204 205 { # An access-control entry. 206 "bucket": "A String", # The name of the bucket. 207 "domain": "A String", # The domain associated with the entity, if any. 208 "email": "A String", # The email address associated with the entity, if any. 209 "entity": "A String", # The entity holding the permission, in one of the following forms: 210 # - user-userId 211 # - user-email 212 # - group-groupId 213 # - group-email 214 # - domain-domain 215 # - project-team-projectId 216 # - allUsers 217 # - allAuthenticatedUsers Examples: 218 # - The user liz@example.com would be user-liz@example.com. 219 # - The group example@googlegroups.com would be group-example@googlegroups.com. 220 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 221 "entityId": "A String", # The ID for the entity, if any. 222 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 223 "generation": "A String", # The content generation of the object, if applied to an object. 224 "id": "A String", # The ID of the access-control entry. 225 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 226 "object": "A String", # The name of the object, if applied to an object. 227 "projectTeam": { # The project team associated with the entity, if any. 228 "projectNumber": "A String", # The project number. 229 "team": "A String", # The team. 230 }, 231 "role": "A String", # The access permission for the entity. 232 "selfLink": "A String", # The link to this access-control entry. 233}</pre> 234</div> 235 236<div class="method"> 237 <code class="details" id="list">list(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, provisionalUserProject=None, userProject=None)</code> 238 <pre>Retrieves default object ACL entries on the specified bucket. 239 240Args: 241 bucket: string, Name of a bucket. (required) 242 ifMetagenerationMatch: string, If present, only return default ACL listing if the bucket's current metageneration matches this value. 243 ifMetagenerationNotMatch: string, If present, only return default ACL listing if the bucket's current metageneration does not match the given value. 244 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 245 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 246 247Returns: 248 An object of the form: 249 250 { # An access-control list. 251 "items": [ # The list of items. 252 { # An access-control entry. 253 "bucket": "A String", # The name of the bucket. 254 "domain": "A String", # The domain associated with the entity, if any. 255 "email": "A String", # The email address associated with the entity, if any. 256 "entity": "A String", # The entity holding the permission, in one of the following forms: 257 # - user-userId 258 # - user-email 259 # - group-groupId 260 # - group-email 261 # - domain-domain 262 # - project-team-projectId 263 # - allUsers 264 # - allAuthenticatedUsers Examples: 265 # - The user liz@example.com would be user-liz@example.com. 266 # - The group example@googlegroups.com would be group-example@googlegroups.com. 267 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 268 "entityId": "A String", # The ID for the entity, if any. 269 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 270 "generation": "A String", # The content generation of the object, if applied to an object. 271 "id": "A String", # The ID of the access-control entry. 272 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 273 "object": "A String", # The name of the object, if applied to an object. 274 "projectTeam": { # The project team associated with the entity, if any. 275 "projectNumber": "A String", # The project number. 276 "team": "A String", # The team. 277 }, 278 "role": "A String", # The access permission for the entity. 279 "selfLink": "A String", # The link to this access-control entry. 280 }, 281 ], 282 "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. 283}</pre> 284</div> 285 286<div class="method"> 287 <code class="details" id="patch">patch(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</code> 288 <pre>Patches a default object ACL entry on the specified bucket. 289 290Args: 291 bucket: string, Name of a bucket. (required) 292 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 293 body: object, The request body. 294 The object takes the form of: 295 296{ # An access-control entry. 297 "bucket": "A String", # The name of the bucket. 298 "domain": "A String", # The domain associated with the entity, if any. 299 "email": "A String", # The email address associated with the entity, if any. 300 "entity": "A String", # The entity holding the permission, in one of the following forms: 301 # - user-userId 302 # - user-email 303 # - group-groupId 304 # - group-email 305 # - domain-domain 306 # - project-team-projectId 307 # - allUsers 308 # - allAuthenticatedUsers Examples: 309 # - The user liz@example.com would be user-liz@example.com. 310 # - The group example@googlegroups.com would be group-example@googlegroups.com. 311 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 312 "entityId": "A String", # The ID for the entity, if any. 313 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 314 "generation": "A String", # The content generation of the object, if applied to an object. 315 "id": "A String", # The ID of the access-control entry. 316 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 317 "object": "A String", # The name of the object, if applied to an object. 318 "projectTeam": { # The project team associated with the entity, if any. 319 "projectNumber": "A String", # The project number. 320 "team": "A String", # The team. 321 }, 322 "role": "A String", # The access permission for the entity. 323 "selfLink": "A String", # The link to this access-control entry. 324} 325 326 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 327 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 328 329Returns: 330 An object of the form: 331 332 { # An access-control entry. 333 "bucket": "A String", # The name of the bucket. 334 "domain": "A String", # The domain associated with the entity, if any. 335 "email": "A String", # The email address associated with the entity, if any. 336 "entity": "A String", # The entity holding the permission, in one of the following forms: 337 # - user-userId 338 # - user-email 339 # - group-groupId 340 # - group-email 341 # - domain-domain 342 # - project-team-projectId 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 "entityId": "A String", # The ID for the entity, if any. 349 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 350 "generation": "A String", # The content generation of the object, if applied to an object. 351 "id": "A String", # The ID of the access-control entry. 352 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 353 "object": "A String", # The name of the object, if applied to an object. 354 "projectTeam": { # The project team associated with the entity, if any. 355 "projectNumber": "A String", # The project number. 356 "team": "A String", # The team. 357 }, 358 "role": "A String", # The access permission for the entity. 359 "selfLink": "A String", # The link to this access-control entry. 360}</pre> 361</div> 362 363<div class="method"> 364 <code class="details" id="update">update(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</code> 365 <pre>Updates a default object ACL entry on the specified bucket. 366 367Args: 368 bucket: string, Name of a bucket. (required) 369 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 370 body: object, The request body. 371 The object takes the form of: 372 373{ # An access-control entry. 374 "bucket": "A String", # The name of the bucket. 375 "domain": "A String", # The domain associated with the entity, if any. 376 "email": "A String", # The email address associated with the entity, if any. 377 "entity": "A String", # The entity holding the permission, in one of the following forms: 378 # - user-userId 379 # - user-email 380 # - group-groupId 381 # - group-email 382 # - domain-domain 383 # - project-team-projectId 384 # - allUsers 385 # - allAuthenticatedUsers Examples: 386 # - The user liz@example.com would be user-liz@example.com. 387 # - The group example@googlegroups.com would be group-example@googlegroups.com. 388 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 389 "entityId": "A String", # The ID for the entity, if any. 390 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 391 "generation": "A String", # The content generation of the object, if applied to an object. 392 "id": "A String", # The ID of the access-control entry. 393 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 394 "object": "A String", # The name of the object, if applied to an object. 395 "projectTeam": { # The project team associated with the entity, if any. 396 "projectNumber": "A String", # The project number. 397 "team": "A String", # The team. 398 }, 399 "role": "A String", # The access permission for the entity. 400 "selfLink": "A String", # The link to this access-control entry. 401} 402 403 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 404 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 405 406Returns: 407 An object of the form: 408 409 { # An access-control entry. 410 "bucket": "A String", # The name of the bucket. 411 "domain": "A String", # The domain associated with the entity, if any. 412 "email": "A String", # The email address associated with the entity, if any. 413 "entity": "A String", # The entity holding the permission, in one of the following forms: 414 # - user-userId 415 # - user-email 416 # - group-groupId 417 # - group-email 418 # - domain-domain 419 # - project-team-projectId 420 # - allUsers 421 # - allAuthenticatedUsers Examples: 422 # - The user liz@example.com would be user-liz@example.com. 423 # - The group example@googlegroups.com would be group-example@googlegroups.com. 424 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 425 "entityId": "A String", # The ID for the entity, if any. 426 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 427 "generation": "A String", # The content generation of the object, if applied to an object. 428 "id": "A String", # The ID of the access-control entry. 429 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 430 "object": "A String", # The name of the object, if applied to an object. 431 "projectTeam": { # The project team associated with the entity, if any. 432 "projectNumber": "A String", # The project number. 433 "team": "A String", # The team. 434 }, 435 "role": "A String", # The access permission for the entity. 436 "selfLink": "A String", # The link to this access-control entry. 437}</pre> 438</div> 439 440</body></html>