REST Resource: projects.locations.schedules

Ressource: Zeitplan

Die Definition eines Zeitplans.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "cronSchedule": string,
  "timeZone": string,
  "createTime": string,
  "updateTime": string,
  "executionTemplate": {
    object (ExecutionTemplate)
  },
  "recentExecutions": [
    {
      object (Execution)
    }
  ]
}
Felder
name

string

Nur Ausgabe. Der Name dieses Zeitplans. Format: projects/{projectId}/locations/{location}/schedules/{scheduleId}

displayName

string

Nur Ausgabe. Anzeigename für die Benutzeroberfläche. Der Name darf nur alphanumerische Zeichen, Bindestriche - und Unterstriche _ enthalten.

description

string

Eine kurze Beschreibung dieser Umgebung.

state

enum (State)

cronSchedule

string

Zeitplan im Crontab-Format, nach dem der Job ausgeführt wird. Format: Minute, Stunde, Tag des Monats, Monat, Wochentag, z. B. 0 0 * * WED = jeden Mittwoch. Weitere Beispiele: https://crontab.guru/examples.html

timeZone

string

Zeitzone, in der der cronSchedule ausgeführt wird. Der Wert dieses Felds muss ein Zeitzonenname aus der tz-Datenbank sein. TZ-Datenbank: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Einige Zeitzonen berücksichtigen die Sommerzeit. Die Regeln für die Sommerzeit richten sich nach der ausgewählten tz. Verwenden Sie für UTC den String „utc“. Wenn keine Zeitzone angegeben ist, wird standardmäßig UTC (auch als GMT bezeichnet) verwendet.

createTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der der Zeitplan erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt der letzten Aktualisierung des Zeitplans.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

executionTemplate

object (ExecutionTemplate)

Notebook-Ausführungsvorlage, die diesem Zeitplan entspricht.

recentExecutions[]

object (Execution)

Nur Ausgabe. Die Namen der letzten Ausführungen, die durch diesen Zeitplan ausgelöst wurden, und die entsprechenden Status.

Bundesland

Status des Jobs.

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand.
ENABLED Der Job wird normal ausgeführt.
PAUSED Der Job wurde vom Nutzer pausiert. Sie wird nicht ausgeführt. Ein Nutzer kann den Job mit Cloud Scheduler absichtlich pausieren.
DISABLED Der Job wurde vom System aufgrund eines Fehlers deaktiviert. Der Nutzer kann einen Job nicht direkt deaktivieren.
UPDATE_FAILED Der Jobstatus, der sich aus einem fehlgeschlagenen CloudScheduler.UpdateJob-Vorgang ergibt. Zum Wiederherstellen eines Jobs aus diesem Status wiederholen Sie den CloudScheduler.UpdateJob-Vorgang, bis eine erfolgreiche Antwort empfangen wird.
INITIALIZING Die Zeitplanressource wird erstellt.
DELETING Die Zeitplanressource wird gelöscht.

Methoden

create

Erstellt ein neues geplantes Notebook in einem bestimmten Projekt und an einem bestimmten Standort.

delete

Löscht den Zeitplan und alle zugrunde liegenden Jobs

get

Ruft Details zum Zeitplan ab.

list

Listet Zeitpläne in einem bestimmten Projekt und an einem bestimmten Standort auf.