Gatilhos do Cloud Storage (1ª geração)

Observação: este conteúdo se aplica apenas às funções do Cloud Run (1a geração), anteriormente Cloud Functions (1a geração).

Para a versão das funções do Cloud Run deste documento, consulte o gatilhos do Cloud Storage.

No Cloud Run functions, um acionador do Cloud Storage permite que uma função seja chamada em resposta às mudanças no Cloud Storage. Ao especificar um gatilho do Cloud Storage para uma função, você escolhe um tipo de evento e um bucket do Cloud Storage. A função será chamada sempre que ocorrer uma alteração em um objeto (arquivo) no bucket especificado.

Observação: para que uma Cloud Run function seja acionada por um evento em um bucket do Cloud Storage, a função e o bucket precisam estar no mesmo projeto do Google Cloud.

Os seguintes tipos de eventos do Cloud Storage são compatíveis:

Evento	Tipo de evento	Descrição
Objeto finalizado	google.storage.object.finalize	Isso ocorre quando um novo objeto é criado ou um objeto existente é substituído e uma nova geração desse objeto é criada.
Objeto excluído	google.storage.object.delete	Isso ocorre quando um objeto é excluído permanentemente.
Objeto arquivado	google.storage.object.archive	Isso ocorre quando uma versão ativa de um objeto se torna uma versão não atual. Consulte Controle de versão de objeto para mais informações.
Metadados de objetos atualizados	google.storage.object.metadataUpdate	Ocorre quando os metadados de um objeto são alterados.

Para que uma função use um acionador do Cloud Storage, ela precisa ser implementada como uma função orientada a eventos:

• Se você usar um Função CloudEvent , os dados de evento do Cloud Storage são transmitidos para sua função no Formato do CloudEvents e o payload de dados do CloudEvent é do tipoStorageObjectData.

• Se você usar uma função em segundo plano, o payload de dados de eventos do Cloud Storage será transmitido diretamente para sua função no formato StorageObjectData.

O repositório Eventos do Google contém outros recursos para trabalhar com dados de eventos.

Implantação

É possível especificar um acionador do Cloud Storage ao implantar uma função. Consulte Implantar uma função do Cloud Run para instruções gerais sobre como implantar uma função. Confira abaixo mais informações específicas para configurar gatilhos do Cloud Storage durante a implantação.

gcloud

Se você estiver implantando usando a CLI gcloud, poderá usar o tipo de evento Objeto finalizado do Cloud Storage com as seguintes sinalizações:

gcloud functions deploy YOUR_FUNCTION_NAME \
--no-gen2 \
--trigger-bucket=YOUR_STORAGE_BUCKET \
[--retry] \
...

• A flag --trigger-bucket especifica o bucket do Cloud Storage que será monitorado pelo gatilho. Eventos finalizados pelo objeto nesse bucket acionarão chamadas para sua função.
• A sinalização --retry controla se as chamadas de função com falha são repetidas automaticamente. Consulte Como repetir funções orientadas a eventos para mais informações.

Para usar tipos de eventos diferentes de objeto finalizado, use as seguintes sinalizações:

  gcloud functions deploy YOUR_FUNCTION_NAME 

  --no-gen2 

  --trigger-event=EVENT_TYPE 

  --trigger-resource=YOUR_STORAGE_BUCKET 

  ...
  

Eventos legados do Cloud Storage

As funções legadas no Cloud Run functions (1ª geração) usam notificações de alteração de objeto legadas para gatilhos do Cloud Storage:

gcloud functions deploy YOUR_FUNCTION_NAME \
--no-gen2 \
--trigger-event=providers/cloud.storage/eventTypes/object.change \
--trigger-resource=YOUR_STORAGE_BUCKET \
...

Esse tipo de evento é compatível com funções legadas que já consomem esses eventos. No entanto, não recomendamos usar esse tipo de evento, porque ele pode ser removido em uma data futura.

Console

Se você estiver implantando usando o Console do Google Cloud, será possível configurar um acionador do Cloud Storage na seção Acionador:

1. No campo tipo de Acionador, selecione Cloud Storage.
2. No campo Tipo de evento, selecione um tipo.
3. No campo Bucket, clique em Procurar para selecionar um bucket do Cloud Storage para o gatilho monitorar. As alterações feitas nos objetos dentro desse bucket acionarão chamadas para sua função.
4. Marque ou desmarque a caixa de seleção Tentar novamente em caso de falha para controlar se novas tentativas são feitas automaticamente. Consulte Como repetir funções orientadas a eventos para mais informações.

Entrega de eventos

Os gatilhos do Cloud Storage são implementados com notificações do Pub/Sub para Cloud Storage. Os eventos estão sujeitos às garantias de entrega de notificações do Pub/Sub.

Um bucket do Cloud Storage pode ter até 10 configurações de notificação definidas para gatilho de um evento específico. Exceder os limites de notificações do bucket fará com que outras implantações de função falhem com um erro como este:

Cloud Storage bucket ...: Pub/Sub notification limit reached

Consulte Cotas e limites do Cloud Storage para saber mais.

Próximas etapas

• Saiba como escrever funções baseadas em eventos.
• Saiba como implantar uma função do Cloud Run.
• Consulte o tutorial de função do Cloud Storage para ver um exemplo de gravação, implantação e chamada de uma função com um gatilho do Cloud Storage.