REST Resource: projects.locations.backups

リソース: バックアップ

Cloud Firestore データベースのバックアップ。

バックアップには、特定の時点における特定のデータベースのすべてのドキュメントとインデックス構成が含まれます。

JSON 表現
{
  "name": string,
  "database": string,
  "databaseUid": string,
  "snapshotTime": string,
  "expireTime": string,
  "state": enum (State)
}
フィールド
name

string

出力専用。バックアップの一意のリソース名。

形式は projects/{project}/locations/{location}/backups/{backup} です。

database

string

出力専用。バックアップ元の Firestore データベースの名前。

形式は projects/{project}/databases/{database} です。

databaseUid

string

出力専用。バックアップ元の Firestore データベースのシステム生成 UUID4。

snapshotTime

string (Timestamp format)

出力専用。この時点で、バックアップにはデータベースの外部整合性のあるコピーが含まれています。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

expireTime

string (Timestamp format)

出力専用。このバックアップが期限切れになるタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

state

enum (State)

出力専用。バックアップの現在の状態。

状態

バックアップの現在の状態を示します。

列挙型
STATE_UNSPECIFIED 状態は指定されていません。
CREATING 保留中のバックアップはまだ作成中です。この状態では、バックアップに対するオペレーションは拒否されます。
READY バックアップが完了し、使用できるようになりました。
NOT_AVAILABLE 現在、バックアップを利用できません。

メソッド

delete

バックアップを削除します。

get

バックアップに関する情報を取得します。

list

すべてのバックアップを一覧表示します。