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 com a 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

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

Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para isso, basta remover todos os recursos associados a ele.

Acessar o seletor de projetos
Verifique se a cobrança está ativada para o projeto do Google Cloud. Saiba como verificar se o faturamento está ativado em um projeto.
Ative a API Workflows.

Ative a API

gcloud

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.
Verifique se a cobrança está ativada para o projeto do Google Cloud. Saiba como verificar se o faturamento está ativado em um projeto.

Ative a API Workflows.

gcloud services enable workflows.googleapis.com

REST

Para gerenciar fluxos de trabalho usando a API Workflows, recomendamos que você use 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 a ela 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, o fluxo de trabalho usará a conta de serviço padrão do Compute Engine como identidade. Para mais informações, consulte 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 representar a conta de serviço que você vai anexar ao recurso. Para mais informações, consulte Permissões da conta de serviço.

Console

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

Acessar a página "Contas de serviço"
Selecione um projeto e clique em Criar conta de serviço.
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.
Clique em Criar e continuar.
Clique em Selecionar papel.
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 ao Cloud Logging, selecione Logging > Gravador de registros.
Importante: para ambientes de produção, o Google recomenda criar uma nova conta de serviço e conceder a ela um ou mais papéis do IAM que contenham as permissões mínimas necessárias para gerenciar fluxos de trabalho. Para saber mais sobre quais permissões e papéis estão disponíveis no Workflows, consulte Controle de acesso.
Clique em Concluído para terminar a criação da conta de serviço.

gcloud

Crie a conta de serviço.

gcloud iam service-accounts create SERVICE_ACCOUNT

Conceda permissões à conta de serviço atribuindo papéis.
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 ao 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.
Importante: para ambientes de produção, o Google recomenda criar uma nova conta de serviço e conceder a ela um ou mais papéis do IAM que contenham as permissões mínimas necessárias para gerenciar fluxos de trabalho. Para saber mais sobre quais permissões e papéis estão disponíveis no Workflows, consulte Controle de acesso.

REST

Use 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 de maneira programática. Para isso, modifique e defina a política de permissão de um recurso com o método setIamPolicy. Para mais informações, acesse 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, você o implanta 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

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

Acessar fluxos de trabalho
Clique em Criar.
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
Como opção, adicione uma descrição do fluxo de trabalho.
Na lista Região, selecione um local apropriado para implantar seu fluxo de trabalho. Por exemplo, us-central1.
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.
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?
  
  Observação: pode levar até 10 minutos para que o novo marcador entre em vigor.
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.
Clique em Próxima.
No editor de fluxo de trabalho, insira a definição para seu fluxo de trabalho. Veja um exemplo de fluxo de trabalho.
Selecione Implantar.

gcloud

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.
Abra um terminal.
É 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 seu 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ótulos que ajuda a organizar suas instâncias do Google Cloud. Por exemplo, name=wrench. Para mais informações, consulte O que são rótulos?
  
  Observação: pode levar até 10 minutos para que o novo marcador entre em vigor.
- 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, neste documento, consulte Criar uma conta de serviço.
- 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 seu fluxo de trabalho. Por exemplo, myFirstWorkflow. Ele 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 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ótulo que ajudam você a organizar suas instâncias do Google Cloud. Por exemplo: {"name": "wrench", "mass": "1kg", "count": "3"}. Para mais informações, consulte O que são rótulos? Pode levar até 10 minutos para que o novo rótulo entre em vigor.
SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opcional. A conta de serviço que o 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, neste documento, consulte Criar uma conta de serviço.
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 será aplicado. Para mais informações, acesse Enviar registros para o Logging. Uma das seguintes opções:
- CALL_LOG_LEVEL_UNSPECIFIED: nenhum nível de geração de registros é especificado. Em vez disso, 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. É preciso fazer o escape de novas linhas em YAML. Exemplo: main:\n params:\n - input\n steps:\n - returnOutput:\n return: Hello
É necessário fazer o escape de 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:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. É possível verificar a conta ativa atualmente executando gcloud auth list.

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

cat > request.json << 'EOF'
{
  "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"
}
EOF

Depois execute o comando a seguir para enviar a solicitação REST:

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

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

@'
{
  "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"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Depois execute o comando a seguir para enviar a solicitação REST:

$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://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows?workflowId=WORKFLOW_NAME" | Select-Object -Expand Content

APIs Explorer (navegador)

Copie o corpo da solicitação e abra a página de referência do método. O painel "APIs Explorer" é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Cole o corpo da solicitação nessa ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.

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 específico.

Console

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.
Para filtrar seus fluxos de trabalho:
1. Clique em Filtrar 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.
Para classificar os 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 identificador totalmente qualificado do 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 de um fluxo de trabalho.

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:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

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

PowerShell (Windows)

execute o seguinte comando:

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

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

APIs Explorer (navegador)

Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Preencha todos os campos obrigatórios e clique em Executar.

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. Especifique o nome do fluxo de trabalho que você quer atualizar e a origem dele. 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 toda 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 que foi atualizado uma vez.

Console

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

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

A página Detalhes do fluxo de trabalho é exibida.
É 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 será 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 adequado.
  3. Se você estiver atualizando o nível do 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. Para salvar as alterações, clique em Save. O fluxo de trabalho atualizado será implantado.
- Para editar os campos anteriores ao mesmo tempo ou adicionar ou atualizar um acionador:
  1. Clique em Editar.
  2. Para editar a fonte, clique em Próxima.
  3. Para salvar suas alterações e implantar o fluxo de trabalho atualizado, clique em Implantar.
Observação :se você atualizar um rótulo atual ou adicionar um novo, pode levar até 10 minutos para que o novo rótulo entre em vigor.
Para atualizar os papéis de sua 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 atual:
  1. Encontre uma linha que contenha 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 incluir outro papel, clique em Adicionar outro papel.
4. Clique em Salvar.
Observação: para alterar a conta de serviço usada pelo fluxo de trabalho para autenticação, ainda é preciso editar o fluxo de trabalho e modificar a conta de serviço conforme detalhado na etapa anterior. Para mais informações, consulte Conceder permissão a um fluxo de trabalho para acessar os recursos do Google Cloud.

gcloud

Abra um terminal.
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
```
Localize o arquivo YAML ou JSON em que a origem do fluxo de trabalho é salva, como WORKFLOW_NAME.YAML ou WORKFLOW_NAME.JSON.
É possível atualizar um fluxo de trabalho existente 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 do fluxo de trabalho que você quer atualizar e a origem dele. 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ótulos que ajuda a organizar suas instâncias do Google Cloud. Por exemplo, name=wrench. Para mais informações, consulte O que são rótulos?
  
  Observação :se você atualizar um rótulo atual ou adicionar um novo, pode levar até 10 minutos para que o novo rótulo entre em vigor.
- 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 uma 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 em 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, opcionalmente, utilize 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:

WORKFLOW_NAME: o nome do seu fluxo de trabalho. Por exemplo, myFirstWorkflow.
DESCRIPTION: opcional. Uma descrição do 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ótulo que ajudam você a organizar suas instâncias do Google Cloud. Por exemplo: {"name": "wrench", "mass": "1kg", "count": "3"}. Para mais informações, consulte O que são rótulos? Pode levar até 10 minutos para que o novo rótulo entre em vigor.
SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: opcional. A conta de serviço que o 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, neste documento, consulte Criar uma conta de serviço.
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 será aplicado. Para mais informações, acesse Enviar registros para o Logging. Uma das seguintes opções:
- CALL_LOG_LEVEL_UNSPECIFIED: nenhum nível de geração de registros é especificado. Em vez disso, 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 reduzida do fluxo de trabalho. Exemplo: {\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}
LOCATION: a região em que o fluxo de trabalho é implantado. Por exemplo, us-central1.
UPDATE_FIELDS: opcional. Uma lista separada por vírgulas de campos a serem atualizados. Se não for fornecido, todo o fluxo de trabalho será atualizado. Por exemplo, description,callLogLevel.

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:

curl (Linux, macOS ou Cloud Shell)

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

cat > request.json << 'EOF'
{
  "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"
}
EOF

Depois execute o comando a seguir para enviar a solicitação REST:

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

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

@'
{
  "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"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Depois execute o comando a seguir para enviar a solicitação REST:

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

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

APIs Explorer (navegador)

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. A exclusão de um fluxo de trabalho também remove as execuções dele e cancela quaisquer execuções ativas dele.

Console

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

Acessar fluxos de trabalho
Clique no nome do fluxo de trabalho que você quer excluir e em Excluir.
No prompt para confirmar a exclusão, insira o nome do fluxo de trabalho.
Clique em Confirmar.

gcloud

Abra um terminal.
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
```
Exclua um fluxo de trabalho usando o comando gcloud workflows delete:
```
gcloud workflows delete WORKFLOW_NAME
```
Substitua WORKFLOW_NAME pelo nome do seu 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:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

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

PowerShell (Windows)

execute o seguinte comando:

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

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

APIs Explorer (navegador)

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.

Criar e gerenciar fluxos de trabalho

Antes de começar

Console

gcloud

REST

Crie uma conta de serviço

Console

gcloud

REST

Criar um fluxo de trabalho

Console

gcloud

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

APIs Explorer (navegador)

Listar fluxos de trabalho

Console

gcloud

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

APIs Explorer (navegador)

Atualizar um fluxo de trabalho

Console

gcloud

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

APIs Explorer (navegador)

Excluir um fluxo de trabalho

Console

gcloud

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

APIs Explorer (navegador)

A seguir