1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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="#delete">delete(bucket, entity, userProject=None)</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, userProject=None)</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, userProject=None)</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, userProject=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, userProject=None)</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, userProject=None)</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, userProject=None)</code> 98 <pre>Permanently deletes the default object ACL entry for the specified entity on the specified bucket. 99 100 Args: 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 userProject: string, The project number to be billed for this request, for Requester Pays buckets. 104 </pre> 105 </div> 106 107 <div class="method"> 108 <code class="details" id="get">get(bucket, entity, userProject=None)</code> 109 <pre>Returns the default object ACL entry for the specified entity on the specified bucket. 110 111 Args: 112 bucket: string, Name of a bucket. (required) 113 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 114 userProject: string, The project number to be billed for this request, for Requester Pays buckets. 115 116 Returns: 117 An object of the form: 118 119 { # An access-control entry. 120 "domain": "A String", # The domain associated with the entity, if any. 121 "generation": "A String", # The content generation of the object, if applied to an object. 122 "object": "A String", # The name of the object, if applied to an object. 123 "bucket": "A String", # The name of the bucket. 124 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 125 "entity": "A String", # The entity holding the permission, in one of the following forms: 126 # - user-userId 127 # - user-email 128 # - group-groupId 129 # - group-email 130 # - domain-domain 131 # - project-team-projectId 132 # - allUsers 133 # - allAuthenticatedUsers Examples: 134 # - The user liz (a] example.com would be user-liz (a] example.com. 135 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 136 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 137 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 138 "role": "A String", # The access permission for the entity. 139 "id": "A String", # The ID of the access-control entry. 140 "entityId": "A String", # The ID for the entity, if any. 141 "projectTeam": { # The project team associated with the entity, if any. 142 "projectNumber": "A String", # The project number. 143 "team": "A String", # The team. 144 }, 145 "email": "A String", # The email address associated with the entity, if any. 146 "selfLink": "A String", # The link to this access-control entry. 147 }</pre> 148 </div> 149 150 <div class="method"> 151 <code class="details" id="insert">insert(bucket, body, userProject=None)</code> 152 <pre>Creates a new default object ACL entry on the specified bucket. 153 154 Args: 155 bucket: string, Name of a bucket. (required) 156 body: object, The request body. (required) 157 The object takes the form of: 158 159 { # An access-control entry. 160 "domain": "A String", # The domain associated with the entity, if any. 161 "generation": "A String", # The content generation of the object, if applied to an object. 162 "object": "A String", # The name of the object, if applied to an object. 163 "bucket": "A String", # The name of the bucket. 164 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 165 "entity": "A String", # The entity holding the permission, in one of the following forms: 166 # - user-userId 167 # - user-email 168 # - group-groupId 169 # - group-email 170 # - domain-domain 171 # - project-team-projectId 172 # - allUsers 173 # - allAuthenticatedUsers Examples: 174 # - The user liz (a] example.com would be user-liz (a] example.com. 175 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 176 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 177 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 178 "role": "A String", # The access permission for the entity. 179 "id": "A String", # The ID of the access-control entry. 180 "entityId": "A String", # The ID for the entity, if any. 181 "projectTeam": { # The project team associated with the entity, if any. 182 "projectNumber": "A String", # The project number. 183 "team": "A String", # The team. 184 }, 185 "email": "A String", # The email address associated with the entity, if any. 186 "selfLink": "A String", # The link to this access-control entry. 187 } 188 189 userProject: string, The project number to be billed for this request, for Requester Pays buckets. 190 191 Returns: 192 An object of the form: 193 194 { # An access-control entry. 195 "domain": "A String", # The domain associated with the entity, if any. 196 "generation": "A String", # The content generation of the object, if applied to an object. 197 "object": "A String", # The name of the object, if applied to an object. 198 "bucket": "A String", # The name of the bucket. 199 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 200 "entity": "A String", # The entity holding the permission, in one of the following forms: 201 # - user-userId 202 # - user-email 203 # - group-groupId 204 # - group-email 205 # - domain-domain 206 # - project-team-projectId 207 # - allUsers 208 # - allAuthenticatedUsers Examples: 209 # - The user liz (a] example.com would be user-liz (a] example.com. 210 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 211 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 212 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 213 "role": "A String", # The access permission for the entity. 214 "id": "A String", # The ID of the access-control entry. 215 "entityId": "A String", # The ID for the entity, if any. 216 "projectTeam": { # The project team associated with the entity, if any. 217 "projectNumber": "A String", # The project number. 218 "team": "A String", # The team. 219 }, 220 "email": "A String", # The email address associated with the entity, if any. 221 "selfLink": "A String", # The link to this access-control entry. 222 }</pre> 223 </div> 224 225 <div class="method"> 226 <code class="details" id="list">list(bucket, ifMetagenerationMatch=None, userProject=None, ifMetagenerationNotMatch=None)</code> 227 <pre>Retrieves default object ACL entries on the specified bucket. 228 229 Args: 230 bucket: string, Name of a bucket. (required) 231 ifMetagenerationMatch: string, If present, only return default ACL listing if the bucket's current metageneration matches this value. 232 userProject: string, The project number to be billed for this request, for Requester Pays buckets. 233 ifMetagenerationNotMatch: string, If present, only return default ACL listing if the bucket's current metageneration does not match the given value. 234 235 Returns: 236 An object of the form: 237 238 { # An access-control list. 239 "items": [ # The list of items. 240 { # An access-control entry. 241 "domain": "A String", # The domain associated with the entity, if any. 242 "generation": "A String", # The content generation of the object, if applied to an object. 243 "object": "A String", # The name of the object, if applied to an object. 244 "bucket": "A String", # The name of the bucket. 245 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 246 "entity": "A String", # The entity holding the permission, in one of the following forms: 247 # - user-userId 248 # - user-email 249 # - group-groupId 250 # - group-email 251 # - domain-domain 252 # - project-team-projectId 253 # - allUsers 254 # - allAuthenticatedUsers Examples: 255 # - The user liz (a] example.com would be user-liz (a] example.com. 256 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 257 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 258 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 259 "role": "A String", # The access permission for the entity. 260 "id": "A String", # The ID of the access-control entry. 261 "entityId": "A String", # The ID for the entity, if any. 262 "projectTeam": { # The project team associated with the entity, if any. 263 "projectNumber": "A String", # The project number. 264 "team": "A String", # The team. 265 }, 266 "email": "A String", # The email address associated with the entity, if any. 267 "selfLink": "A String", # The link to this access-control entry. 268 }, 269 ], 270 "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. 271 }</pre> 272 </div> 273 274 <div class="method"> 275 <code class="details" id="patch">patch(bucket, entity, body, userProject=None)</code> 276 <pre>Updates a default object ACL entry on the specified bucket. This method supports patch semantics. 277 278 Args: 279 bucket: string, Name of a bucket. (required) 280 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 281 body: object, The request body. (required) 282 The object takes the form of: 283 284 { # An access-control entry. 285 "domain": "A String", # The domain associated with the entity, if any. 286 "generation": "A String", # The content generation of the object, if applied to an object. 287 "object": "A String", # The name of the object, if applied to an object. 288 "bucket": "A String", # The name of the bucket. 289 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 290 "entity": "A String", # The entity holding the permission, in one of the following forms: 291 # - user-userId 292 # - user-email 293 # - group-groupId 294 # - group-email 295 # - domain-domain 296 # - project-team-projectId 297 # - allUsers 298 # - allAuthenticatedUsers Examples: 299 # - The user liz (a] example.com would be user-liz (a] example.com. 300 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 301 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 302 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 303 "role": "A String", # The access permission for the entity. 304 "id": "A String", # The ID of the access-control entry. 305 "entityId": "A String", # The ID for the entity, if any. 306 "projectTeam": { # The project team associated with the entity, if any. 307 "projectNumber": "A String", # The project number. 308 "team": "A String", # The team. 309 }, 310 "email": "A String", # The email address associated with the entity, if any. 311 "selfLink": "A String", # The link to this access-control entry. 312 } 313 314 userProject: string, The project number to be billed for this request, for Requester Pays buckets. 315 316 Returns: 317 An object of the form: 318 319 { # An access-control entry. 320 "domain": "A String", # The domain associated with the entity, if any. 321 "generation": "A String", # The content generation of the object, if applied to an object. 322 "object": "A String", # The name of the object, if applied to an object. 323 "bucket": "A String", # The name of the bucket. 324 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 325 "entity": "A String", # The entity holding the permission, in one of the following forms: 326 # - user-userId 327 # - user-email 328 # - group-groupId 329 # - group-email 330 # - domain-domain 331 # - project-team-projectId 332 # - allUsers 333 # - allAuthenticatedUsers Examples: 334 # - The user liz (a] example.com would be user-liz (a] example.com. 335 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 336 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 337 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 338 "role": "A String", # The access permission for the entity. 339 "id": "A String", # The ID of the access-control entry. 340 "entityId": "A String", # The ID for the entity, if any. 341 "projectTeam": { # The project team associated with the entity, if any. 342 "projectNumber": "A String", # The project number. 343 "team": "A String", # The team. 344 }, 345 "email": "A String", # The email address associated with the entity, if any. 346 "selfLink": "A String", # The link to this access-control entry. 347 }</pre> 348 </div> 349 350 <div class="method"> 351 <code class="details" id="update">update(bucket, entity, body, userProject=None)</code> 352 <pre>Updates a default object ACL entry on the specified bucket. 353 354 Args: 355 bucket: string, Name of a bucket. (required) 356 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 357 body: object, The request body. (required) 358 The object takes the form of: 359 360 { # An access-control entry. 361 "domain": "A String", # The domain associated with the entity, if any. 362 "generation": "A String", # The content generation of the object, if applied to an object. 363 "object": "A String", # The name of the object, if applied to an object. 364 "bucket": "A String", # The name of the bucket. 365 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 366 "entity": "A String", # The entity holding the permission, in one of the following forms: 367 # - user-userId 368 # - user-email 369 # - group-groupId 370 # - group-email 371 # - domain-domain 372 # - project-team-projectId 373 # - allUsers 374 # - allAuthenticatedUsers Examples: 375 # - The user liz (a] example.com would be user-liz (a] example.com. 376 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 377 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 378 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 379 "role": "A String", # The access permission for the entity. 380 "id": "A String", # The ID of the access-control entry. 381 "entityId": "A String", # The ID for the entity, if any. 382 "projectTeam": { # The project team associated with the entity, if any. 383 "projectNumber": "A String", # The project number. 384 "team": "A String", # The team. 385 }, 386 "email": "A String", # The email address associated with the entity, if any. 387 "selfLink": "A String", # The link to this access-control entry. 388 } 389 390 userProject: string, The project number to be billed for this request, for Requester Pays buckets. 391 392 Returns: 393 An object of the form: 394 395 { # An access-control entry. 396 "domain": "A String", # The domain associated with the entity, if any. 397 "generation": "A String", # The content generation of the object, if applied to an object. 398 "object": "A String", # The name of the object, if applied to an object. 399 "bucket": "A String", # The name of the bucket. 400 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 401 "entity": "A String", # The entity holding the permission, in one of the following forms: 402 # - user-userId 403 # - user-email 404 # - group-groupId 405 # - group-email 406 # - domain-domain 407 # - project-team-projectId 408 # - allUsers 409 # - allAuthenticatedUsers Examples: 410 # - The user liz (a] example.com would be user-liz (a] example.com. 411 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 412 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 413 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 414 "role": "A String", # The access permission for the entity. 415 "id": "A String", # The ID of the access-control entry. 416 "entityId": "A String", # The ID for the entity, if any. 417 "projectTeam": { # The project team associated with the entity, if any. 418 "projectNumber": "A String", # The project number. 419 "team": "A String", # The team. 420 }, 421 "email": "A String", # The email address associated with the entity, if any. 422 "selfLink": "A String", # The link to this access-control entry. 423 }</pre> 424 </div> 425 426 </body></html>
