Neste tutorial básico, demonstraremos como escrever, implantar e acionar uma função do Cloud Run orientada a eventos com um gatilho do Cloud Storage para responder a eventos do Cloud Storage.
Se você está procurando amostras de código para usar o Cloud Storage em si, acesse a pesquisa de exemplos de código do Google Cloud do Google Cloud.
Objetivos
- Escrever e implantar uma função do Cloud Run orientada a eventos.
- Acionar a função fazendo upload de um arquivo no Cloud Storage.
Custos
Neste documento, você usará os seguintes componentes faturáveis do Google Cloud:
- Cloud Run functions
- Cloud Storage
Para gerar uma estimativa de custo baseada na projeção de uso deste tutorial, use a calculadora de preços.
Para seguir as instruções da tarefa diretamente no editor do Cloud Shell, clique em Orientação:
Antes de começar
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Verifique se a cobrança está ativada para o seu projeto do Google Cloud.
-
Enable the Cloud Functions, Cloud Build, Cloud Storage, and Eventarc APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Verifique se a cobrança está ativada para o seu projeto do Google Cloud.
-
Enable the Cloud Functions, Cloud Build, Cloud Storage, and Eventarc APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Prepare seu ambiente de desenvolvimento:
Node.js
Python
Go
Java
C#
Ruby
PHP
Se a gcloud CLI já estiver instalada, atualize-a executando o seguinte comando:
gcloud components update
Como preparar o aplicativo
Crie um bucket do Cloud Storage para fazer upload de um arquivo de teste, em que
YOUR_TRIGGER_BUCKET_NAME
é um nome de bucket globalmente exclusivo:gcloud storage buckets create gs://YOUR_TRIGGER_BUCKET_NAME
Clone o repositório do app de amostra na máquina local:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.
C#
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.
Ruby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.
PHP
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git
Outra alternativa é fazer o download da amostra como um arquivo ZIP e extraí-lo.
Mude para o diretório que contém o código de amostra das funções do Cloud Run:
Node.js
cd nodejs-docs-samples/functions/helloworld/
Python
cd python-docs-samples/functions/helloworld/
Go
cd golang-samples/functions/helloworld/
Java
cd java-docs-samples/functions/helloworld/hello-gcs/
C#
cd dotnet-docs-samples/functions/helloworld/HelloGcs/
Ruby
cd ruby-docs-samples/functions/helloworld/storage/
PHP
cd php-docs-samples/functions/helloworld_storage/
Como implantar e acionar a função
Atualmente, as funções do Cloud Storage são baseadas em notificações de Pub/Sub do Cloud Storage e são compatíveis com tipos de eventos semelhantes:
As seções a seguir descrevem como implantar e acionar uma função para cada um desses tipos de eventos.
Finalização do objeto
Os eventos de finalização de objeto são acionados quando um "write" (escrever) de um objeto do Cloud Storage é finalizado com sucesso. Especificamente, isso significa que criar um novo objeto ou substituir um objeto existente aciona esse evento. As operações de atualização de metadados e arquivamento são ignoradas por esse gatilho.
Finalização do objeto: como implantar a função
Confira a amostra da função, que processa os eventos do Cloud Storage:
Node.js
Python
Go
Java
C#
Ruby
PHP
Para implantar a função, execute o seguinte comando no diretório em que o código de amostra está localizado:
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs20 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do Node.js compatível a fim de executar a função.
Python
gcloud functions deploy hello_gcs \ --runtime python312 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Python a fim de executar a função.
Go
gcloud functions deploy HelloGCS \ --runtime go121 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do Go compatível a fim de executar a função.
Java
gcloud functions deploy java-gcs-function \ --entry-point functions.HelloGcs \ --runtime java17 \ --memory 512MB \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Java a fim de executar a função.
C#
gcloud functions deploy csharp-gcs-function \ --entry-point HelloGcs.Function \ --runtime dotnet6 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do .NET compatível a fim de executar a função.
Ruby
gcloud functions deploy hello_gcs --runtime ruby32 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Ruby a fim de executar a função.
PHP
gcloud functions deploy helloGCS --runtime php82 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Use a flag --runtime
para especificar o ID do ambiente de execução de uma
versão do PHP compatível a fim de executar
a função.
em que YOUR_TRIGGER_BUCKET_NAME
é o nome do bucket do
Cloud Storage que aciona a função.
Finalização do objeto: como acionar a função
Para acionar a função:
Crie um arquivo vazio
gcf-test.txt
no diretório em que o código de amostra está localizado.Faça upload do arquivo no Cloud Storage para acionar a função:
gcloud storage cp gcf-test.txt gs://YOUR_TRIGGER_BUCKET_NAME
em que
YOUR_TRIGGER_BUCKET_NAME
é o nome do bucket do Cloud Storage onde será feito o upload de um arquivo de teste.Verifique os registros para confirmar se execuções foram concluídas:
gcloud functions logs read --limit 50
Exclusão do objeto
Os eventos de exclusão de objetos são mais úteis para buckets sem controle de versão. Eles são acionados quando uma versão antiga de um objeto é excluída. Além disso, eles são acionados quando um objeto é sobrescrito. Os acionadores de exclusão de objetos também podem ser usados com os buckets de controle de versão, acionados quando uma versão de um objeto é excluída permanentemente.
Exclusão do objeto: como implantar a função
Usando o mesmo código de amostra do exemplo final, implante a função com exclusão de objetos como o evento gatilho. Execute o seguinte comando no diretório em que o código de amostra está localizado:
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs20 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do Node.js compatível a fim de executar a função.
Python
gcloud functions deploy hello_gcs \ --runtime python312 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Python a fim de executar a função.
Go
gcloud functions deploy HelloGCS \ --runtime go121 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do Go compatível a fim de executar a função.
Java
gcloud functions deploy java-gcs-function \ --entry-point functions.HelloGcs \ --runtime java17 \ --memory 512MB \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Java a fim de executar a função.
C#
gcloud functions deploy csharp-gcs-function \ --entry-point HelloGcs.Function \ --runtime dotnet6 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do .NET compatível a fim de executar a função.
Ruby
gcloud functions deploy hello_gcs --runtime ruby32 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Ruby a fim de executar a função.
PHP
gcloud functions deploy helloGCS --runtime php82 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Use a flag --runtime
para especificar o ID do ambiente de execução de uma
versão do PHP compatível a fim de executar
a função.
em que YOUR_TRIGGER_BUCKET_NAME
é o nome do bucket do
Cloud Storage que aciona a função.
Exclusão do objeto: como acionar a função
Para acionar a função:
Crie um arquivo vazio
gcf-test.txt
no diretório em que o código de amostra está localizado.Verifique se o bucket não tem controle de versão:
gcloud storage buckets update gs://YOUR_TRIGGER_BUCKET_NAME --no-versioning
Faça upload do arquivo no Cloud Storage:
gcloud storage cp gcf-test.txt gs://YOUR_TRIGGER_BUCKET_NAME
em que
YOUR_TRIGGER_BUCKET_NAME
é o nome do bucket do Cloud Storage onde será feito o upload de um arquivo de teste. Neste momento, a função ainda não é executada.Exclua o arquivo para acionar a função:
gcloud storage rm gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt
Verifique os registros para confirmar se execuções foram concluídas:
gcloud functions logs read --limit 50
Observe que a execução da função pode levar algum tempo para ser concluída.
Arquivamento do objeto
Os eventos de arquivamento de objeto podem ser usados apenas com buckets de controle de versão. Eles são acionados quando uma versão antiga de um objeto é arquivada. Especificamente, isso significa que, quando um objeto é sobrescrito ou excluído, um evento de arquivamento é acionado.
Arquivamento do objeto: como implantar a função
Usando o mesmo código de amostra do exemplo final, implante a função com arquivamento de objetos como o evento gatilho. Execute o seguinte comando no diretório em que o código de amostra está localizado:
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs20 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do Node.js compatível a fim de executar a função.
Python
gcloud functions deploy hello_gcs \ --runtime python312 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Python a fim de executar a função.
Go
gcloud functions deploy HelloGCS \ --runtime go121 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do Go compatível a fim de executar a função.
Java
gcloud functions deploy java-gcs-function \ --entry-point functions.HelloGcs \ --runtime java17 \ --memory 512MB \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Java a fim de executar a função.
C#
gcloud functions deploy csharp-gcs-function \ --entry-point HelloGcs.Function \ --runtime dotnet6 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do .NET compatível a fim de executar a função.
Ruby
gcloud functions deploy hello_gcs --runtime ruby32 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Ruby a fim de executar a função.
PHP
gcloud functions deploy helloGCS --runtime php82 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Use a flag --runtime
para especificar o ID do ambiente de execução de uma
versão do PHP compatível a fim de executar
a função.
em que YOUR_TRIGGER_BUCKET_NAME
é o nome do bucket do
Cloud Storage que aciona a função.
Arquivamento do objeto: como acionar a função
Para acionar a função:
Crie um arquivo vazio
gcf-test.txt
no diretório em que o código de amostra está localizado.Verifique se o controle de versão do seu bucket está ativado:
gcloud storage buckets update gs://YOUR_TRIGGER_BUCKET_NAME --versioning
Faça upload do arquivo no Cloud Storage:
gcloud storage cp gcf-test.txt gs://YOUR_TRIGGER_BUCKET_NAME
em que
YOUR_TRIGGER_BUCKET_NAME
é o nome do bucket do Cloud Storage onde será feito o upload de um arquivo de teste. Neste momento, a função ainda não é executada.Arquive o arquivo para acionar a função:
gcloud storage rm gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt
Verifique os registros para ter certeza de que as execuções foram concluídas:
gcloud functions logs read --limit 50
Atualização de metadados do objeto
Os eventos de atualização de metadados são acionados quando os metadados do objeto existente são atualizados.
Atualização de metadados do objeto: como implantar a função
Usando o mesmo código de amostra do exemplo final, implante a função com atualização de metadados como o evento gatilho. Execute o seguinte comando no diretório em que o código de amostra está localizado:
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs20 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do Node.js compatível a fim de executar a função.
Python
gcloud functions deploy hello_gcs \ --runtime python312 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Python a fim de executar a função.
Go
gcloud functions deploy HelloGCS \ --runtime go121 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do Go compatível a fim de executar a função.
Java
gcloud functions deploy java-gcs-function \ --entry-point functions.HelloGcs \ --runtime java17 \ --memory 512MB \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Java a fim de executar a função.
C#
gcloud functions deploy csharp-gcs-function \ --entry-point HelloGcs.Function \ --runtime dotnet6 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão do .NET compatível a fim de executar a função.
Ruby
gcloud functions deploy hello_gcs --runtime ruby32 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Use a flag --runtime
para especificar o ID do ambiente de execução de uma versão compatível do Ruby a fim de executar a função.
PHP
gcloud functions deploy helloGCS --runtime php82 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Use a flag --runtime
para especificar o ID do ambiente de execução de uma
versão do PHP compatível a fim de executar
a função.
em que YOUR_TRIGGER_BUCKET_NAME
é o nome do bucket do
Cloud Storage que aciona a função.
Atualização de metadados do objeto: como acionar a função
Para acionar a função:
Crie um arquivo vazio
gcf-test.txt
no diretório em que o código de amostra está localizado.Verifique se o bucket não tem controle de versão:
gcloud storage buckets update gs://YOUR_TRIGGER_BUCKET_NAME --no-versioning
Faça upload do arquivo no Cloud Storage:
gcloud storage cp gcf-test.txt gs://YOUR_TRIGGER_BUCKET_NAME
em que
YOUR_TRIGGER_BUCKET_NAME
é o nome do bucket do Cloud Storage onde será feito o upload de um arquivo de teste. Neste momento, a função ainda não é executada.Atualize os metadados do arquivo:
gcloud storage objects update gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt --content-type=text/plain
Verifique os registros para ter certeza de que as execuções foram concluídas:
gcloud functions logs read --limit 50
Limpar
Para evitar cobranças na sua conta do Google Cloud pelos recursos usados no tutorial, exclua o projeto que os contém ou mantenha o projeto e exclua os recursos individuais.
Excluir o projeto
O jeito mais fácil de evitar cobranças é excluindo o projeto que você criou para o tutorial.
Para excluir o projeto:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Como excluir a função
A exclusão de funções do Cloud Run não remove nenhum recurso armazenado no Cloud Storage.
Para excluir a função criada neste tutorial, execute o seguinte comando:
Node.js
gcloud functions delete helloGCS
Python
gcloud functions delete hello_gcs
Go
gcloud functions delete HelloGCS
Java
gcloud functions delete java-gcs-function
C#
gcloud functions delete csharp-gcs-function
Ruby
gcloud functions delete hello_gcs
PHP
gcloud functions delete helloGCS
Também é possível excluir funções do Cloud Run pelo Console do Google Cloud.