Créer un abonnement avec des SMT

Console

1. Dans la console Google Cloud , accédez à la page Abonnements Pub/Sub.

   Accéder aux abonnements

2. Cliquez sur Créer un abonnement.

   La page Créer un abonnement s'ouvre.

3. Dans le champ ID d'abonnement, saisissez un ID pour votre abonnement. Pour en savoir plus sur l'attribution de noms aux abonnements, consultez les consignes d'attribution de noms.

4. Sous Transformations, cliquez sur Ajouter une transformation.

5. Saisissez un nom de fonction. Exemple : redactSSN.

6. Si vous ne souhaitez pas utiliser immédiatement le SMT avec votre abonnement, cliquez sur l'option Désactiver la transformation. Le SMT sera toujours enregistré, mais il ne sera pas exécuté lorsque les messages transiteront par votre abonnement.

7. Saisissez une nouvelle transformation. Exemple :

   function redactSSN(message, metadata) {
     const data = JSON.parse(message.data);
     delete data['ssn'];
     message.data = JSON.stringify(data);
     return message;
   }

8. Pub/Sub fournit une fonction de validation qui vous permet de valider une transformation de message unique. Cliquez sur Valider pour valider la transformation.

9. Si vous souhaitez ajouter une autre transformation, cliquez sur Ajouter une transformation.

10. Pour organiser tous les SMT dans un ordre spécifique, vous pouvez utiliser les flèches vers le haut et vers le bas. Pour supprimer un SMT, cliquez sur le bouton Supprimer.

11. Pub/Sub fournit une fonction de test qui vous permet de vérifier le résultat de l'exécution du SMT sur un exemple de message. Pour tester les SMT, cliquez sur Tester la transformation.

12. Dans la fenêtre Tester la transformation, sélectionnez la fonction que vous souhaitez tester.

13. Dans la fenêtre Message d'entrée, saisissez un exemple de message.

14. Si vous souhaitez ajouter des attributs de message, cliquez sur Ajouter un attribut, puis saisissez une ou plusieurs paires clé/valeur.

15. Cliquez sur Test. Le résultat de l'application des SMT au message s'affiche.

16. Fermez la fenêtre pour arrêter de tester les SMT sur des exemples de messages.

17. Cliquez sur Créer pour créer l'abonnement.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. Pub/Sub fournit une fonction de validation qui vous permet de valider un SMT. Exécutez la commande gcloud pubsub message-transforms validate :

   gcloud pubsub message-transforms validate --message-transform-file=TRANSFORM_FILE

   Remplacez les éléments suivants :

   • TRANSFORM_FILE : chemin d'accès au fichier YAML ou JSON contenant un seul SMT.

     Voici un exemple de fichier de transformation YAML :

     - javascriptUdf:
         code: >
             function redactSSN(message, metadata) {
               const data = JSON.parse(message.data);
               delete data['ssn'];
               message.data = JSON.stringify(data);
               return message;
             }
         functionName: redactSSN

3. Pub/Sub fournit une fonction de test qui vous permet de vérifier le résultat de l'exécution d'un ou de plusieurs SMT sur un exemple de message. Exécutez la commande gcloud pubsub message-transforms test :

   gcloud pubsub message-transforms test --message-transforms-file=TRANSFORMS_FILE --message=MESSAGE --attributes=ATTRIBUTES

   Remplacez les éléments suivants :

   • TRANSFORMS_FILE : chemin d'accès au fichier YAML ou JSON contenant un ou plusieurs SMT.

     Voici un exemple de fichier de transformations YAML :

     - javascriptUdf:
         code: >
             function redactSSN(message, metadata) {
               const data = JSON.parse(message.data);
               delete data['ssn'];
               message.data = JSON.stringify(data);
               return message;
             }
         functionName: redactSSN

   • MESSAGE : corps du message avec lequel tester les SMT.

   • ATTRIBUTES : attributs de message avec lesquels tester le ou les SMT.

4. Pour créer l'abonnement, exécutez la commande gcloud pubsub subscriptions create :

   gcloud pubsub subscriptions create SUBSCRIPTION_ID \
       --topic=TOPIC_NAME \
       --message-transforms-file=TRANSFORMS_FILE

   Remplacez l'élément suivant :

   • SUBSCRIPTION_ID : ID ou nom de l'abonnement que vous souhaitez créer. Pour obtenir des consignes sur la façon de nommer un abonnement, consultez Noms de ressources. Le nom d'un abonnement est immuable.

   • TOPIC_NAME : nom du thème auquel s'abonner, au format projects/PROJECT_ID/topics/TOPIC_ID.

   • TRANSFORMS_FILE : chemin d'accès au fichier YAML ou JSON contenant un ou plusieurs SMT.

     Voici un exemple de fichier de transformations YAML :

     - javascriptUdf:
         code: >
             function redactSSN(message, metadata) {
               const data = JSON.parse(message.data);
               delete data['ssn'];
               message.data = JSON.stringify(data);
               return message;
             }
         functionName: redactSSN

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java du guide de démarrage rapide de Pub/Sub : Utiliser les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence sur l'API Pub/Sub pour Java.

Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

import com.google.cloud.pubsub.v1.SubscriptionAdminClient;
import com.google.pubsub.v1.JavaScriptUDF;
import com.google.pubsub.v1.MessageTransform;
import com.google.pubsub.v1.ProjectSubscriptionName;
import com.google.pubsub.v1.ProjectTopicName;
import com.google.pubsub.v1.Subscription;
import java.io.IOException;

public class CreateSubscriptionWithSmtExample {
  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "your-project-id";
    String topicId = "your-topic-id";
    String subscriptionId = "your-subscription-id";

    createSubscriptionWithSmtExample(projectId, topicId, subscriptionId);
  }

  public static void createSubscriptionWithSmtExample(
      String projectId, String topicId, String subscriptionId) throws IOException {

    // UDF that removes the 'ssn' field, if present
    String code =
        "function redactSSN(message, metadata) {"
            + "  const data = JSON.parse(message.data);"
            + "  delete data['ssn'];"
            + "  message.data = JSON.stringify(data);"
            + "  return message;"
            + "}";
    String functionName = "redactSSN";

    JavaScriptUDF udf =
        JavaScriptUDF.newBuilder().setCode(code).setFunctionName(functionName).build();
    MessageTransform transform = MessageTransform.newBuilder().setJavascriptUdf(udf).build();

    try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

      ProjectTopicName topicName = ProjectTopicName.of(projectId, topicId);
      ProjectSubscriptionName subscriptionName =
          ProjectSubscriptionName.of(projectId, subscriptionId);

      Subscription subscription =
          subscriptionAdminClient.createSubscription(
              Subscription.newBuilder()
                  .setName(subscriptionName.toString())
                  .setTopic(topicName.toString())
                  // Add the UDF message transform
                  .addMessageTransforms(transform)
                  .build());

      System.out.println("Created subscription with SMT: " + subscription.getAllFields());
    }
  }
}

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python du guide de démarrage rapide de Pub/Sub : Utiliser les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence sur l'API Pub/Sub pour Python.

Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

from google.cloud import pubsub_v1
from google.pubsub_v1.types import JavaScriptUDF, MessageTransform

# TODO(developer): Choose an existing topic.
# project_id = "your-project-id"
# topic_id = "your-topic-id"
# subscription_id = "your-subscription-id"

publisher = pubsub_v1.PublisherClient()
subscriber = pubsub_v1.SubscriberClient()
topic_path = publisher.topic_path(project_id, topic_id)
subscription_path = subscriber.subscription_path(project_id, subscription_id)

code = """function redactSSN(message, metadata) {
            const data = JSON.parse(message.data);
            delete data['ssn'];
            message.data = JSON.stringify(data);
            return message;
            }"""
udf = JavaScriptUDF(code=code, function_name="redactSSN")
transforms = [MessageTransform(javascript_udf=udf)]

with subscriber:
    subscription = subscriber.create_subscription(
        request={
            "name": subscription_path,
            "topic": topic_path,
            "message_transforms": transforms,
        }
    )
    print(f"Created subscription with SMT: {subscription}")

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go du guide de démarrage rapide de Pub/Sub : Utiliser les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence sur l'API Pub/Sub pour Go.

Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package subscriptions

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/pubsub"
)

// createSubscriptionWithSMT creates a subscription with a single message transform function applied.
func createSubscriptionWithSMT(w io.Writer, projectID, subID string, topic *pubsub.Topic) error {
	// projectID := "my-project-id"
	// subID := "my-sub"
	// topic of type https://godoc.org/cloud.google.com/go/pubsub#Topic
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewClient: %w", err)
	}
	defer client.Close()

	code := `function redactSSN(message, metadata) {
			const data = JSON.parse(message.data);
			delete data['ssn'];
			message.data = JSON.stringify(data);
			return message;
		}`
	transform := pubsub.MessageTransform{
		Transform: pubsub.JavaScriptUDF{
			FunctionName: "redactSSN",
			Code:         code,
		},
	}
	cfg := pubsub.SubscriptionConfig{
		Topic:             topic,
		MessageTransforms: []pubsub.MessageTransform{transform},
	}
	sub, err := client.CreateSubscription(ctx, subID, cfg)
	if err != nil {
		return fmt.Errorf("CreateSubscription: %w", err)
	}
	fmt.Fprintf(w, "Created subscription with message transform: %v\n", sub)
	return nil
}