Esta página foi traduzida pela API Cloud Translation.

Agende uma execução de pipeline com a API Scheduler

Pode agendar execuções únicas ou recorrentes de pipelines no Vertex AI através da API Scheduler. Isto permite-lhe implementar a preparação contínua no seu projeto.

Depois de criar uma agenda, esta pode ter um dos seguintes estados:

ACTIVE: uma programação ativa cria continuamente execuções de pipelines de acordo com a frequência configurada através da expressão de programação cron. Um horário fica ativo na respetiva hora de início e permanece nesse estado até à hora de fim especificada ou até o pausar.
PAUSED: um agendamento pausado não cria execuções de pipeline. Pode retomar um horário pausado para o reativar. Quando retoma um agendamento pausado, pode usar o parâmetro catch_up para especificar se as execuções ignoradas (execuções que teriam sido agendadas se o agendamento tivesse estado ativo) têm de ser reagendadas e enviadas no agendamento mais cedo possível.
COMPLETED: um agendamento concluído deixa de criar novas execuções de pipeline. Uma agenda é concluída de acordo com a hora de conclusão especificada.

Pode usar a API Scheduler para fazer o seguinte:

Crie uma agenda
Liste programações
Recupere um agendamento
Pause um horário
Atualize um horário
Retome um horário
Elimine uma programação

Antes de começar

Antes de agendar uma execução de pipeline através da API Scheduler, siga estas instruções para configurar o seu Google Cloud projeto e ambiente de desenvolvimento na Google Cloud consola.

Conceda, pelo menos, uma das seguintes autorizações de IAM ao utilizador ou à conta de serviço para usar a API Scheduler:
- roles/aiplatform.admin
- roles/aiplatform.user
Crie e compile um pipeline. Para mais informações, consulte o artigo Crie um pipeline.

Crie um horário

Pode criar um agendamento único ou recorrente.

Consola

Use as instruções seguintes para criar uma programação através da Google Cloud consola. Se já existir um horário para o projeto e a região, siga as instruções em Crie uma execução do pipeline.

Siga as instruções abaixo para criar uma programação de pipeline:

Na Google Cloud consola, na secção Vertex AI, aceda ao separador Agendamentos na página Pipelines.

Aceda a Agendas
Clique em Criar execução agendada para abrir o painel Criar execução da pipeline.
Especifique os seguintes detalhes da execução selecionando uma das seguintes opções:
- Para criar uma execução de pipeline com base num modelo de pipeline existente, clique em Selecionar a partir de pipelines existentes e introduza os seguintes detalhes:
  1. Selecione o repositório que contém o ficheiro de definição do componente ou pipeline.
  2. Selecione o Pipeline ou componente e a Versão.
- Para carregar uma definição de pipeline compilada, clique em Carregar ficheiro e introduza os seguintes detalhes:
  1. Clique em Procurar para abrir o seletor de ficheiros. Navegue para o ficheiro YAML da pipeline compilada que quer executar, selecione a pipeline e clique em Abrir.
  2. O nome do pipeline ou do componente mostra o nome especificado na definição do pipeline, por predefinição. Opcionalmente, especifique um nome diferente para o pipeline.
- Para importar um ficheiro de definição de pipeline do Cloud Storage, clique em Importar do Cloud Storage e introduza os seguintes detalhes:
  1. Clique em Procurar para navegar para o contentor do Cloud Storage que contém o objeto de definição do pipeline, selecione o ficheiro e, de seguida, clique em Selecionar.
  2. Especifique o nome do pipeline ou do componente.
Especifique um Nome da execução para identificar exclusivamente a execução do pipeline.
Especifique a Programação da execução, da seguinte forma:
1. Selecione Recorrente.
2. Em Hora de início, especifique quando o agendamento fica ativo.
  - Para agendar a primeira execução para ocorrer imediatamente após a criação do agendamento, selecione Imediatamente.
  - Para agendar a primeira execução para uma hora e uma data específicas, selecione Ativado.
3. No campo Frequência, especifique a frequência para agendar e executar as execuções do pipeline, usando uma expressão de agendamento cron com base no unix-cron.
4. Em Termina, especifique quando o agendamento termina.
  - Para indicar que a programação cria execuções de pipelines indefinidamente, selecione Nunca.
  - Para indicar que a programação termina numa data e hora específicas, selecione Em e especifique a data e a hora de fim da programação.
Opcional: para especificar uma conta de serviço personalizada, uma chave de encriptação gerida pelo cliente (CMEK) ou uma rede de VPC com peering, clique em Opções avançadas e especifique um nome de conta de serviço, CMEK ou rede de VPC com peering.
Clique em Continuar e especifique a Configuração de tempo de execução para o pipeline.
Clique em Enviar para criar a agenda de execução do pipeline.

REST

Para criar um horário de execução da pipeline, envie um pedido POST através do método projects.locations.schedules.create.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

LOCATION: a região onde quer executar o pipeline. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
PROJECT_ID: o Google Cloud projeto onde quer executar o pipeline.
DISPLAY_NAME: o nome da programação da pipeline. Pode especificar um nome com um comprimento máximo de 128 carateres UTF-8.
START_TIME: data/hora após a qual a primeira execução pode ser agendada, por exemplo, 2045-07-26T00:00:00Z. Se não especificar este parâmetro, a data/hora correspondente à data e hora em que cria a programação é usada como o valor predefinido.
END_TIME: data/hora após a qual as execuções do pipeline deixam de ser agendadas. Depois de atingir o valor END_TIME, o estado da programação muda para COMPLETED. Se não especificar este parâmetro, o agendamento continua a executar novas tarefas de pipeline indefinidamente até pausar ou eliminar o agendamento.
CRON_EXPRESSION: expressão de agendamento cron que representa a frequência de agendamento e execução de execuções de pipelines. Para mais informações, consulte cron.
MAX_CONCURRENT_RUN_COUNT: o número máximo de execuções simultâneas para a programação.

API_REQUEST_TEMPLATE: modelo de PipelineService.CreatePipelineJob pedido da API usado para executar as execuções da pipeline agendadas. Para mais informações sobre os parâmetros no modelo de pedido da API, consulte a documentação de pipelineJobs.create. Tenha em atenção que não pode especificar o parâmetro pipelineJobId neste modelo, uma vez que a API Scheduler não suporta este parâmetro.

Clique aqui para ver um modelo de pedido de API de exemplo, onde gs://gcs_directory é o contentor do Cloud Storage para os artefactos de saída do pipeline.

{
  "parent":"projects//locations/us-central1",
  "pipelineJob": {
    "displayName": "hello-world",
    "pipelineSpec": {
      "deploymentConfig": {
        "@type": "type.googleapis.com/ml_pipelines.PipelineDeploymentConfig",
        "executors": {
          "HelloWorld_executor": {
            "container": {
              "command": ["sleep", "1"],
              "image": "google/cloud-sdk:latest"
            }
          }
        }
      },
      "pipelineInfo": {
        "name": "hello-world"
      },
      "root": {
        "dag": {
          "tasks": {
            "task-test-hello-world": {
              "taskInfo": {"name": "HelloWorld"},
              "componentRef": {"name": "HelloWorld"},
              "cachingOptions": {}
            }
          }
        }
      },
      "components": {
        "HelloWorld": {
          "executorLabel": "HelloWorld_executor"
        }
      },
      "schemaVersion": "2.0.0"
    },
    "runtimeConfig": {
      "gcsOutputDirectory": "gs://gcs_directory"
    }
  }
}

Método HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules

Corpo JSON do pedido:

{
  "display_name":"DISPLAY_NAME",
  "start_time": "START_TIME",
  "end_time": "END_TIME",
  "cron": "CRON_EXPRESSION",
  "max_concurrent_run_count": "MAX_CONCURRENT_RUN_COUNT",
  "create_pipeline_job_request": API_REQUEST_TEMPLATE
}

Para enviar o seu pedido, escolha uma destas opções:

curl

Nota: O comando seguinte pressupõe que tem sessão iniciada na CLI gcloud com a sua conta de utilizador executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que inicia automaticamente sessão na CLI gcloud. Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules"

PowerShell

Nota: O comando seguinte pressupõe que iniciou sessão na CLI do Google Cloud com a sua conta de utilizador executando gcloud init ou gcloud auth login .gcloud Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules" | Select-Object -Expand Content

Deverá ver uma saída semelhante à seguinte. Pode usar o SCHEDULE_ID da resposta para obter, pausar, retomar ou eliminar a programação. PIPELINE_JOB_CREATION_REQUEST representa o pedido de API para criar a tarefa de pipeline.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID",
  "displayName": "DISPLAY_NAME",
  "startTime": "START_TIME",
  "state": "ACTIVE",
  "createTime": "2025-01-01T00:00:00.000000Z",
  "nextRunTime": "2045-08-01T00:00:00Z",
  "cron": "CRON_EXPRESSION",
  "maxConcurrentRunCount": "MAX_CONCURRENT_RUN_COUNT",
  "createPipelineJobRequest": PIPELINE_JOB_CREATION_REQUEST
}

Python

Pode criar um agendamento de execução do pipeline das seguintes formas:

Crie um horário com base num PipelineJob através do método PipelineJob.create_schedule.
Criar um horário com o método PipelineJobSchedule.create.

Ao criar um agendamento de execução do pipeline, também pode transmitir os seguintes marcadores de posição suportados pelo SDK do KFP como entradas:

{{$.pipeline_job_name_placeholder}}
{{$.pipeline_job_resource_name_placeholder}}
{{$.pipeline_job_id_placeholder}}
{{$.pipeline_task_name_placeholder}}
{{$.pipeline_task_id_placeholder}}
{{$.pipeline_job_create_time_utc_placeholder}}
{{$.pipeline_job_schedule_time_utc_placeholder}}
{{$.pipeline_root_placeholder}}

Para mais informações, consulte Tipos de entrada especiais na documentação do Kubeflow Pipelines v2.

Crie uma agenda a partir de um `PipelineJob`

Use o seguinte exemplo para agendar execuções de pipelines através do método PipelineJob.create_schedule:

from google.cloud import aiplatform

pipeline_job = aiplatform.PipelineJob(
  template_path="COMPILED_PIPELINE_PATH",
  pipeline_root="PIPELINE_ROOT_PATH",
  display_name="DISPLAY_NAME",
)

pipeline_job_schedule = pipeline_job.create_schedule(
  display_name="SCHEDULE_NAME",
  cron="TZ=CRON",
  max_concurrent_run_count=MAX_CONCURRENT_RUN_COUNT,
  max_run_count=MAX_RUN_COUNT,
)

COMPILED_PIPELINE_PATH: o caminho para o ficheiro YAML da pipeline compilada. Pode ser um caminho local ou um URI do Cloud Storage.

Opcional: para especificar uma versão específica de um modelo, inclua a etiqueta de versão juntamente com o caminho num dos seguintes formatos:
- COMPILED_PIPELINE_PATH:TAG, onde TAG é a etiqueta de versão.
- COMPILED_PIPELINE_PATH@SHA256_TAG, onde SHA256_TAG é o valor hash sha256 da versão do pipeline.
PIPELINE_ROOT_PATH: (opcional) Para substituir o caminho raiz do pipeline especificado na definição do pipeline, especifique um caminho ao qual a tarefa do pipeline possa aceder, como um URI de contentor do Cloud Storage.
DISPLAY_NAME: o nome da pipeline. Isto é apresentado na consola Google Cloud .
SCHEDULE_NAME: o nome da programação da pipeline. Pode especificar um nome com um comprimento máximo de 128 carateres UTF-8.
CRON: expressão de agendamento cron que representa a frequência de agendamento e execução de execuções de pipelines. Para mais informações, consulte o artigo Cron.
MAX_CONCURRENT_RUN_COUNT: o número máximo de execuções simultâneas para a programação.
MAX_RUN_COUNT: o número máximo de execuções de pipeline que o agendamento cria após a conclusão.

Crie uma programação com o `PipelineJobSchedule.create`

Use o seguinte exemplo para agendar execuções de pipelines através do método PipelineJobSchedule.create:

from google.cloud import aiplatform

pipeline_job = aiplatform.PipelineJob(
  template_path="COMPILED_PIPELINE_PATH",
  pipeline_root="PIPELINE_ROOT_PATH",
  display_name="DISPLAY_NAME",
)

pipeline_job_schedule = aiplatform.PipelineJobSchedule(
  pipeline_job=pipeline_job,
  display_name="SCHEDULE_NAME"
)

pipeline_job_schedule.create(
  cron="TZ=CRON",
  max_concurrent_run_count=MAX_CONCURRENT_RUN_COUNT,
  max_run_count=MAX_RUN_COUNT,
)

COMPILED_PIPELINE_PATH: o caminho para o ficheiro YAML da pipeline compilada. Pode ser um caminho local ou um URI do Cloud Storage.

Opcional: para especificar uma versão específica de um modelo, inclua a etiqueta de versão juntamente com o caminho num dos seguintes formatos:
- COMPILED_PIPELINE_PATH:TAG, onde TAG é a etiqueta de versão.
- COMPILED_PIPELINE_PATH@SHA256_TAG, onde SHA256_TAG é o valor hash sha256 da versão do pipeline.
PIPELINE_ROOT_PATH: (opcional) Para substituir o caminho raiz do pipeline especificado na definição do pipeline, especifique um caminho ao qual a tarefa do pipeline possa aceder, como um URI de contentor do Cloud Storage.
DISPLAY_NAME: o nome da pipeline. Isto é apresentado na consola Google Cloud .
SCHEDULE_NAME: o nome da programação da pipeline. Pode especificar um nome com um comprimento máximo de 128 carateres UTF-8.
CRON: expressão de agendamento cron que representa a frequência de agendamento e execução de execuções de pipelines. Para mais informações, consulte o artigo Cron.
MAX_CONCURRENT_RUN_COUNT: o número máximo de execuções simultâneas para a programação.
MAX_RUN_COUNT: o número máximo de execuções de pipeline que o agendamento cria após a conclusão.

Listar horários

Pode ver a lista de agendamentos de pipelines criados para o seu Google Cloud projeto.

Consola

Pode ver a lista de agendamentos de pipelines no separador Agendamentos da Google Cloud consola para a região selecionada.

Para ver a lista de agendamentos de pipelines, na Google Cloud consola, na secção Vertex AI, aceda ao separador Agendamentos na página Pipelines.

Aceda a Agendas

REST

Para listar os agendamentos de execuções de pipelines no seu projeto, envie um pedido GET através do método projects.locations.schedules.list.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

LOCATION: a região onde quer executar o pipeline. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
PROJECT_ID: o Google Cloud projeto onde quer executar o pipeline.
FILTER: (opcional) Expressão para filtrar a lista de programações. Para mais informações, consulte ...
PAGE_SIZE: (opcional) O número de horários a apresentar por página.
PAGE_TOKEN: (opcional) O token da página da lista padrão, normalmente obtido através de ListSchedulesResponse.next_page_token[] de uma chamada ScheduleService.ListSchedules[] anterior.
ORDER_BY: (opcional) Lista de campos separados por vírgulas, que indica a ordem de ordenação dos horários na resposta.

Método HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules?FILTER&PAGE_SIZE&PAGE_TOKEN&ORDER_BY

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules?FILTER&PAGE_SIZE&PAGE_TOKEN&ORDER_BY"

PowerShell

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules?FILTER&PAGE_SIZE&PAGE_TOKEN&ORDER_BY" | Select-Object -Expand Content

Deverá ver uma saída semelhante à seguinte:

{
  "schedules": [
    SCHEDULE_ENTITY_OBJECT_1,
    SCHEDULE_ENTITY_OBJECT_2,
    ...
  ],
}

Python

Use o exemplo seguinte para apresentar uma lista de todos os agendamentos no seu projeto por ordem descendente das respetivas horas de criação:

from google.cloud import aiplatform

aiplatform.PipelineJobSchedule.list(
  filter='display_name="DISPLAY_NAME"',
  order_by='create_time desc'
)

DISPLAY_NAME: o nome da programação da pipeline. Pode especificar um nome com um comprimento máximo de 128 carateres UTF-8.

Recupere um horário

Pode obter um agendamento de execução do pipeline através do ID do agendamento.

REST

Para obter uma agenda de execução de um pipeline, envie um pedido GET através do método projects.locations.schedules.get e do ID da agenda.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

LOCATION: a região onde quer executar o pipeline. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
PROJECT_ID: o Google Cloud projeto onde quer executar o pipeline.
SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.

Método HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID"

PowerShell

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID" | Select-Object -Expand Content

Deverá ver uma saída semelhante à seguinte. PIPELINE_JOB_CREATION_REQUEST representa o pedido de API para criar a tarefa de pipeline.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID",
  "displayName": "schedule_display_name",
  "startTime": "2045-07-26T06:59:59Z",
  "state": "ACTIVE",
  "createTime": "20xx-01-01T00:00:00.000000Z",
  "nextRunTime": "2045-08-01T00:00:00Z",
  "cron": "TZ=America/New_York 0 0 1 * *",
  "maxConcurrentRunCount": "10",
  "createPipelineJobRequest": PIPELINE_JOB_CREATION_REQUEST
}

Python

Use o exemplo seguinte para obter uma agenda de execução de pipeline através do ID da agenda:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.

Pause um horário

Pode pausar um agendamento de pipeline ativo especificando o ID do agendamento. Quando pausa uma agenda, o respetivo estado muda de ACTIVE para PAUSED.

Consola

Pode pausar um agendamento de execução de pipeline que esteja atualmente ativo.

Siga as instruções que se seguem para pausar uma programação:

Na Google Cloud consola, na secção Vertex AI, aceda ao separador Agendamentos na página Pipelines.

Aceda a Agendas
Aceda ao menu de opções que se encontra na mesma linha que o horário que quer pausar e, de seguida, clique em Pausar. Pode pausar qualquer horário em que a coluna Estado mostre Ativo.

REST

Para pausar um agendamento de execução de pipeline no seu projeto, envie um pedido POST através do método projects.locations.schedules.pause.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

LOCATION: a região onde a agenda de execução do pipeline está atualmente ativa. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
PROJECT_ID: o Google Cloud projeto onde o horário de execução do pipeline está atualmente ativo.
SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.

Método HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:pause

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:pause"

PowerShell

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:pause" | Select-Object -Expand Content

Deve receber um código de estado de êxito (2xx) e uma resposta vazia.

Python

Use o seguinte exemplo para pausar uma programação de execução de pipeline:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.pause()

SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.

Atualize uma programação

Pode atualizar uma programação de pipeline existente criada para o seu Google Cloud projeto.

A atualização de um agendamento é semelhante à eliminação e à recriação de um agendamento. Quando atualiza uma agenda, as novas execuções são agendadas com base na frequência da agenda atualizada. As novas execuções já não são criadas com base na programação antiga, e todas as execuções em fila de espera são ignoradas. As execuções de pipelines já criadas pelo horário antigo não são pausadas nem canceladas.

REST

Para atualizar uma agenda de execução de pipeline no seu projeto, envie um pedido PATCH através do método projects.locations.schedules.patch.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

LOCATION: a região onde quer executar o pipeline. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
PROJECT_ID: o Google Cloud projeto onde quer executar o pipeline.
DISPLAY_NAME: o nome da programação da pipeline. Pode especificar um nome com um comprimento máximo de 128 carateres UTF-8.
MAX_CONCURRENT_RUN_COUNT: o número máximo de execuções simultâneas para a programação.

Método HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID?updateMask=display_name,max_run_count -d '{"display_name":"DISPLAY_NAME", "max_concurrent_run_count": MAX_CONCURRENT_RUN_COUNT}'

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID?updateMask=display_name,max_run_count -d '{"display_name":"DISPLAY_NAME", "max_concurrent_run_count": MAX_CONCURRENT_RUN_COUNT}'"

PowerShell

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID?updateMask=display_name,max_run_count -d '{"display_name":"DISPLAY_NAME", "max_concurrent_run_count": MAX_CONCURRENT_RUN_COUNT}'" | Select-Object -Expand Content

Deverá ver uma saída semelhante à seguinte. Com base na atualização, o NEXT_RUN_TIME é recalculado. Quando atualiza a programação, o START_TIME permanece inalterado.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID",
  "displayName": "DISPLAY_NAME",
  "startTime": "START_TIME",
  "state": "ACTIVE",
  "createTime": "2025-01-01T00:00:00.000000Z",
  "nextRunTime": NEXT_RUN_TIME,
  "maxConcurrentRunCount": "MAX_CONCURRENT_RUN_COUNT",
}

Python

Use o seguinte exemplo para agendar execuções de pipelines através do método PipelineJobSchedule.update:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.update(
  display_name='DISPLAY_NAME',
  max_concurrent_run_count=MAX_CONCURRENT_RUN_COUNT,
)

SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.
DISPLAY_NAME: o nome da programação da pipeline. Pode especificar um nome com um comprimento máximo de 128 carateres UTF-8.
MAX_CONCURRENT_RUN_COUNT: o número máximo de execuções simultâneas para a programação.

Retome uma programação

Pode retomar um agendamento de pipeline pausado especificando o ID do agendamento. Quando retoma uma programação, o respetivo estado muda de PAUSED para ACTIVE.

Consola

Pode retomar uma programação de execução de pipeline que esteja atualmente em pausa.

Siga as instruções abaixo para retomar uma atualização agendada:

Na Google Cloud consola, na secção Vertex AI, aceda ao separador Agendamentos na página Pipelines.

Aceda a Agendas
Aceda ao menu de opções que se encontra na mesma linha que a programação que quer retomar e, de seguida, clique em Retomar. Pode retomar qualquer programação em que a coluna Estado apresente Em pausa.

REST

Para retomar uma agenda de execução de pipeline no seu projeto, envie um pedido POST através do método projects.locations.schedules.resume.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

LOCATION: a região onde a agenda de execução do pipeline está atualmente pausada. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
PROJECT_ID: o Google Cloud projeto onde o horário de execução do pipeline está atualmente pausado.
SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.
CATCH_UP: (Opcional) Indique se o agendamento pausado deve preencher novamente as execuções de pipelines ignoradas. Para preencher e reagendar as execuções de pipeline ignoradas, introduza o seguinte:
{ "catch_up":true } Este parâmetro está predefinido como "false".

Método HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:resume -d 'CATCH_UP'

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:resume -d 'CATCH_UP'"

PowerShell

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:resume -d 'CATCH_UP'" | Select-Object -Expand Content

Deve receber um código de estado de êxito (2xx) e uma resposta vazia.

Python

Use o seguinte exemplo para retomar uma agenda de execução de pipeline pausada:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.resume(catch_up=CATCH_UP)

SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.
CATCH_UP: (Opcional) Indique se o agendamento pausado deve preencher novamente as execuções de pipelines ignoradas. Para preencher novamente e reagendar as execuções de pipeline ignoradas, introduza o seguinte:
{ "catch_up":true }

Elimine um agendamento

Pode eliminar um agendamento de pipeline especificando o ID do agendamento.

Consola

Pode eliminar um agendamento de execução de pipeline independentemente do respetivo estado.

Siga as instruções abaixo para eliminar um horário:

Na Google Cloud consola, na secção Vertex AI, aceda ao separador Agendamentos na página Pipelines.

Aceda a Agendas
Aceda ao menu de opções que se encontra na mesma linha do horário que quer eliminar e, de seguida, clique em Eliminar.
Para confirmar a eliminação, clique em Eliminar.

REST

Para eliminar um agendamento de execução de pipeline no seu projeto, envie um pedido DELETE através do método projects.locations.schedules.delete.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

LOCATION: a região onde quer eliminar o horário do pipeline. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
PROJECT_ID: o projeto Google Cloud no qual quer eliminar a programação.
SCHEDULE_ID: o ID da programação exclusivo gerado durante a criação da programação.

Método HTTP e URL:

DELETE https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID"

PowerShell

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID" | Select-Object -Expand Content

Deverá ver uma saída semelhante à seguinte. OPERATION_ID representa a operação de eliminação.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.aiplatform.v1.DeleteOperationMetadata",
    "genericMetadata": {
      "createTime": "20xx-01-01T00:00:00.000000Z",
      "updateTime": "20xx-01-01T00:00:00.000000Z"
    }
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.protobuf.Empty"
  }
}

Python

Use o exemplo seguinte para eliminar um horário de execução de pipeline:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.delete()

SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.

Apresenta todas as tarefas de pipeline criadas por uma agenda

Pode ver uma lista de todas as tarefas de pipeline criadas por uma programação especificando o ID da programação.

REST

Para listar todas as execuções de pipelines que foram criadas por uma programação de pipelines, envie um pedido GET através do método projects.locations.pipelineJobs.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

LOCATION: a região onde quer executar o pipeline. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
PROJECT_ID: o Google Cloud projeto onde quer executar o pipeline.
SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.

Método HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs?filter=schedule_name=projects/PROJECT/locations/LOCATION/schedules/SCHEDULE_ID

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs?filter=schedule_name=projects/PROJECT/locations/LOCATION/schedules/SCHEDULE_ID"

PowerShell

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs?filter=schedule_name=projects/PROJECT/locations/LOCATION/schedules/SCHEDULE_ID" | Select-Object -Expand Content

Deverá ver uma saída semelhante à seguinte.

{
  "pipelineJobs": [
    PIPELINE_JOB_ENTITY_1,
    PIPELINE_JOB_ENTITY_2,
    ...
  ],
}

Python

Use o exemplo seguinte para apresentar uma lista de todas as tarefas de pipeline criadas por um agendamento por ordem descendente das respetivas horas de criação:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.list_jobs(order_by='create_time_desc')

SCHEDULE_ID: ID da programação exclusivo gerado durante a criação da programação.

Agende uma execução de pipeline com a API Scheduler Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Antes de começar

Crie um horário

Consola

REST

curl

PowerShell

Python

Crie uma agenda a partir de um PipelineJob

Crie uma programação com o PipelineJobSchedule.create

Listar horários

Consola

REST

curl

PowerShell

Python

Recupere um horário

REST

curl

PowerShell

Python

Pause um horário

Consola

REST

curl

PowerShell

Python

Atualize uma programação

REST

curl

PowerShell

Python

Retome uma programação

Consola

REST

curl

PowerShell

Python

Elimine um agendamento

Consola

REST

curl

PowerShell

Python

Apresenta todas as tarefas de pipeline criadas por uma agenda

REST

curl

PowerShell

Python

Agende uma execução de pipeline com a API Scheduler

Crie uma agenda a partir de um `PipelineJob`

Crie uma programação com o `PipelineJobSchedule.create`