Criar e gerenciar fluxos de trabalho

É possível criar e gerenciar fluxos de trabalho no console do Google Cloud ou usando a Google Cloud CLI no seu terminal ou no Cloud Shell. Também é possível gerenciar fluxos de trabalho pela API Workflows.

Antes de começar

As restrições de segurança definidas pela sua organização podem impedir que você conclua as etapas a seguir. Para informações sobre solução de problemas, consulte Desenvolver aplicativos em um ambiente restrito do Google Cloud.

Console

  1. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  2. Verifique se a cobrança está ativada para o projeto do Google Cloud. Saiba como verificar se o faturamento está ativado em um projeto.

  3. Ative a API Workflows.

    Ative a API

gcloud

  1. No Console do Google Cloud, ative o Cloud Shell.

    Ativar o Cloud Shell

    Na parte inferior do Console do Google Cloud, uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

  2. Verifique se a cobrança está ativada para o projeto do Google Cloud. Saiba como verificar se o faturamento está ativado em um projeto.

  3. Ative a API Workflows.

    gcloud services enable workflows.googleapis.com

REST

Para gerenciar fluxos de trabalho usando a API Workflows, recomendamos usar as bibliotecas de cliente fornecidas pelo Google para chamar o serviço workflows.googleapis.com. Para mais informações, consulte API Workflows.

Crie uma conta de serviço

Uma conta de serviço representa a identidade de um fluxo de trabalho e determina quais permissões o fluxo de trabalho tem e quais recursos do Google Cloud ele pode acessar. Crie uma conta de serviço se ainda não tiver uma. Em seguida, conceda os papéis necessários para gerenciar fluxos de trabalho e criar registros.

Se você não especificar uma conta de serviço durante a criação do fluxo de trabalho, ele usará a conta de serviço padrão do Compute Engine como identidade. Para mais informações, acesse Conceder permissão a um fluxo de trabalho para acessar os recursos do Google Cloud.

Recomendamos o uso de uma conta de serviço com os privilégios mínimos necessários para acessar os recursos necessários.

Para criar um recurso e anexar uma conta de serviço, você precisa de permissões para criar esse recurso e personificar a conta de serviço que você vai anexar ao recurso. Para mais informações, consulte Permissões da conta de serviço.

Console

  1. No console do Google Cloud, acesse a página Contas de serviço.

    Acessar a página "Contas de serviço"

  2. Selecione um projeto e clique em Criar conta de serviço.

  3. No campo Nome da conta de serviço, insira um nome.

    O nome precisa ter entre 6 e 30 caracteres e pode conter caracteres alfanuméricos minúsculos e traços. Depois de criar uma conta de serviço, não é possível alterar o nome dela.

  4. Clique em Criar e continuar.

  5. Clique em Selecionar papel.

  6. Selecione os papéis a seguir e clique em Adicionar outro papel conforme necessário:

    1. Para criar, atualizar e executar fluxos de trabalho, selecione Workflows > Workflows Editor.
    2. Para enviar registros para o Cloud Logging, selecione Logging > Gravador de registros.

  7. Clique em Concluído para terminar a criação da conta de serviço.

gcloud

  1. Crie a conta de serviço.

    gcloud iam service-accounts create SERVICE_ACCOUNT

  2. Atribua papéis para conceder permissões à conta de serviço.

    1. Para criar, atualizar e executar fluxos de trabalho, atribua o papel roles/workflows.editor:

      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
    --role "roles/workflows.editor"

    2. Para enviar registros para o Cloud Logging, atribua o papel roles/logging.logWriter:

      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
    --role "roles/logging.logWriter"

    Substitua:

    • SERVICE_ACCOUNT: o nome da conta de serviço. Ele precisa ter entre 6 e 30 caracteres e pode conter letras minúsculas, caracteres alfanuméricos e traços. Depois de criar uma conta de serviço, não é possível alterar o nome dela.

    • PROJECT_ID: ID do projeto.

REST

É possível usar o método serviceAccounts.create para criar uma conta de serviço. Para mais informações, consulte Criar contas de serviço.

É possível conceder vários papéis programaticamente. Basta modificar e definir a política de permissão de um recurso usando o método setIamPolicy. Para mais informações, consulte Conceder ou revogar vários papéis de maneira programática.

Criar um fluxo de trabalho

Uma definição de fluxo de trabalho é composta por uma série de etapas descritas usando a sintaxe de fluxos de trabalho, que pode ser escrita em formato YAML ou JSON. Depois de definir um fluxo de trabalho, é preciso implantá-lo para disponibilizá-lo para execução. A etapa de implantação também valida a execução do arquivo de origem. Isso falhará se o arquivo de origem não contiver uma definição de fluxo de trabalho válida.

A edição de arquivos YAML pode causar erros. É possível criar seu fluxo de trabalho usando um ambiente de desenvolvimento integrado ou editor de código-fonte de preferência e configurando o preenchimento automático e a validação de sintaxe para reduzir erros.

Console

  1. No console do Google Cloud, abra a página Workflows.

    Acessar fluxos de trabalho

  2. Clique em Criar.

  3. Insira um nome para o fluxo de trabalho, como myFirstWorkflow. Esse nome pode conter letras, números, sublinhados e hífens. É preciso começar com uma letra e terminar com um número ou uma letra

  4. Se quiser, adicione uma descrição do fluxo de trabalho.

  5. Na lista Região, selecione um local apropriado para implantar seu fluxo de trabalho, por exemplo, us-central1.

  6. Na lista Conta de serviço, selecione uma conta de serviço que seu fluxo de trabalho usará para acessar outros serviços do Google Cloud. Para mais informações, neste documento, consulte Criar uma conta de serviço.

  7. Você ainda tem as opções a seguir:

    1. Especifique o nível de registro de chamadas que você quer aplicar à definição do fluxo de trabalho. Na lista Nível de registro de chamadas, selecione uma das seguintes opções:

      • Não especificado: nenhum nível de registro foi especificado. Esse é o padrão. Um nível de registro de execução tem precedência sobre qualquer nível de registro de fluxo de trabalho, a menos que o nível de registro de execução não seja especificado (o padrão). Nesse caso, o nível de registro de fluxo de trabalho é aplicado.
      • Somente erros: registra todas as exceções identificadas; ou quando uma chamada é interrompida devido a uma exceção.
      • Todas as chamadas: registre todas as chamadas para subfluxos de trabalho ou funções de biblioteca e os respectivos resultados.
      • Sem registros: nenhum registro de chamadas.

    2. Especifique uma chave do Cloud Key Management Service que o fluxo de trabalho precisa usar para a criptografia de dados: selecione Chave de criptografia gerenciada pelo cliente (CMEK, na sigla em inglês). Para mais informações, consulte Usar chaves de criptografia gerenciadas pelo cliente.

    3. Especifique uma variável de ambiente que seja acessível pelo fluxo de trabalho no ambiente de execução. Para mais informações, consulte Usar variáveis de ambiente.

    4. Adicione um rótulo: os identificadores são pares de chave-valor que ajudam a organizar as instâncias do Google Cloud. Para mais informações, consulte O que são rótulos? Os rótulos do fluxo de trabalho são herdados pelas execuções do fluxo de trabalho. Para visualizar os rótulos de execução, use o método workflows.executions.list para listar e filtrar as execuções de fluxo de trabalho.

    5. Programe seu fluxo de trabalho: selecione Adicionar novo gatilho > Cloud Scheduler. Para mais informações, consulte Programar um fluxo de trabalho usando o Cloud Scheduler.

    6. Acione seu fluxo de trabalho em um evento ou uma mensagem do Pub/Sub: selecione Adicionar novo gatilho > Eventarc. Para mais informações, consulte Acionar um fluxo de trabalho com eventos ou mensagens do Pub/Sub.

  8. Clique em Próxima.

  9. No editor de fluxo de trabalho, insira a definição para seu fluxo de trabalho. Veja um exemplo de fluxo de trabalho.

  10. Selecione Implantar.

gcloud

  1. Verifique se o código-fonte do fluxo de trabalho está salvo em um arquivo YAML ou JSON, como MY_WORKFLOW.YAML ou MY_WORKFLOW.JSON. Veja um exemplo de fluxo de trabalho.

  2. Abra um terminal.

  3. É possível criar e implantar um fluxo de trabalho usando o comando gcloud workflows deploy:

    gcloud workflows deploy WORKFLOW_NAME \
    --location=LOCATION \
    --call-log-level=CALL_LOGGING_LEVEL \
    --description="DESCRIPTION" \
    --labels="LABEL_KEY=LABEL_VALUE" \
    --set-env-vars="ENV_KEY=ENV_VALUE" \
    --kms-key=ENCRYPT_KEY \
    --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
    --source=YAML_OR_JSON_SOURCE_FILE

    Substitua:

    • WORKFLOW_NAME: o nome do fluxo de trabalho, por exemplo, myFirstWorkflow. O nome pode conter letras, números, sublinhados e hifens. Ele precisa começar com uma letra e terminar com um número ou uma letra.

    • LOCATION: a região em que o fluxo de trabalho será implantado. Por exemplo, us-central1.

    • CALL_LOGGING_LEVEL: opcional. Nível de registro de chamadas a ser aplicado durante a execução. Pode ser um dos seguintes:

      • none: nenhum nível de registro foi especificado. Esse é o padrão. Um nível de registro de execução tem precedência sobre qualquer nível de registro de fluxo de trabalho, a menos que o nível de registro de execução não seja especificado (o padrão). Nesse caso, o nível de registro de fluxo de trabalho é aplicado.
      • log-errors-only: registra todas as exceções identificadas. ou quando uma chamada é interrompida devido a uma exceção.
      • log-all-calls: registra todas as chamadas para subfluxos de trabalho ou funções de biblioteca e os resultados delas.
      • log-none: nenhum registro de chamadas.

    • DESCRIPTION: opcional. Uma descrição do fluxo de trabalho.

    • LABEL_KEY=LABEL_VALUE: opcional. Lista de pares de chave-valor de rótulo que ajuda a organizar as instâncias do Google Cloud. Por exemplo, name=wrench. Para mais informações, consulte O que são rótulos? Os rótulos do fluxo de trabalho são herdados pelas execuções do fluxo de trabalho. Para visualizar os rótulos de execução, use o método workflows.executions.list para listar e filtrar as execuções de fluxo de trabalho.

    • ENV_KEY=ENV_VALUE: opcional. Lista de pares de chave-valor variável de ambiente, por exemplo, MONTH=January. Para mais informações, consulte Usar variáveis de ambiente.

    • ENCRYPT_KEY: opcional. Uma chave do Cloud KMS que o fluxo de trabalho precisa usar para criptografia de dados no formato projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Para mais informações, consulte Usar chaves de criptografia gerenciadas pelo cliente.

    • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opcional. A conta de serviço que seu fluxo de trabalho usará para acessar outros serviços do Google Cloud. Para mais informações, consulte Criar uma conta de serviço neste documento.

    • YAML_OR_JSON_SOURCE_FILE: o arquivo de origem da definição do fluxo de trabalho. Por exemplo, myFirstWorkflow.yaml.

REST

Para criar um novo fluxo de trabalho com um nome especificado, use o método projects.locations.workflows.create e o parâmetro de consulta workflowId para especificar um ID para o fluxo de trabalho.

Antes de usar os dados da solicitação, faça as substituições a seguir:

  • WORKFLOW_NAME: o nome do fluxo de trabalho. Por exemplo, myFirstWorkflow. O nome pode conter letras, números, sublinhados e hifens. Ele precisa começar com uma letra e terminar com um número ou uma letra.
  • DESCRIPTION: opcional. Uma descrição do seu fluxo de trabalho. Não pode ter mais de 1.000 caracteres Unicode.
  • LABEL_KEY e LABEL_VALUE: opcionais. Um mapa de pares de chave-valor de rótulos que ajuda a organizar as instâncias do Google Cloud. Por exemplo: {"name": "wrench", "mass": "1kg", "count": "3"} Para mais informações, consulte O que são rótulos? Os rótulos do fluxo de trabalho são herdados pelas execuções desse fluxo. Para visualizar os rótulos de execução, use o método workflows.executions.list para listar e filtrar as execuções de fluxo de trabalho.
  • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opcional. A conta de serviço que seu fluxo de trabalho usará para acessar outros serviços do Google Cloud. O ID do projeto é o ID do projeto do Google Cloud. Para mais informações, consulte Criar uma conta de serviço neste documento.
  • ENCRYPT_KEY: opcional. Uma chave do Cloud KMS que o fluxo de trabalho precisa usar para criptografia de dados no formato projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Para mais informações, consulte Usar chaves de criptografia gerenciadas pelo cliente.
  • CALL_LOGGING_LEVEL: opcional. O nível de registro de chamadas a ser aplicado durante a execução. O padrão é que nenhum nível de geração de registros seja especificado, e o nível de registro do fluxo de trabalho seja aplicado. Para mais informações, consulte Enviar registros para o Logging. Uma das seguintes opções:
    • CALL_LOG_LEVEL_UNSPECIFIED: nenhum nível de geração de registros é especificado, e o nível de registro do fluxo de trabalho é aplicado. Esse é o padrão. Caso contrário, o nível de registro de execução será aplicado e terá precedência sobre o nível de registro do fluxo de trabalho.
    • LOG_ERRORS_ONLY: registra todas as exceções capturadas ou quando uma chamada é interrompida devido a uma exceção.
    • LOG_ALL_CALLS: registra todas as chamadas para subfluxos de trabalho ou funções de biblioteca e os resultados delas.
    • LOG_NONE: nenhum registro de chamadas.
  • ENV_KEY e ENV_VALUE: opcionais. Um mapa de pares de chave e valor de variável de ambiente, por exemplo, { "month": "January", "day": "Monday"}. Para mais informações, acesse Usar variáveis de ambiente.
  • SOURCE_CODE: a definição do fluxo de trabalho. É necessário fazer o escape de novas linhas no YAML. Exemplo: main:\n params:\n - input\n steps:\n - returnOutput:\n return: Hello

    É necessário fazer o escape das aspas no JSON. Por exemplo: {\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}

  • LOCATION: a região em que o fluxo de trabalho será implantado (por exemplo, us-central1).

Solicitar corpo JSON: 

{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

Para enviar a solicitação, expanda uma destas opções:

Se houver êxito, o corpo da resposta conterá uma instância de Operation: 

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "create",
    "apiVersion": "v1"
  },
  "done": false
}

Se o valor de "done" for false, a operação ainda estará em andamento.

Listar fluxos de trabalho

É possível listar fluxos de trabalho ou usar filtros para recuperar um fluxo de trabalho específico.

Console

  1. No console do Google Cloud, abra a página Workflows.

    Acessar fluxos de trabalho

    Esta página lista seus fluxos de trabalho em todos os locais e inclui detalhes como nomes, regiões, revisões mais recentes e muito mais.

  2. Para filtrar os fluxos de trabalho:

    1. Clique em Filtro ou no campo Filtrar fluxos de trabalho.
    2. Na lista Propriedades, selecione uma opção para filtrar os fluxos de trabalho.

    É possível selecionar uma única propriedade ou usar o operador lógico OR para adicionar mais propriedades.

  3. Para classificar seus fluxos de trabalho, ao lado de qualquer cabeçalho de coluna compatível, clique em Classificar.

gcloud

Liste fluxos de trabalho usando o comando gcloud workflows list:

gcloud workflows list --location=LOCATION

Substitua LOCATION pelo ID ou pelo identificador totalmente qualificado para o local do seu fluxo de trabalho.

Esse comando lista seus fluxos de trabalho no local especificado e inclui detalhes como NAME, STATE, REVISION_ID e UPDATE_TIME.

REST

Para listar fluxos de trabalho em um determinado projeto e local, use o método projects.locations.workflows.list.

Como alternativa, para recuperar os detalhes de um único fluxo de trabalho, use o método projects.locations.workflows.get.

Antes de usar os dados da solicitação, faça as substituições a seguir:

  • PROJECT_ID: o ID do projeto do Google Cloud.
  • LOCATION: a região em que os fluxos de trabalho são implantados. Por exemplo, us-central1.

Para enviar a solicitação, expanda uma destas opções:

Se bem-sucedido, o corpo da resposta conterá instâncias de Workflow e a resposta será semelhante a esta: 

{
  "workflows": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
      "state": "ACTIVE",
      "revisionId": "000001-0ce",
      "createTime": "2023-12-08T13:56:59.306770745Z",
      "updateTime": "2023-12-08T13:56:59.547021939Z",
      "revisionCreateTime": "2023-12-08T13:56:59.340161044Z",
      "serviceAccount": "projects/PROJECT_ID/serviceAccounts/PROJECT_NUMBER-compute@developer.gserviceaccount.com",
      "sourceContents": "main:\n    params: [input]\n [...] return: '${wikiResult.body[1]}'\n"
    },
    {
      object (Workflow)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}

Atualizar um fluxo de trabalho

É possível atualizar um fluxo de trabalho existente. Especifique o nome e a origem do fluxo de trabalho que você quer atualizar. Não é possível alterar o nome ou o local de um fluxo de trabalho.

A atualização de um fluxo de trabalho não afeta as execuções em andamento. Somente execuções futuras do fluxo de trabalho usarão a configuração atualizada.

Sempre que você atualiza um fluxo de trabalho, o versionID é atualizado. O versionID consiste em duas partes, separadas por hífen:

  • Um número, começando em um, que aumenta cada vez que você atualiza um fluxo de trabalho.

  • Uma string alfanumérica aleatória de três caracteres.

Por exemplo, 000001-27f indica a versão inicial de um fluxo de trabalho, e 000002-d52 indica um fluxo de trabalho que foi atualizado uma vez.

Console

  1. No console do Google Cloud, abra a página Workflows.

    Acessar fluxos de trabalho

  2. Clique no nome do fluxo de trabalho que você quer atualizar. Não é possível alterar o nome do fluxo de trabalho.

    A página Detalhes do fluxo de trabalho é exibida.

  3. É possível editar o fluxo de trabalho das seguintes maneiras:

    • Para editar a fonte:

      1. Clique na guia Origem.
      2. Clique em Editar.
      3. Para salvar as alterações, clique em Save. O fluxo de trabalho atualizado é implantado.

    • Para atualizar a descrição, a conta de serviço que o fluxo de trabalho usa para autenticação, o nível de registro de chamadas, as variáveis de ambiente, os rótulos ou a chave de criptografia:

      1. Clique na guia Detalhes.
      2. Clique no ícone apropriado.
      3. Se você estiver atualizando o nível de registro de chamadas, selecione uma das seguintes opções:
        • Não especificado: nenhum nível de registro foi especificado. Esse é o padrão. Um nível de registro de execução tem precedência sobre qualquer nível de registro de fluxo de trabalho, a menos que o nível de registro de execução não seja especificado (o padrão). Nesse caso, o nível de registro de fluxo de trabalho é aplicado.
        • Somente erros: registra todas as exceções identificadas; ou quando uma chamada é interrompida devido a uma exceção.
        • Todas as chamadas: registre todas as chamadas para subfluxos de trabalho ou funções de biblioteca e os respectivos resultados.
        • Sem registros: nenhum registro de chamadas.
      4. Se você atualizar um rótulo existente ou adicionar um novo, pode levar até 10 minutos para que o novo rótulo entre em vigor. Os rótulos do fluxo de trabalho são herdados pelas execuções do fluxo de trabalho. Para visualizar os rótulos de execução, use o método workflows.executions.list para listar e filtrar as execuções de fluxo de trabalho.
      5. Para salvar as alterações, clique em Save. O fluxo de trabalho atualizado é implantado.

    • Para editar os campos anteriores ao mesmo tempo ou adicionar ou atualizar um acionador:

      1. Clique em Editar.
      2. Para editar a origem, clique em Próxima.
      3. Para salvar as alterações e implantar o fluxo de trabalho atualizado, clique em Implantar.

  4. Para atualizar os papéis da conta de serviço, clique na guia Permissões.

    1. Os principais são usuários, grupos, domínios ou contas de serviço. Para atualizar um principal existente:

      1. Encontre a linha que contém o principal.
      2. Clique em Editar principal nessa linha.
      3. Clique em Adicionar outro papel ou clique em Excluir papel.

    2. Se você estiver adicionando um papel, na lista Selecionar um papel, escolha um papel apropriado.

    3. Para adicionar outro papel, clique em Adicionar outro papel.

    4. Clique em Salvar.

gcloud

  1. Abra um terminal.

  2. Encontre o nome do fluxo de trabalho que você quer atualizar. Se você não souber o nome dele, insira o seguinte comando para listar todos os fluxos de trabalho:

    gcloud workflows list

  3. Localize o arquivo YAML ou JSON em que a origem do fluxo de trabalho está salva, como WORKFLOW_NAME.YAML ou WORKFLOW_NAME.JSON.

  4. É possível atualizar um fluxo de trabalho atual para alterar a origem, a descrição, os rótulos, as variáveis de ambiente, o nível de registro de chamadas, a chave de criptografia ou a conta de serviço associada usando o comando gcloud workflows deploy.

    É preciso especificar o nome e a origem do fluxo de trabalho que você quer atualizar. No entanto, as outras sinalizações são opcionais. Para remover uma chave de criptografia gerenciada pelo cliente, use a sinalização --clear-kms-key.

    gcloud workflows deploy WORKFLOW_NAME \
    --call-log-level=CALL_LOGGING_LEVEL \
    --description="DESCRIPTION" \
    --labels="LABEL_KEY=LABEL_VALUE" \
    --set-env-vars="ENV_KEY=ENV_VALUE" \
    --kms-key=ENCRYPT_KEY \
    --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
    --source=YAML_OR_JSON_SOURCE_FILE

    Substitua:

    • WORKFLOW_NAME: obrigatório. O nome do fluxo de trabalho.

    • CALL_LOGGING_LEVEL: opcional. Nível de registro de chamadas a ser aplicado ao fluxo de trabalho. Pode ser um dos seguintes:

      • none: nenhum nível de registro foi especificado. Esse é o padrão. Um nível de registro de execução tem precedência sobre qualquer nível de registro de fluxo de trabalho, a menos que o nível de registro de execução não seja especificado (o padrão). Nesse caso, o nível de registro de fluxo de trabalho é aplicado.
      • log-errors-only: registra todas as exceções identificadas. ou quando uma chamada é interrompida devido a uma exceção.
      • log-all-calls: registra todas as chamadas para subfluxos de trabalho ou funções de biblioteca e os resultados delas.
      • log-none: nenhum registro de chamadas.

    • DESCRIPTION: opcional. Uma descrição do fluxo de trabalho.

    • LABEL_KEY=LABEL_VALUE: opcional. Lista de pares de chave-valor de rótulo que ajuda a organizar as instâncias do Google Cloud. Por exemplo, name=wrench. Para mais informações, consulte O que são rótulos? Os rótulos do fluxo de trabalho são herdados pelas execuções do fluxo de trabalho. Para visualizar os rótulos de execução, use o método workflows.executions.list para listar e filtrar as execuções de fluxo de trabalho.

    • ENV_KEY=ENV_VALUE: opcional. Lista de pares de chave-valor variável de ambiente, por exemplo, MONTH=January. Para mais informações, consulte Usar variáveis de ambiente.

    • ENCRYPT_KEY: opcional. Uma chave do Cloud KMS que o fluxo de trabalho precisa usar para criptografia de dados no formato projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Para mais informações, consulte Usar chaves de criptografia gerenciadas pelo cliente.

    • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opcional. A conta de serviço que seu fluxo de trabalho usará para acessar outros serviços do Google Cloud. Se você quiser atualizar os papéis da conta de serviço, consulte Conceder permissão de fluxo de trabalho para acessar os recursos do Google Cloud e Gerenciar o acesso a projetos, pastas e organizações.

    • YAML_OR_JSON_SOURCE_FILE: obrigatório. O arquivo de origem do fluxo de trabalho no formato YAML ou JSON. Por exemplo, myFirstWorkflow.yaml.

REST

Para atualizar um fluxo de trabalho atual, use o método projects.locations.workflows.patch e, se quiser, use o parâmetro de consulta updateMask para especificar uma lista de campos a serem atualizados.

Antes de usar os dados da solicitação, faça as substituições a seguir:

Solicitar corpo JSON: 

{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

Para enviar a solicitação, expanda uma destas opções:

Se houver êxito, o corpo da resposta conterá uma instância de Operation: 

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "update",
    "apiVersion": "v1"
  },
  "done": false
}

Se o valor de "done" for false, a operação ainda estará em andamento.

Excluir um fluxo de trabalho

É possível excluir um fluxo de trabalho existente. A exclusão de um fluxo de trabalho também exclui as execuções dele e cancela todas as execuções ativas do fluxo de trabalho.

Console

  1. No console do Google Cloud, abra a página Workflows.

    Acessar fluxos de trabalho

  2. Clique no nome do fluxo de trabalho que você quer excluir e clique em Excluir.

  3. No prompt para confirmar a exclusão, digite o nome do fluxo de trabalho.

  4. Clique em Confirmar.

gcloud

  1. Abra um terminal.

  2. Encontre o nome do fluxo de trabalho que você quer excluir. Se você não souber o nome dele, insira o seguinte comando para listar todos os fluxos de trabalho:

    gcloud workflows list

  3. Exclua um fluxo de trabalho usando o comando gcloud workflows delete:

    gcloud workflows delete WORKFLOW_NAME

    Substitua WORKFLOW_NAME pelo nome do fluxo de trabalho.

REST

Para excluir um fluxo de trabalho com um nome especificado, use o método projects.locations.workflows.delete.

Antes de usar os dados da solicitação, faça as substituições a seguir:

  • WORKFLOW_NAME: o nome do fluxo de trabalho que você quer excluir.
  • PROJECT_ID: o ID do projeto do Google Cloud.
  • LOCATION: a região em que o fluxo de trabalho é implantado, por exemplo, us-central1.

Para enviar a solicitação, expanda uma destas opções:

Se houver êxito, o corpo da resposta conterá uma instância de Operation: 

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "delete",
    "apiVersion": "v1"
  },
  "done": false
}

Se o valor de "done" for false, a operação ainda estará em andamento.

A seguir