bucket#

Exec module for managing Buckets.

async idem_gcp.exec.gcp.storage.bucket.list_(hub, ctx, project: str = None, prefix: str = None, projection: str = 'full')[source]#

Retrieves a list of buckets for a given project, ordered in the list lexicographically by name.

Parameters:

  • project (str, Optional) – Project ID for this request.

  • prefix (str, Optional) – Filter results to buckets whose names begin with this prefix.

  • projection (str, Optional) –

    Set of properties to return. Defaults to noAcl.

    Acceptable values are:

    • full: Include all properties.

    • noAcl: Omit owner, acl, and defaultObjectAcl properties.

Examples

random-name:
  exec.run:
  - path: gcp.storage.bucket.list
  - kwargs:
      project: project-name
      prefix: bucket-name-prefix
async idem_gcp.exec.gcp.storage.bucket.get(hub, ctx, resource_id: str = None, name: str = None, projection: str = 'full', user_project: str = None) → Dict[str, Any][source]#

Returns the specified bucket.

Parameters:

  • resource_id (str, Optional) – An identifier of the resource in the provider.

  • name (str, Optional) – Name of the bucket.

  • projection (str, Optional) –

    Set of properties to return. Defaults to noAcl. Acceptable values are:

    • full: Include all properties.

    • noAcl: Omit owner, acl, and defaultObjectAcl properties.

  • user_project (str, Optional) – The project to be billed for this request. Required for Requester Pays buckets.

Examples

random-name:
  exec.run:
  - path: gcp.storage.bucket.get
  - kwargs:
      name: bucket-name
async idem_gcp.exec.gcp.storage.bucket.lock_retention_policy(hub, ctx, if_metageneration_match: str, name: str = None, user_project: str = None, resource_id: str = None) → Dict[str, Any][source]#

Locks retention policy on a bucket.

Parameters:

  • if_metageneration_match (str) – Makes the operation conditional on whether bucket’s current metageneration matches the given value.

  • name (str, Optional) – Name of the bucket.

  • user_project (str, Optional) – The project to be billed for this request. Required for Requester Pays buckets.

  • resource_id (str, Optional) – An identifier of the resource in the provider.

Examples

random-name:
  exec.run:
  - path: gcp.storage.bucket.lock_retention_policy
  - kwargs:
      name: bucket-name