Instructivo de Cloud Storage

En este sencillo instructivo, se muestra cómo escribir, implementar y activar una función de Cloud Functions en segundo plano con un activador de Cloud Storage.

Objetivos

Costos

En este instructivo, se usan componentes facturables de Cloud Platform, entre los que se incluyen estos:

  • Google Cloud Functions
  • Google Cloud Storage

Usa la calculadora de precios para generar una estimación de los costos según el uso previsto.

Es posible que los usuarios nuevos de Cloud Platform sean aptos para una prueba gratuita.

Antes de comenzar

  1. Accede a tu Cuenta de Google.

    Si todavía no tienes una cuenta, regístrate para obtener una nueva.

  2. Selecciona o crea un proyecto de GCP.

    Ir a la página Administrar recursos

  3. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

  4. Habilita las Cloud Functions and Cloud Storage API necesarias.

    Habilita las API

  5. Realiza la instalación y la inicialización del SDK de Cloud.
  6. Actualiza los componentes de gcloud:
    gcloud components update
  7. Prepara tu entorno de desarrollo:

Prepara la aplicación

  1. 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
    
  2. 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.

  3. Ve al directorio que contiene el código de muestra de Cloud Functions:

    Node.js 8/10

    cd nodejs-docs-samples/functions/node8/

    Node.js 6 (obsoleto)

    cd nodejs-docs-samples/functions/helloworld/

    Python

    cd python-docs-samples/functions/gcs/

    Go

    cd golang-samples/functions/helloworld/storage_generic/

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 sobrescribir 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 controla los eventos de Cloud Storage:

Node.js 8/10

/**
 * Generic background Cloud Function to be triggered by Cloud Storage.
 *
 * @param {object} data The event payload.
 * @param {object} context The event metadata.
 */
exports.helloGCSGeneric = (data, context) => {
  const file = data;
  console.log(`  Event ${context.eventId}`);
  console.log(`  Event Type: ${context.eventType}`);
  console.log(`  Bucket: ${file.bucket}`);
  console.log(`  File: ${file.name}`);
  console.log(`  Metageneration: ${file.metageneration}`);
  console.log(`  Created: ${file.timeCreated}`);
  console.log(`  Updated: ${file.updated}`);
};

Node.js 6 (obsoleto)

/**
 * Generic background Cloud Function to be triggered by Cloud Storage.
 *
 * @param {object} event The Cloud Functions event.
 * @param {function} callback The callback function.
 */
exports.helloGCSGeneric = (event, callback) => {
  const file = event.data;

  console.log(`  Event: ${event.eventId}`);
  console.log(`  Event Type: ${event.eventType}`);
  console.log(`  Bucket: ${file.bucket}`);
  console.log(`  File: ${file.name}`);
  console.log(`  Metageneration: ${file.metageneration}`);
  console.log(`  Created: ${file.timeCreated}`);
  console.log(`  Updated: ${file.updated}`);

  callback();
};

Python

def hello_gcs_generic(data, context):
    """Background Cloud Function to be triggered by Cloud Storage.
       This generic function logs relevant data when a file is changed.

    Args:
        data (dict): The Cloud Functions event payload.
        context (google.cloud.functions.Context): Metadata of triggering event.
    Returns:
        None; the output is written to Stackdriver Logging
    """

    print('Event ID: {}'.format(context.event_id))
    print('Event type: {}'.format(context.event_type))
    print('Bucket: {}'.format(data['bucket']))
    print('File: {}'.format(data['name']))
    print('Metageneration: {}'.format(data['metageneration']))
    print('Created: {}'.format(data['timeCreated']))
    print('Updated: {}'.format(data['updated']))

Go


// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"context"
	"fmt"
	"log"
	"time"

	"cloud.google.com/go/functions/metadata"
)

// GCSEvent is the payload of a GCS event.
type GCSEvent struct {
	Bucket         string    `json:"bucket"`
	Name           string    `json:"name"`
	Metageneration string    `json:"metageneration"`
	ResourceState  string    `json:"resourceState"`
	TimeCreated    time.Time `json:"timeCreated"`
	Updated        time.Time `json:"updated"`
}

// HelloGCSInfo prints information about a GCS event.
func HelloGCSInfo(ctx context.Context, e GCSEvent) error {
	meta, err := metadata.FromContext(ctx)
	if err != nil {
		return fmt.Errorf("metadata.FromContext: %v", err)
	}
	log.Printf("Event ID: %v\n", meta.EventID)
	log.Printf("Event type: %v\n", meta.EventType)
	log.Printf("Bucket: %v\n", e.Bucket)
	log.Printf("File: %v\n", e.Name)
	log.Printf("Metageneration: %v\n", e.Metageneration)
	log.Printf("Created: %v\n", e.TimeCreated)
	log.Printf("Updated: %v\n", e.Updated)
	return nil
}

Para implementar la función, ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:

Node.js 8

gcloud functions deploy helloGCSGeneric --runtime nodejs8 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.finalize

Node.js 10 (Beta)

gcloud functions deploy helloGCSGeneric --runtime nodejs10 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.finalize

Node.js 6 (obsoleto)

gcloud functions deploy helloGCSGeneric --runtime nodejs6 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.finalize

Python

gcloud functions deploy hello_gcs_generic --runtime python37 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.finalize

Go

gcloud functions deploy HelloGCSInfo --runtime go111 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.finalize

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:

  1. Crea un archivo gcf-test.txt vacío en el directorio donde se encuentra el código de muestra.

  2. 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.

  3. 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 elimina una versión antigua de un objeto. Además, también lo hacen cuando se sobrescribe 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 8

gcloud functions deploy helloGCSGeneric --runtime nodejs8 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.delete

Node.js 10 (Beta)

gcloud functions deploy helloGCSGeneric --runtime nodejs10 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.delete

Node.js 6 (obsoleto)

gcloud functions deploy helloGCSGeneric --runtime nodejs6 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.delete

Python

gcloud functions deploy hello_gcs_generic --runtime python37 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.delete

Go

gcloud functions deploy HelloGCSInfo --runtime go111 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.delete

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:

  1. Crea un archivo gcf-test.txt vacío en el directorio donde se encuentra el código de muestra.

  2. Asegúrate de que tu depósito no tenga control de versiones:

    gsutil versioning set off gs://YOUR_TRIGGER_BUCKET_NAME
    
  3. 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.

  4. Borra el archivo para activar la función:

    gsutil rm gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt
    
  5. 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 cuando un objeto se sobrescribe o borra, se activa un evento de archivado.

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 8

gcloud functions deploy helloGCSGeneric --runtime nodejs8 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.archive

Node.js 10 (Beta)

gcloud functions deploy helloGCSGeneric --runtime nodejs10 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.archive

Node.js 6 (obsoleto)

gcloud functions deploy helloGCSGeneric --runtime nodejs6 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.archive

Python

gcloud functions deploy hello_gcs_generic --runtime python37 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.archive

Go

gcloud functions deploy HelloGCSInfo --runtime go111 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.archive

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:

  1. Crea un archivo gcf-test.txt vacío en el directorio donde se encuentra el código de muestra.

  2. Asegúrate de que tu depósito tenga el control de versiones habilitado:

    gsutil versioning set on gs://YOUR_TRIGGER_BUCKET_NAME
    
  3. 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.

  4. Guarda el archivo para activar la función:

    gsutil rm gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt
    
  5. 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 8

gcloud functions deploy helloGCSGeneric --runtime nodejs8 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.metadataUpdate

Node.js 10 (Beta)

gcloud functions deploy helloGCSGeneric --runtime nodejs10 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.metadataUpdate

Node.js 6 (obsoleto)

gcloud functions deploy helloGCSGeneric --runtime nodejs6 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.metadataUpdate

Python

gcloud functions deploy hello_gcs_generic --runtime python37 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.metadataUpdate

Go

gcloud functions deploy HelloGCSInfo --runtime go111 --trigger-resource YOUR_TRIGGER_BUCKET_NAME --trigger-event google.storage.object.metadataUpdate

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:

  1. Crea un archivo gcf-test.txt vacío en el directorio donde se encuentra el código de muestra.

  2. Asegúrate de que tu depósito no tenga control de versiones:

    gsutil versioning set off gs://YOUR_TRIGGER_BUCKET_NAME
    
  3. 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.

  4. Actualiza los metadatos del archivo:

    gsutil -m setmeta -h "Content-Type:text/plain" gs://YOUR_TRIGGER_BUCKET_NAME/gcf-test.txt
    
  5. Revisa los registros para asegurarte de que las ejecuciones se completaron:

    gcloud functions logs read --limit 50
    

Limpieza

Sigue estos pasos para evitar que se apliquen cargos a tu cuenta de Google Cloud Platform por los recursos que usaste en este instructivo:

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:

  1. En la GCP Console, dirígete a la página Proyectos.

    Ir a la página Proyectos

  2. En la lista de proyectos, selecciona el proyecto que deseas borrar y haz clic en Borrar.
  3. En el cuadro de diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.

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 helloGCSGeneric 

Python

gcloud functions delete hello_gcs_generic 

Go

gcloud functions delete HelloGCSInfo 

También puedes borrar las funciones de Cloud Functions desde Google Cloud Platform Console.

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Documentación de Cloud Functions