Console
    Contact Us Start free

    Class ObjectACL (3.3.0) 

      ObjectACL 
 ( 
 blob 
 )

    An ACL specifically for a Cloud Storage object / blob.

    Parameter

    Name
    Description
    blob
    Blob

    The 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 
 object 
> )

    Remove all ACL entries.

    If user_project is set, bills the API request to that project.

    Note that this won't actually remove ALL the rules, but it will remove all the non-default rules. In short, you'll still have access to a bucket that you created even after you clear ACL rules with this method.

    Parameters
    Name
    Description
    client
    Client or NoneType

    (Optional) The client to use. If not passed, falls back to the client stored on the ACL's parent.

    if_generation_match
    long

    (Optional) See :ref: using-if-generation-match

    if_generation_not_match
    long

    (Optional) See :ref: using-if-generation-not-match

    if_metageneration_match
    long

    (Optional) See :ref: using-if-metageneration-match

    if_metageneration_not_match
    long

    (Optional) See :ref: using-if-metageneration-not-match

    timeout
    float or tuple

    (Optional) The amount of time, in seconds, to wait for the server response. See: configuring_timeouts

    retry
    google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy

    (Optional) How to retry the RPC. See: configuring_retries

    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 
 object 
> )

    Save this ACL for the current object.

    If user_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 NoneType

    (Optional) The client to use. If not passed, falls back to the client stored on the ACL's parent.

    if_generation_match
    long

    (Optional) See :ref: using-if-generation-match

    if_generation_not_match
    long

    (Optional) See :ref: using-if-generation-not-match

    if_metageneration_match
    long

    (Optional) See :ref: using-if-metageneration-match

    if_metageneration_not_match
    long

    (Optional) See :ref: using-if-metageneration-not-match

    timeout
    float or tuple

    (Optional) The amount of time, in seconds, to wait for the server response. See: configuring_timeouts

    retry
    google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy

    (Optional) How to retry the RPC. See: configuring_retries

    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 
 object 
> )

    Save this ACL for the current object using a predefined ACL.

    If user_project is set, bills the API request to that project.

    Parameters
    Name
    Description
    predefined
    str

    An identifier for a predefined ACL. Must be one of the keys in PREDEFINED_JSON_ACLS or PREDEFINED_XML_ACLS (which will be aliased to the corresponding JSON name). If passed, acl must be None.

    client
    Client or NoneType

    (Optional) The client to use. If not passed, falls back to the client stored on the ACL's parent.

    if_generation_match
    long

    (Optional) See :ref: using-if-generation-match

    if_generation_not_match
    long

    (Optional) See :ref: using-if-generation-not-match

    if_metageneration_match
    long

    (Optional) See :ref: using-if-metageneration-match

    if_metageneration_not_match
    long

    (Optional) See :ref: using-if-metageneration-not-match

    timeout
    float or tuple

    (Optional) The amount of time, in seconds, to wait for the server response. See: configuring_timeouts

    retry
    google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy

    (Optional) How to retry the RPC. See: configuring_retries

    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: