REST Resource: projects.locations.schedules

Recurso: programação

A definição de uma programação.

Representação JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "cronSchedule": string,
  "timeZone": string,
  "createTime": string,
  "updateTime": string,
  "executionTemplate": {
    object (ExecutionTemplate)
  },
  "recentExecutions": [
    {
      object (Execution)
    }
  ]
}
Campos
name

string

Apenas saída. O nome desta programação. Formato: projects/{projectId}/locations/{location}/schedules/{scheduleId}

displayName

string

Apenas saída. Nome de exibição usado para fins UI. O nome só pode conter caracteres alfanuméricos, hífens - e sublinhados _.

description

string

Uma breve descrição deste ambiente.

state

enum (State)

cronSchedule

string

Programação formatada em cron-tab para execução do job. Formato: minuto, hora, dia do mês, mês, dia da semana.Por exemplo, 0 0 * * WED = toda quarta-feira. Mais exemplos: https://crontab.guru/examples.html

timeZone

string

Fuso horário em que o cronSchedule. O valor desse campo precisa ser um nome de fuso horário do banco de dados tz. Banco de dados TZ: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Alguns fusos horários incluem uma disposição para o horário de verão. As regras para o horário de verão são determinadas pelo fuso horário escolhido. Para UTC, use a string "utc". Se um fuso horário não for especificado, o padrão será UTC (também conhecido como GMT).

createTime

string (Timestamp format)

Apenas saída. Horário em que a programação foi criada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Apenas saída. Hora em que a programação foi atualizada pela última vez.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

executionTemplate

object (ExecutionTemplate)

Modelo de execução do notebook correspondente a esta programação.

recentExecutions[]

object (Execution)

Apenas saída. Os nomes de execução mais recentes acionados por essa programação e os estados correspondentes.

Estado

Estado do job.

Tipos enumerados
STATE_UNSPECIFIED Estado não especificado.
ENABLED O job está sendo executado normalmente.
PAUSED O job foi pausado pelo usuário. Ele não será executado. Um usuário pode pausar intencionalmente o job usando o Cloud Scheduler.
DISABLED O job foi desativado pelo sistema devido a um erro. O usuário não pode definir diretamente um trabalho para ser desativado.
UPDATE_FAILED O estado do job resultante de uma operação CloudScheduler.UpdateJob com falha. Para recuperar um job desse estado, repita a CloudScheduler.UpdateJob até que uma resposta bem-sucedida seja recebida.
INITIALIZING O recurso de programação está sendo criado.
DELETING O recurso de programação está sendo excluído.

Métodos

create

Cria um novo notebook programado em determinado projeto e local.

delete

Exclui a programação e todos os jobs subjacentes.

get

Recebe detalhes da programação

list

Lista programações em um determinado projeto e local.