Tests a set of permissions on the given managed folder to see which, if any, are held by the caller.

Method Details

close()

Close httplib2 connections.

delete(bucket, managedFolder, allowNonEmpty=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)

Permanently deletes a managed folder.

Args:
  bucket: string, Name of the bucket containing the managed folder. (required)
  managedFolder: string, The managed folder name/path. (required)
  allowNonEmpty: boolean, Allows the deletion of a managed folder even if it is not empty. A managed folder is empty if there are no objects or managed folders that it applies to. Callers must have storage.managedFolders.setIamPolicy permission.
  ifMetagenerationMatch: string, If set, only deletes the managed folder if its metageneration matches this value.
  ifMetagenerationNotMatch: string, If set, only deletes the managed folder if its metageneration does not match this value.

get(bucket, managedFolder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)

Returns metadata of the specified managed folder.

Args:
  bucket: string, Name of the bucket containing the managed folder. (required)
  managedFolder: string, The managed folder name/path. (required)
  ifMetagenerationMatch: string, Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration matches the given value.
  ifMetagenerationNotMatch: string, Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration does not match the given value.

Returns:
  An object of the form:

    { # A managed folder.
  "bucket": "A String", # The name of the bucket containing this managed folder.
  "createTime": "A String", # The creation time of the managed folder in RFC 3339 format.
  "id": "A String", # The ID of the managed folder, including the bucket name and managed folder name.
  "kind": "storage#managedFolder", # The kind of item this is. For managed folders, this is always storage#managedFolder.
  "metageneration": "A String", # The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.
  "name": "A String", # The name of the managed folder. Required if not specified by URL parameter.
  "selfLink": "A String", # The link to this managed folder.
  "updateTime": "A String", # The last update time of the managed folder metadata in RFC 3339 format.
}

getIamPolicy(bucket, managedFolder, optionsRequestedPolicyVersion=None, userProject=None)

Returns an IAM policy for the specified managed folder.

Args:
bucket: string, Name of the bucket containing the managed folder. (required)
managedFolder: string, The managed folder name/path. (required)
optionsRequestedPolicyVersion: integer, The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Returns:
An object of the form:

{ # A bucket/object/managedFolder IAM policy.
"bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
{
"condition": { # Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" # The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
"description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
"location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
# - allUsers — A special identifier that represents anyone on the internet; with or without a Google account.
# - allAuthenticatedUsers — A special identifier that represents anyone who is authenticated with a Google account or a service account.
# - user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com.
# - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
# - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
# - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
# - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
# - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
# - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
"A String",
],
"role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
# The new IAM roles are:
# - roles/storage.admin — Full control of Google Cloud Storage resources.
# - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
# - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
# - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
# - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
# - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
# - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
# - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
# - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
},
],
"etag": "A String", # HTTP 1.1 Entity tag for the policy.
"kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
"resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
"version": 42, # The IAM policy format version.
}

insert(bucket, body=None)

Creates a new managed folder.

Args:
bucket: string, Name of the bucket containing the managed folder. (required)
body: object, The request body.
The object takes the form of:

{ # A managed folder.
"bucket": "A String", # The name of the bucket containing this managed folder.
"createTime": "A String", # The creation time of the managed folder in RFC 3339 format.
"id": "A String", # The ID of the managed folder, including the bucket name and managed folder name.
"kind": "storage#managedFolder", # The kind of item this is. For managed folders, this is always storage#managedFolder.
"metageneration": "A String", # The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.
"name": "A String", # The name of the managed folder. Required if not specified by URL parameter.
"selfLink": "A String", # The link to this managed folder.
"updateTime": "A String", # The last update time of the managed folder metadata in RFC 3339 format.
}

Returns:
An object of the form:

list(bucket, pageSize=None, pageToken=None, prefix=None)

Lists managed folders in the given bucket.

Args:
  bucket: string, Name of the bucket containing the managed folder. (required)
  pageSize: integer, Maximum number of items to return in a single page of responses.
  pageToken: string, A previously-returned page token representing part of the larger set of results to view.
  prefix: string, The managed folder name/path prefix to filter the output list of results.

Returns:
  An object of the form:

    { # A list of managed folders.
  "items": [ # The list of items.
    { # A managed folder.
      "bucket": "A String", # The name of the bucket containing this managed folder.
      "createTime": "A String", # The creation time of the managed folder in RFC 3339 format.
      "id": "A String", # The ID of the managed folder, including the bucket name and managed folder name.
      "kind": "storage#managedFolder", # The kind of item this is. For managed folders, this is always storage#managedFolder.
      "metageneration": "A String", # The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.
      "name": "A String", # The name of the managed folder. Required if not specified by URL parameter.
      "selfLink": "A String", # The link to this managed folder.
      "updateTime": "A String", # The last update time of the managed folder metadata in RFC 3339 format.
    },
  ],
  "kind": "storage#managedFolders", # The kind of item this is. For lists of managed folders, this is always storage#managedFolders.
  "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

setIamPolicy(bucket, managedFolder, body=None, userProject=None)

Updates an IAM policy for the specified managed folder.

Args:
  bucket: string, Name of the bucket containing the managed folder. (required)
  managedFolder: string, The managed folder name/path. (required)
  body: object, The request body.
    The object takes the form of:

{ # A bucket/object/managedFolder IAM policy.
  "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
    {
      "condition": { # Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" # The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
        "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
        "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
          # - allUsers — A special identifier that represents anyone on the internet; with or without a Google account.
          # - allAuthenticatedUsers — A special identifier that represents anyone who is authenticated with a Google account or a service account.
          # - user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com.
          # - serviceAccount:emailid — An email address that represents a service account. For example,  serviceAccount:my-other-app@appspot.gserviceaccount.com .
          # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
          # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
          # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
          # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
          # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
        "A String",
      ],
      "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
          # The new IAM roles are:
          # - roles/storage.admin — Full control of Google Cloud Storage resources.
          # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
          # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
          # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects.   The legacy IAM roles are:
          # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
          # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
          # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
          # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
          # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
    },
  ],
  "etag": "A String", # HTTP 1.1  Entity tag for the policy.
  "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
  "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
  "version": 42, # The IAM policy format version.
}

  userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Returns:
  An object of the form:

    { # A bucket/object/managedFolder IAM policy.
  "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
    {
      "condition": { # Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" # The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
        "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
        "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
          # - allUsers — A special identifier that represents anyone on the internet; with or without a Google account.
          # - allAuthenticatedUsers — A special identifier that represents anyone who is authenticated with a Google account or a service account.
          # - user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com.
          # - serviceAccount:emailid — An email address that represents a service account. For example,  serviceAccount:my-other-app@appspot.gserviceaccount.com .
          # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
          # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
          # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
          # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
          # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
        "A String",
      ],
      "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
          # The new IAM roles are:
          # - roles/storage.admin — Full control of Google Cloud Storage resources.
          # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
          # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
          # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects.   The legacy IAM roles are:
          # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
          # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
          # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
          # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
          # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
    },
  ],
  "etag": "A String", # HTTP 1.1  Entity tag for the policy.
  "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
  "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
  "version": 42, # The IAM policy format version.
}

testIamPermissions(bucket, managedFolder, permissions, userProject=None)

Tests a set of permissions on the given managed folder to see which, if any, are held by the caller.

Args:
  bucket: string, Name of the bucket containing the managed folder. (required)
  managedFolder: string, The managed folder name/path. (required)
  permissions: string, Permissions to test. (required) (repeated)
  userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Returns:
  An object of the form:

    { # A storage.(buckets|objects|managedFolders).testIamPermissions response.
  "kind": "storage#testIamPermissionsResponse", # The kind of item this is.
  "permissions": [ # The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets, objects, or managedFolders. The supported permissions are as follows:
      # - storage.buckets.delete — Delete bucket.
      # - storage.buckets.get — Read bucket metadata.
      # - storage.buckets.getIamPolicy — Read bucket IAM policy.
      # - storage.buckets.create — Create bucket.
      # - storage.buckets.list — List buckets.
      # - storage.buckets.setIamPolicy — Update bucket IAM policy.
      # - storage.buckets.update — Update bucket metadata.
      # - storage.objects.delete — Delete object.
      # - storage.objects.get — Read object data and metadata.
      # - storage.objects.getIamPolicy — Read object IAM policy.
      # - storage.objects.create — Create object.
      # - storage.objects.list — List objects.
      # - storage.objects.setIamPolicy — Update object IAM policy.
      # - storage.objects.update — Update object metadata.
      # - storage.managedFolders.delete — Delete managed folder.
      # - storage.managedFolders.get — Read managed folder metadata.
      # - storage.managedFolders.getIamPolicy — Read managed folder IAM policy.
      # - storage.managedFolders.create — Create managed folder.
      # - storage.managedFolders.list — List managed folders.
      # - storage.managedFolders.setIamPolicy — Update managed folder IAM policy.
    "A String",
  ],
}

Cloud Storage JSON API . managedFolders

Instance Methods

Method Details