En este sencillo instructivo, se demuestra cómo escribir, implementar y activar una función de Cloud Functions basada en eventos con un activador de Cloud Storage para responder a eventos de Cloud Storage.
Visita el navegador de muestra de Google Cloud si buscas muestras de código de 1ª o 2ª gen. para usar Cloud Storage.
Objetivos
- Escribe e implementa una función de Cloud basada en eventos.
- Activar la función subiendo un archivo a Cloud Storage
Costos
En este documento, usarás los siguientes componentes facturables de Google Cloud:
- Cloud Functions
- Cloud Storage
Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios.
Para seguir la guía paso a paso sobre esta tarea directamente en el editor de Cloud Shell, haz clic en Guiarme:
Antes de comenzar
- 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.
-
Make sure that billing is enabled for your Google Cloud project.
-
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.
-
Make sure that billing is enabled for your Google Cloud project.
-
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
- Prepara tu entorno de desarrollo:
Si ya tienes instalado gcloud CLI, ejecuta el siguiente comando para actualizarla:
gcloud components update
Prepara la aplicación
Crea un depósito de Cloud Storage para subir un archivo de prueba, en el que
YOUR_TRIGGER_BUCKET_NAME
es un nombre de depósito único a nivel global:gsutil mb gs://YOUR_TRIGGER_BUCKET_NAME
Clona el repositorio de la aplicación de muestra en tu máquina local:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
C#
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
Ruby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
PHP
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
Ve al directorio que contiene el código de muestra de Cloud Functions, como sigue:
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/
Implementa y activa la función
Actualmente, las funciones de Cloud Storage se basan en notificaciones de Pub/Sub desde Cloud Storage y admiten tipos de eventos similares:
En las siguientes secciones, se describe cómo implementar y activar una función para cada uno de estos tipos de eventos.
Finalización del objeto
Los eventos de finalización del objeto se activan cuando una operación de “escritura” de un objeto de Cloud Storage se finaliza correctamente. En particular, esto significa que crear un objeto nuevo o reemplazar uno existente activa este evento. Este activador ignora las operaciones de actualización de archivo y metadatos.
Finalización del objeto: Implementa la función
Consulta la función de muestra que maneja los eventos de Cloud Storage:
Node.js
Python
Go
Java
C#
Ruby
PHP
Para implementar la función, ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs20 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión compatible de Node.js para ejecutar la función.
Python
gcloud functions deploy hello_gcs \ --runtime python312 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Python compatible para ejecutar la función.
Go
gcloud functions deploy HelloGCS \ --runtime go121 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Go compatible para ejecutar tu función.
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
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de Java compatible para ejecutar tu función.
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
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión .NET compatible para ejecutar tu función.
Rita
gcloud functions deploy hello_gcs --runtime ruby32 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Ruby compatible para ejecutar tu función.
PHP
gcloud functions deploy helloGCS --runtime php82 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una
versión de PHP compatible para ejecutar
la función.
donde YOUR_TRIGGER_BUCKET_NAME
es el nombre del depósito de Cloud Storage que activa la función.
Finalización del objeto: activa la función
Sigue estos pasos para activar la función:
Crea un archivo
gcf-test.txt
vacío en el directorio donde se encuentra el código de muestra.Sube el archivo a Cloud Storage para activar la función:
gsutil cp gcf-test.txt gs://YOUR_TRIGGER_BUCKET_NAME
en el que
YOUR_TRIGGER_BUCKET_NAME
es el nombre del depósito de Cloud Storage al que subirás un archivo de prueba.Verifica los registros para asegurarte de que las ejecuciones se completaron:
gcloud functions logs read --limit 50
Eliminación del objeto
Los eventos de eliminación del objeto son más útiles para los depósitos sin control de versiones. Se activan cuando se borra una versión antigua de un objeto. Además, también lo hacen cuando se reemplaza un objeto. Los activadores de eliminación del objeto también se pueden usar con los depósitos con control de versiones, que se activan cuando una versión de un objeto se borra permanentemente.
Eliminación del objeto: Implementa la función
Con el mismo código de muestra que en el ejemplo de finalización, implementa la función con el evento de eliminación del objeto como su activador. Ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs20 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión compatible de Node.js para ejecutar la función.
Python
gcloud functions deploy hello_gcs \ --runtime python312 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Python compatible para ejecutar la función.
Go
gcloud functions deploy HelloGCS \ --runtime go121 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Go compatible para ejecutar tu función.
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
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de Java compatible para ejecutar tu función.
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
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión .NET compatible para ejecutar tu función.
Rita
gcloud functions deploy hello_gcs --runtime ruby32 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Ruby compatible para ejecutar tu función.
PHP
gcloud functions deploy helloGCS --runtime php82 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.delete
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una
versión de PHP compatible para ejecutar
la función.
donde YOUR_TRIGGER_BUCKET_NAME
es el nombre del depósito de Cloud Storage que activa la función.
Eliminación del objeto: activa la función
Sigue estos pasos para activar la función:
Crea un archivo
gcf-test.txt
vacío en el directorio donde se encuentra el código de muestra.Asegúrate de que tu bucket no tenga control de versiones:
gsutil versioning set off gs://YOUR_TRIGGER_BUCKET_NAME
Sube el archivo a Cloud Storage:
gsutil cp gcf-test.txt gs://YOUR_TRIGGER_BUCKET_NAME
en el que
YOUR_TRIGGER_BUCKET_NAME
es el nombre del depósito de Cloud Storage al que subirás un archivo de prueba. En este punto, la función aún no debería ejecutarse.Borra el archivo para activar la función:
gsutil rm gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt
Verifica los registros para asegurarte de que las ejecuciones se completaron:
gcloud functions logs read --limit 50
Ten en cuenta que la función puede tardar algún tiempo en terminar de ejecutarse.
Archivado del objeto
Los eventos de archivado del objeto se pueden usar solo con depósitos con control de versiones. Se activan cuando se archiva una versión antigua de un objeto. En particular, esto significa que se activa un evento de archivado cuando un objeto se reemplaza o borra.
Archivado del objeto: Implementa la función
Con el mismo código de muestra que en el ejemplo de finalización, implementa la función con el evento de archivado del objeto como su activador. Ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs20 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión compatible de Node.js para ejecutar la función.
Python
gcloud functions deploy hello_gcs \ --runtime python312 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Python compatible para ejecutar la función.
Go
gcloud functions deploy HelloGCS \ --runtime go121 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Go compatible para ejecutar tu función.
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
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de Java compatible para ejecutar tu función.
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
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión .NET compatible para ejecutar tu función.
Rita
gcloud functions deploy hello_gcs --runtime ruby32 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Ruby compatible para ejecutar tu función.
PHP
gcloud functions deploy helloGCS --runtime php82 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.archive
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una
versión de PHP compatible para ejecutar
la función.
donde YOUR_TRIGGER_BUCKET_NAME
es el nombre del depósito de Cloud Storage que activa la función.
Archivado del objeto: activa la función
Sigue estos pasos para activar la función:
Crea un archivo
gcf-test.txt
vacío en el directorio donde se encuentra el código de muestra.Asegúrate de que tu bucket tenga el control de versiones habilitado:
gsutil versioning set on gs://YOUR_TRIGGER_BUCKET_NAME
Sube el archivo a Cloud Storage:
gsutil cp gcf-test.txt gs://YOUR_TRIGGER_BUCKET_NAME
en el que
YOUR_TRIGGER_BUCKET_NAME
es el nombre del depósito de Cloud Storage al que subirás un archivo de prueba. En este punto, la función aún no debería ejecutarse.Guarda el archivo para activar la función:
gsutil rm gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt
Revisa los registros para asegurarte de que las ejecuciones se completaron:
gcloud functions logs read --limit 50
Actualización de metadatos del objeto
Los eventos de actualización de metadatos del objeto se activan cuando se actualizan los metadatos del objeto existente.
Actualización de metadatos del objeto: Implementa la función
Con el mismo código de muestra que en el ejemplo de finalización, implementa la función con el evento de actualización de metadatos del objeto como su activador. Ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs20 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión compatible de Node.js para ejecutar la función.
Python
gcloud functions deploy hello_gcs \ --runtime python312 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Python compatible para ejecutar la función.
Go
gcloud functions deploy HelloGCS \ --runtime go121 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Go compatible para ejecutar tu función.
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
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de Java compatible para ejecutar tu función.
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
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión .NET compatible para ejecutar tu función.
Rita
gcloud functions deploy hello_gcs --runtime ruby32 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Ruby compatible para ejecutar tu función.
PHP
gcloud functions deploy helloGCS --runtime php82 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.metadataUpdate
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una
versión de PHP compatible para ejecutar
la función.
donde YOUR_TRIGGER_BUCKET_NAME
es el nombre del depósito de Cloud Storage que activa la función.
Actualización de metadatos del objeto: activa la función
Sigue estos pasos para activar la función:
Crea un archivo
gcf-test.txt
vacío en el directorio donde se encuentra el código de muestra.Asegúrate de que tu bucket no tenga control de versiones:
gsutil versioning set off gs://YOUR_TRIGGER_BUCKET_NAME
Sube el archivo a Cloud Storage:
gsutil cp gcf-test.txt gs://YOUR_TRIGGER_BUCKET_NAME
en el que
YOUR_TRIGGER_BUCKET_NAME
es el nombre del depósito de Cloud Storage al que subirás un archivo de prueba. En este punto, la función aún no debería ejecutarse.Actualiza los metadatos del archivo:
gsutil -m setmeta -h "Content-Type:text/plain" gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt
Revisa los registros para asegurarte de que las ejecuciones se completaron:
gcloud functions logs read --limit 50
Limpia
Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos usados en este instructivo, borra el proyecto que contiene los recursos o conserva el proyecto y borra los recursos individuales.
Borra el proyecto
La manera más fácil de eliminar la facturación es borrar el proyecto que creaste para el instructivo.
Para borrar el proyecto, sigue estos pasos:
- 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.
Borra la función de Cloud Functions
Borrar las funciones de Cloud Functions no quita ningún recurso almacenado en Cloud Storage.
Para borrar la función de Cloud Functions que creaste en este instructivo, ejecuta el siguiente 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
También puedes borrar funciones de Cloud Functions en la consola de Google Cloud.