Skip to main content
Inventory configures periodic generation of an object listing for a bucket.

Schema

Required

  • destination_bucket_id (String) ID of the destination bucket.
  • output_format (String) : Inventory format.

    Supported values

    Possible values:
    • OUTPUT_FORMAT_UNSPECIFIED
    • CSV_GZIP - CSV compressed with GZIP.
    • PARQUET_SNAPPY - Parquet compressed with Snappy.
  • schedule (String) : How often to generate the inventory.

    Supported values

    Possible values:
    • SCHEDULE_UNSPECIFIED
    • DAILY - Run once a day.
    • WEEKLY - Run once a week.

Optional

  • destination_prefix (String) Prefix under which bucket inventory will be stored in the destination bucket.
  • enabled (Boolean) Enable or disable inventory generation.
  • labels (Map of String) Labels associated with the resource.
  • metadata (Attributes) :

    Inner value description

    Common resource metadata. (see below for nested schema)
  • name (String) Human readable name for the resource.
  • noncurrent_versions (Boolean) Include noncurrent versions in inventory if set to true.
  • optional_fields (List of String) : Optional fields to include in inventory.

    Supported values

    Possible values:
    • OPTIONAL_FIELD_UNSPECIFIED
    • LAST_ACCESS - Timestamp of the last access.
    • CHECKSUM_ALGORITHMS - Checksum algorithms used.
    • INTELLIGENT_TIER - Current intelligent tier (for Intelligent Storage Class).
    • IS_MULTIPART_UPLOAD - True for multipart uploads, false for simple objects.
    • LIFECYCLE_EXPIRATION - Timestamp of lifecycle expiration.
    • TAGS - Object tags.
  • parent_id (String) Identifier of the parent resource to which the resource belongs.
  • source_prefix (String) Prefix to filter objects in the source bucket.

Read-Only

  • created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • id (String) Identifier for the resource, unique for its resource type.
  • labels_all (Map of String) Effective labels sent to the API after merging provider default_labels with resource labels.
  • resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
  • status (Attributes) (see below for nested schema)
  • updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

Nested Schema for metadata

Nested Schema for status