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

ID。リソースの名前。

形式: 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)

出力専用。インベントリ レポートの構成が更新された時間（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"。
frequencyOptions

object (FrequencyOptions)

インベントリ レポートの生成頻度。
labels

map (key: string, value: string)

Key-Value ペアとしてのラベル

"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

インベントリ レポートが生成される頻度。値は FREQUENCY_UNSPECIFIED、DAILY、または WEEKLY です。

列挙型
FREQUENCY_UNSPECIFIED 未設定。
DAILY インベントリ レポートは毎日生成されます。
WEEKLY インベントリ レポートは毎週生成されます。

Date

誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付は西暦を基準にしており、次のいずれかを表します。

  • 年の値がゼロ以外である月と日の値を含む完全な日付
  • 年の値がゼロである月と日（記念日など）。
  • 月と日の値がゼロである単独の年。
  • 日の値がゼロである年と月（クレジット カードの有効期限など）

関連するタイプ:

JSON 表現 
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

その日付の年。1～9999、または年のない日付を指定する場合は 0 にする必要があります。
month

integer

1 年の中の月。1～12、または月と日のない年を指定する場合は 0 にする必要があります。
day

integer

1 月の中の日付。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

 指定されたプロジェクトの特定のロケーションにある既存のインベントリ レポート構成を更新します。