REST Resource: projects.databases.backupSchedules

リソース: BackupSchedule

Cloud Firestore データベースのバックアップ スケジュール。

このリソースは、バックアップ対象のデータベースによって所有され、データベースとともに削除されます。実際のバックアップはそうではありません。

JSON 表現 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "retention": string,

  // Union field recurrence can be only one of the following:
  "dailyRecurrence": {
    object (DailyRecurrence)
  },
  "weeklyRecurrence": {
    object (WeeklyRecurrence)
  }
  // End of list of possible types for union field recurrence.
}
フィールド
name

string

出力専用。指定されたプロジェクトのすべてのロケーションとデータベースにまたがる一意のバックアップ スケジュール ID。

これは自動的に割り当てられます。

形式は projects/{project}/databases/{database}/backupSchedules/{backupSchedule} です
createTime

string (Timestamp format)

出力専用。このバックアップ スケジュールが作成されてから有効になった時点のタイムスタンプ。

このスケジュールのバックアップは、この時間より前に作成されません。

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

string (Timestamp format)

出力専用。このバックアップ スケジュールが最後に更新されたタイムスタンプ。バックアップ スケジュールを最初に作成したときは、createTime と同じです。

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

string (Duration format)

バックアップを作成時点と比較して、将来の相対的な時刻（例:バックアップを 7 日間保持します

サポートされる最大保持期間は 14 週間です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
共用体フィールド recurrence。バックアップが作成されるタイミングを表す oneof フィールド。recurrence は次のいずれかになります。
dailyRecurrence

object (DailyRecurrence)

毎日実行されるスケジュールの場合。
weeklyRecurrence

object (WeeklyRecurrence)

毎週特定の日に実行するスケジュールの場合。

1 日の繰り返し

この型にはフィールドがありません。

毎日実行される定期的なスケジュールを表します。

タイムゾーンは UTC です。

WeeklyRecurrence（週ごとの繰り返し）

指定された曜日に実行される定期的なスケジュールを表します。

タイムゾーンは UTC です。

JSON 表現 
{
  "day": enum (DayOfWeek)
}
フィールド
day

enum (DayOfWeek)

実行する曜日。

DAY_OF_WEEK_UNSPECIFIED は使用できません。

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日が指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY Wednesday
THURSDAY 木曜日
FRIDAY Friday
SATURDAY Saturday
SUNDAY 日曜日

メソッド

create

 データベースのバックアップ スケジュールを作成します。

delete

 バックアップ スケジュールを削除します。

get

 バックアップ スケジュールに関する情報を取得します。

list

 バックアップ スケジュールを一覧表示します。

patch

 バックアップ スケジュールを更新します。