Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Gatilhos do Cloud Storage

No Cloud Functions, um acionador do Cloud Storage permite que uma função seja chamada em resposta às mudanças no Cloud Storage. Ao especificar um acionador 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.

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

Evento Tipo de evento Descrição
Objeto finalizado
  • 2a geração: google.cloud.storage.object.v1.finalized (por meio do Eventarc)
  • 1ª geração: 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
  • 2a geração: google.cloud.storage.object.v1.deleted (por meio do Eventarc)
  • 1ª geração: google.storage.object.delete
Isso ocorre quando um objeto é excluído permanentemente.
Objeto arquivado
  • 2a geração: google.cloud.storage.object.v1.archived (por meio do Eventarc)
  • 1ª geração: 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
  • 2a geração: google.cloud.storage.object.v1.metadataUpdated (por meio do Eventarc)
  • 1ª geração: 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:

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

Permissões

Para usar acionadores do Cloud Storage, o Agente de serviço do Cloud Storage precisa ter oEditor do Pub/Sub (roles/pubsub.publisher ) Papel do IAM no seu projeto.

Implantação

É possível especificar um acionador do Cloud Storage ao implantar uma função. Consulte Implantar uma função do Cloud para instruções gerais sobre como implantar uma função. Veja abaixo mais informações específicas para configurar acionadores 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 \
--trigger-bucket=YOUR_STORAGE_BUCKET \
[--retry] \
...
  • A sinalização --trigger-bucket especifica o bucket do Cloud Storage que o acionador vai monitorar. 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:

  • Para o Cloud Functions (2a geração):

    gcloud functions deploy YOUR_FUNCTION_NAME \
    --gen2 \
    --trigger-event-filters="type=EVENT_TYPE" \
    --trigger-event-filters="bucket=YOUR_STORAGE_BUCKET" \
    ...
    
  • Para o Cloud Functions (1a geração):

    gcloud functions deploy YOUR_FUNCTION_NAME \
    --trigger-event=EVENT_TYPE \
    --trigger-resource=YOUR_STORAGE_BUCKET \
    ...
    

Eventos legados do Cloud Storage

As funções legadas no Cloud Functions (1a geração) usam notificações de alteração de objeto legadas para acionadores do Cloud Storage:

gcloud functions deploy YOUR_FUNCTION_NAME \
--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 o uso desse tipo de evento, já que ele poderá ser removido no futuro.

Console

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

  • Para o Cloud Functions (2a geração):

    1. Clique em Adicionar gatilho do Eventarc para adicionar um acionador de evento. Isso abre o painel Acionador do Eventarc.
    2. No campo Provedor de eventos, selecione Cloud Storage.
    3. No campo Evento, selecione um tipo de evento.
    4. No campo Bucket, clique em Procurar para selecionar um bucket do Cloud Storage para o acionador monitorar. As alterações feitas nos objetos dentro deste bucket acionarão chamadas para sua função.
    5. 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.
    6. Clique em Salvar acionador.
  • Para o Cloud Functions (1a geração):

    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 acionador monitorar. As alterações feitas nos objetos dentro deste 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 acionar para 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