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