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