ReportConfig

Represents an inventory report configuration.

For general information about inventory report configurations in Cloud Storage, see the Storage Insights inventory reports documentation.

{
  "ReportConfig": {
    "name": string,
    "frequency_options": {
      "frequency": "enum",
      "start_date": {
        "day": integer,
        "month": integer,
        "year": integer
      },
      "end_date": {
        "day": integer,
        "month": integer,
        "year": integer,
      }
    },
    "csv_options": {
      "record_separator": string,
      "delimiter": string,
      "header_required": boolean
    },
    "parquet_options": {},
    "object_metadata_report_options": {
      "metadata_fields": [
        string
      ],
      "storage_filters": {
        "bucket": string
      },
      "storage_destination_options": {
        "bucket": string,
        "destination_path": string
      }
      "display_name": string,
      "create_time": "datetime",
      "update_time": "datetime"
    }
  }
}

Property name	Value	Description	Notes
ReportConfig	object	The inventory report configuration that generates inventory reports.
name	string	The name of the inventory report configuration, which follows the format projects/project/locations/location/reportConfigs/report-config-id, where report-config-id is the UUID of the inventory report configuration.
create_time	datetime	The UTC time at which the inventory report configuration was created. This is auto-populated.
update_time	datetime	The UTC time at which the inventory report configuration was updated. This is auto-populated.
frequency_options	object	Options for configuring how inventory reports are generated.	Writable
frequency_options.frequency	enum	The frequency in which inventory reports are generated. Values are DAILY or WEEKLY.	Writable
frequency_options.start_date	object	The UTC date to start generating inventory reports. For example, {"day": 15, "month": 8, "year": 2022}.	Writable
frequency_options.end_date	object	The UTC date to stop generating inventory reports. For example, {"day": 15, "month": 9, "year": 2022}.	Writable
csv_options	object	Options for configuring the format of the inventory report CSV file. If included, parquet_options cannot be included. If neither parquet_options nor csv_options are specified during the creation of an inventory report configuration, the inventory report configuration defaults to using csv_options.	Writable
csv_options.record_separator	string	The character used to separate the records in the inventory report CSV file.	Writable
csv_options.delimiter	string	The delimiter used to separate the fields in the inventory report CSV file.	Writable
csv_options.header_required	boolean	The boolean that indicates whether or not headers are included in the inventory report CSV file.	Writable
parquet_options	object	An option for outputting inventory reports as parquet files. Value must be an empty object. If included, csv_options cannot be included.	Writable
object_metadata_report_options	object	Options for including metadata in an inventory report.	Writable
object_metadata_report_options.metadata_fields	list	The metadata fields included in an inventory report.	Writable
object_metadata_report_options.storage_filters.bucket	string	The filter to use when specifying which bucket to generate inventory reports for.	Writable
object_metadata_report_options.storage_destination_options	object	Options for where the inventory reports are stored.	Writable
object_metadata_report_options.storage_destination_options.bucket	string	The destination bucket that stores the generated inventory reports.	Writable
object_metadata_report_options.storage_destination_options.destination_path	string	The path within the destination bucket to store generated inventory reports.	Writable
display_name	string	The editable display name of the inventory report configuration. Has a limit of 256 characters. Can be empty.	Writable

Methods

delete

Deletes an inventory report configuration.

get

Retrieves an inventory report configuration.

insert

Creates an inventory report configuration.

list

Lists all inventory report configurations for a given project.

patch

Updates an inventory report configuration.