REST Resource: projects.locations.reportConfigs

资源：ReportConfig

用于描述 ReportConfig 对象的消息。ReportConfig 是用于生成清单报告的配置。如需了解如何设置各种字段，请参阅创建商品目录报告配置。

JSON 表示法 
{
  "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.
}
字段
name

string

标识符。资源的名称。

格式：projects/{projectId}/locations/{location}/reportConfigs/{report-config-id}。
createTime

string (Timestamp format)

仅限输出。资产清单报告配置的创建时间（世界协调时间 [UTC]）。系统会自动填充此值。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。更新资产清单报告配置的时间（世界协调时间）。系统会自动填充此值。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
frequencyOptions

object (FrequencyOptions)

生成商品目录报告的频率。
labels

map (key: string, value: string)

标签作为键值对

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
displayName

string

用户提供的显示名称（可为空），不得超过 256 个字符，且可修改。
联合字段 report_format。生成资产清单报告的格式。report_format 只能是下列其中一项：
csvOptions

object (CSVOptions)

CSV 格式报告的选项。
parquetOptions

object (ParquetOptions)

Parquet 格式报告的选项。
联合字段 report_kind。资产清单报告内容的配置选项。report_kind 只能是下列其中一项：
objectMetadataReportOptions

object (ObjectMetadataReportOptions)

在资产清单报告中添加对象元数据的选项。

FrequencyOptions

FrequencyOptions 项资源

资产清单报告生成的频率配置。

JSON 表示法 
{
  "frequency": enum (Frequency),
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
字段
frequency

enum (Frequency)

生成商品目录报告的频率。
startDate

object (Date)

开始生成资产清单报告的世界协调时间 (UTC) 日期。例如 {"day": 15, "month": 8, "year": 2022}。
endDate

object (Date)

停止生成商品目录报告的世界协调时间 (UTC) 日期。例如 {"day": 15, "month": 8, "year": 2022}。

频率

生成资产清单报告的频率。值为 FREQUENCY_UNSPECIFIED、DAILY 或 WEEKLY。

枚举
FREQUENCY_UNSPECIFIED 未指定。
DAILY 系统每天生成一次商品目录报告。
WEEKLY 系统每周生成一次商品目录报告。

日期

表示整个或部分日历日期（例如生日）。一天中的时间和时区要么在别处指定，要么不重要。日期相对于公历。可以表示以下任一情况：

  • 包含非零年份、月份和天值的完整日期。
  • 月份和天，年份值为零（例如周年纪念日）。
  • 单独的年份，月份和天值为零。
  • 年份和月份，天值为零（例如，信用卡到期日期）。

相关类型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
字段
year

integer

日期中的年份。必须介于 1 到 9999 之间，或为 0（即指定不含年份的日期）。
month

integer

一年中的第几个月。必须介于 1 到 12 之间，或为 0（即只指定年份，不指定月份和天值）。
day

integer

一个月中的第几天。必须介于 1 到 31 之间并且对年份和月份有效，或为 0（即天不重要，指定单独的年份或者年份和月份）。

CSVOptions

用于以 CSV 格式配置商品目录报告的选项。

JSON 表示法 
{
  "recordSeparator": string,
  "delimiter": string,
  "headerRequired": boolean
}
字段
recordSeparator

string

CSV 中的记录分隔符字符。
delimiter

string

CSV 中的分隔符字符。
headerRequired

boolean

如果设置，则在 CSV 报告中包含标题行。

ParquetOptions

此类型没有字段。

用于以 Parquet 格式配置资产清单报告的选项。

ObjectMetadataReportOptions

在资产清单报告中添加元数据的选项。

JSON 表示法 
{
  "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.
}
字段
metadataFields[]

string

库存报告中包含的元数据字段。
联合字段 filter。过滤存储分区以生成 Cloud Storage 资产清单报告。filter 只能是下列其中一项：
storageFilters

object (CloudStorageFilters)

过滤存储分区，以便为 Cloud Storage 生成清单报告。
联合字段 destination_options。用于在 Cloud Storage 中存储报告的选项。destination_options 只能是下列其中一项：
storageDestinationOptions

object (CloudStorageDestinationOptions)

用于在 Cloud Storage 中存储报告的选项。

CloudStorageFilters

过滤存储分区，以便为 Cloud Storage 生成清单报告。

JSON 表示法 
{
  "bucket": string
}
字段
bucket

string

可选。用于生成资产清单报告的存储分区。

CloudStorageDestinationOptions

用于在 Cloud Storage 中存储商品目录报告的选项。

JSON 表示法 
{
  "bucket": string,
  "destinationPath": string
}
字段
bucket

string

可选。库存报告的目标存储分区。
destinationPath

string

存储库存报告的存储分区中的目标路径。

方法

create

 在给定项目中为给定位置创建新的商品目录报告配置。

delete

 删除给定项目中给定位置的现有商品目录报告配置。

get

 获取给定项目中给定位置的商品目录报告配置。

list

 列出给定项目中给定位置的资产清单报告配置。

patch

 更新给定项目中给定位置的现有清单报告配置。