REST Resource: projects.locations.reportConfigs

Resource: ReportConfig

Message describing the ReportConfig object. ReportConfig is the configuration used to generate inventory reports. For information about how to set various fields, see Create an inventory report configuration.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "frequencyOptions": {
    object (FrequencyOptions)
  },
  "labels": {
    string: string,
    ...
  },
  "displayName": string,

  // Union field report_format can be only one of the following:
  "csvOptions": {
    object (CSVOptions)
  },
  "parquetOptions": {
    object (ParquetOptions)
  }
  // End of list of possible types for union field report_format.

  // Union field report_kind can be only one of the following:
  "objectMetadataReportOptions": {
    object (ObjectMetadataReportOptions)
  }
  // End of list of possible types for union field report_kind.
}
Fields
name

string

Identifier. Name of resource.

Format: projects/{projectId}/locations/{location}/reportConfigs/{report-config-id}.
createTime

string (Timestamp format)

Output only. The UTC time at which the inventory report configuration was created. This is auto-populated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The UTC time at which the inventory report configuration was updated. This is auto-populated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
frequencyOptions

object (FrequencyOptions)

The frequency of the inventory report generation.
labels

map (key: string, value: string)

Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

User provided display name that can be empty and limited to 256 characters that is editable..
Union field report_format. Format in which the inventory report is generated. report_format can be only one of the following:
csvOptions

object (CSVOptions)

Options for CSV formatted reports.
parquetOptions

object (ParquetOptions)

Options for Parquet formatted reports.
Union field report_kind. Configuration options for inventory report contents. report_kind can be only one of the following:
objectMetadataReportOptions

object (ObjectMetadataReportOptions)

Options for including object metadata in an inventory report.

FrequencyOptions

FrequencyOptions resource

Frequency configuration for inventory report generation.

JSON representation 
{
  "frequency": enum (Frequency),
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
frequency

enum (Frequency)

Frequency of inventory report generation.
startDate

object (Date)

The UTC date to start generating inventory reports. For example,{"day": 15, "month": 8, "year": 2022}.
endDate

object (Date)

The UTC date to stop generating inventory reports. For example,{"day": 15, "month": 8, "year": 2022}.

Frequency

The frequency at which the inventory reports are generated. Values are FREQUENCY_UNSPECIFIED, DAILY or WEEKLY.

Enums
FREQUENCY_UNSPECIFIED Unspecified.
DAILY Inventory report is generated daily.
WEEKLY Inventory report is generated weekly.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

  • A full date, with non-zero year, month, and day values.
  • A month and day, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

JSON representation 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

CSVOptions

Options to configure inventory reports in CSV format.

JSON representation 
{
  "recordSeparator": string,
  "delimiter": string,
  "headerRequired": boolean
}
Fields
recordSeparator

string

Record separator characters in CSV.
delimiter

string

Delimiter characters in CSV.
headerRequired

boolean

If set, includes a header row in the CSV report.

ParquetOptions

This type has no fields.

Options to configure inventory reports in Parquet format.

ObjectMetadataReportOptions

Options for including metadata in an inventory report.

JSON representation 
{
  "metadataFields": [
    string
  ],

  // Union field filter can be only one of the following:
  "storageFilters": {
    object (CloudStorageFilters)
  }
  // End of list of possible types for union field filter.

  // Union field destination_options can be only one of the following:
  "storageDestinationOptions": {
    object (CloudStorageDestinationOptions)
  }
  // End of list of possible types for union field destination_options.
}
Fields
metadataFields[]

string

The metadata fields included in an inventory report.
Union field filter. Filters buckets to generate inventory reports for Cloud Storage. filter can be only one of the following:
storageFilters

object (CloudStorageFilters)

Filters buckets to generate inventory reports for Cloud Storage.
Union field destination_options. Options to store reports in Cloud Storage. destination_options can be only one of the following:
storageDestinationOptions

object (CloudStorageDestinationOptions)

Options to store reports in Cloud Storage.

CloudStorageFilters

Filters buckets to generate inventory reports for Cloud Storage.

JSON representation 
{
  "bucket": string
}
Fields
bucket

string

Optional. Bucket for which the inventory report is generated.

CloudStorageDestinationOptions

Options to store inventory reports in Cloud Storage.

JSON representation 
{
  "bucket": string,
  "destinationPath": string
}
Fields
bucket

string

Optional. The destination bucket for the inventory reports.
destinationPath

string

The destination path within the bucket where the inventory reports are stored.

Methods

create

 Creates a new inventory report configuration in a given project for a given location.

delete

 Deletes an existing inventory report configuration in a given project for a given location.

get

 Gets the inventory report configuration in a given project for a given location.

list

 Lists the inventory report configurations in a given project for a given location.

patch

 Updates an existing inventory report configuration in a given project for a given location.