REST Resource: projects.locations.schedules

リソース: スケジュール

スケジュールの定義。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "cronSchedule": string,
  "timeZone": string,
  "createTime": string,
  "updateTime": string,
  "executionTemplate": {
    object (ExecutionTemplate)
  },
  "recentExecutions": [
    {
      object (Execution)
    }
  ]
}
フィールド
name

string

出力専用。このスケジュールの名前。形式: projects/{projectId}/locations/{location}/schedules/{scheduleId}
displayName

string

出力専用。UI で使用される表示名。名前に使用できるのは、英数字、ハイフン -、アンダースコア _ のみです。
description

string

この環境の簡単な説明。
state

enum (State)
cronSchedule

string

ジョブが実行される cron-tab 形式のスケジュール。形式: 分、時、日、月、曜日（例: 0 0 * * WED = 毎週水曜日）。その他の例: https://crontab.guru/examples.html
timeZone

string

cronSchedule のタイムゾーン。このフィールドの値は、tz database から取得したタイムゾーン名にする必要があります。TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

一部のタイムゾーンには、夏時間の規定が含まれています。夏時間のルールは、選択した tz によって決まります。UTC の場合は、「utc」という文字列を使用します。タイムゾーンが指定されていない場合、デフォルトは UTC（GMT ともいう）になります。
createTime

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"。
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"。
executionTemplate

object (ExecutionTemplate)

このスケジュールに対応するノートブック実行テンプレート。
recentExecutions[]

object (Execution)

出力専用。このスケジュールからトリガーされた最新の実行名とその対応する状態。

状態

ジョブの状態。

列挙型
STATE_UNSPECIFIED 未指定の状態
ENABLED ジョブは正常に実行されています。
PAUSED ジョブはユーザーによって一時停止されています。実行されません。ユーザーは Cloud Scheduler を使用してジョブを意図的に一時停止できます。
DISABLED エラーのため、ジョブはシステムによって無効になっています。ユーザーはジョブを直接無効にすることはできません。
UPDATE_FAILED 失敗した CloudScheduler.UpdateJob オペレーションの結果のジョブの状態。この状態からジョブを復元するには、正常なレスポンスを受信するまで CloudScheduler.UpdateJob を再試行します。
INITIALIZING スケジュール リソースが作成中です。
DELETING スケジュール リソースが削除中です。

メソッド

create

 指定されたプロジェクトとロケーションに新しいスケジュール設定されたノートブックを作成します。

delete

 スケジュールとすべての基盤となるジョブを削除します。

get

 スケジュールの詳細を取得します。

list

 指定されたプロジェクトとロケーションのスケジュールを一覧表示します。