Class ObjectACL (3.5.0)
- 3.5.0 (latest)
- 3.4.1
- 3.3.1
- 3.2.0
- 3.1.1
- 3.0.0
- 2.19.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.1
- 2.1.0
- 2.0.0
- 1.44.0
- 1.43.0
- 1.42.3
- 1.41.1
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.1
- 1.36.2
- 1.35.1
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.2
- 1.30.0
- 1.29.0
- 1.28.1
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
ObjectACL(blob)An ACL specifically for a Cloud Storage object / blob.
Parameter | |
|---|---|
| Name | Description |
blob | BlobThe blob that this ACL corresponds to. |
Properties
client
The client bound to this ACL's blob.
reload_path
Compute the path for GET API requests for this ACL.
save_path
Compute the path for PATCH API requests for this ACL.
user_project
Compute the user project charged for API requests for this ACL.
Methods
clear
clear(client=None,if_generation_match=None,if_generation_not_match=None,if_metageneration_match=None,if_metageneration_not_match=None,timeout=60,retry=google.api_core.retry.retry_unary.Retry,)Remove all ACL entries.
Ifuser_project is set, bills the API request to that project.
Note that this won't actually removeALL the rules, but itwill remove all the non-default rules. In short, you'll stillhave access to a bucket that you created even after you clearACL rules with this method.
| Parameters | |
|---|---|
| Name | Description |
client | Client or(Optional) The client to use. If not passed, falls back to the |
if_generation_match | long(Optional) See :ref: |
if_generation_not_match | long(Optional) See :ref: |
if_metageneration_match | long(Optional) See :ref: |
if_metageneration_not_match | long(Optional) See :ref: |
timeout | float or tuple(Optional) The amount of time, in seconds, to wait for the server response. See: |
retry | google.api_core.retry.Retry orgoogle.cloud.storage.retry.ConditionalRetryPolicy(Optional) How to retry the RPC. See: |
save
save(acl=None,client=None,if_generation_match=None,if_generation_not_match=None,if_metageneration_match=None,if_metageneration_not_match=None,timeout=60,retry=google.api_core.retry.retry_unary.Retry,)Save this ACL for the current object.
Ifuser_project is set, bills the API request to that project.
| Parameters | |
|---|---|
| Name | Description |
acl | ACL, or a compatible list.The ACL object to save. If left blank, this will save current entries. |
client | Client or(Optional) The client to use. If not passed, falls back to the |
if_generation_match | long(Optional) See :ref: |
if_generation_not_match | long(Optional) See :ref: |
if_metageneration_match | long(Optional) See :ref: |
if_metageneration_not_match | long(Optional) See :ref: |
timeout | float or tuple(Optional) The amount of time, in seconds, to wait for the server response. See: |
retry | google.api_core.retry.Retry orgoogle.cloud.storage.retry.ConditionalRetryPolicy(Optional) How to retry the RPC. See: |
save_predefined
save_predefined(predefined,client=None,if_generation_match=None,if_generation_not_match=None,if_metageneration_match=None,if_metageneration_not_match=None,timeout=60,retry=google.api_core.retry.retry_unary.Retry,)Save this ACL for the current object using a predefined ACL.
Ifuser_project is set, bills the API request to that project.
| Parameters | |
|---|---|
| Name | Description |
predefined | strAn identifier for a predefined ACL. Must be one of the keys in |
client | Client or(Optional) The client to use. If not passed, falls back to the |
if_generation_match | long(Optional) See :ref: |
if_generation_not_match | long(Optional) See :ref: |
if_metageneration_match | long(Optional) See :ref: |
if_metageneration_not_match | long(Optional) See :ref: |
timeout | float or tuple(Optional) The amount of time, in seconds, to wait for the server response. See: |
retry | google.api_core.retry.Retry orgoogle.cloud.storage.retry.ConditionalRetryPolicy(Optional) How to retry the RPC. See: |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-05 UTC.