Creare una sottoscrizione con SMT

Console

1. Nellaconsole, vai alla pagina Pub/Sub Sottoscrizioni. Cloud de Confiance

   Vai ad Abbonamenti

2. Fai clic su Crea sottoscrizione.

3. Nel campo ID sottoscrizione, inserisci un ID per la sottoscrizione. Per saperne di più sulla denominazione delle sottoscrizioni, consulta le linee guida per la denominazione.

4. In Trasformazioni, fai clic su Aggiungi una trasformazione.

5. Seleziona il Tipo di trasformazione. Per saperne di più sui tipi di SMT supportati, consulta Tipi di SMT.

6. Imposta le proprietà di configurazione per la SMT. L'insieme di proprietà dipende dal tipo di SMT. Per saperne di più, consulta la documentazione relativa al tipo di SMT.

7. (Facoltativo) Per convalidare la SMT, fai clic su Convalida. Se la SMT è valida, viene visualizzato il messaggio "Validation passed". In caso contrario, viene visualizzato un messaggio di errore.

8. Per aggiungere un'altra trasformazione, fai clic su Aggiungi una trasformazione e ripeti i passaggi precedenti.

   Per disporre le SMT in un ordine specifico, fai clic su arrow_upwardSposta in alto o arrow_downwardSposta in basso. Per rimuovere una SMT, fai clic su delete Elimina.

9. (Facoltativo) Per testare una SMT su un messaggio di esempio:

   1. Fai clic su Testa trasformazioni.

   2. Nella finestra Testa trasformazione, seleziona la funzione che vuoi testare.

   3. Nella finestra Messaggio di input, inserisci un messaggio di esempio.

   4. Per aggiungere un attributo al messaggio, fai clic su Aggiungi un attributo e inserisci la chiave e il valore dell'attributo. Puoi aggiungere più attributi.

   5. Fai clic su Test. Il risultato dell'applicazione della SMT al messaggio viene visualizzato in Messaggio di output.

   6. Per chiudere la finestra Testa trasformazioni, fai clic su close Chiudi.

   Se crei più di una SMT, puoi testare l'intera sequenza di trasformazioni nel seguente modo:

   1. Testa la prima SMT nella sequenza, come descritto nei passaggi precedenti.
   2. Seleziona la SMT successiva. Il messaggio di input viene precompilato con il messaggio di output del test precedente.
   3. Continua a testare le SMT in ordine per assicurarti che l'intera sequenza funzioni come previsto.

10. Fai clic su Crea per creare la sottoscrizione.

gcloud

1. Nella Cloud de Confiance console, attiva Cloud Shell.

   Attiva Cloud Shell

   Nella parte inferiore della Cloud de Confiance console viene avviata una sessione di Cloud Shell e viene visualizzato un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già inclusa e installata e con valori già impostati per il progetto corrente. L'inizializzazione della sessione può richiedere alcuni secondi.

2. Crea un file YAML o JSON che definisca una o più SMT. La definizione YAML o JSON dipende dal tipo di SMT. Per saperne di più, consulta Tipi di SMT.

   Se il file include più di una SMT, Pub/Sub le esegue nell'ordine in cui sono elencate.

3. (Facoltativo) Per convalidare una SMT, esegui il gcloud pubsub message-transforms validate comando:

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

   Sostituisci quanto segue:

   • TRANSFORM_FILE: il percorso di un file YAML o JSON che definisce una singola SMT. Se stai creando più SMT, devi convalidarle singolarmente.

4. (Facoltativo) Per testare una o più SMT su un messaggio Pub/Sub di esempio, esegui il gcloud pubsub message-transforms test comando:

   gcloud pubsub message-transforms test \
     --message-transforms-file=TRANSFORMS_FILE \
     --message=MESSAGE \
     --attribute=ATTRIBUTES
   

   Sostituisci quanto segue:

   • TRANSFORMS_FILE: il percorso di un file YAML o JSON che definisce una o più SMT.
   • MESSAGE: il corpo del messaggio di esempio.
   • ATTRIBUTES: (facoltativo) Un elenco di attributi dei messaggi separato da virgole. Ogni attributo è una coppia chiave-valore formattata come KEY="VALUE".

   Il comando esegue le SMT in ordine, utilizzando l'output di ogni SMT come input per la successiva. Il comando restituisce i risultati di ogni passaggio.

5. Per creare la sottoscrizione, esegui il gcloud pubsub subscriptions create comando:

   gcloud pubsub subscriptions create SUBSCRIPTION_ID \
       --topic=projects/PROJECT_ID/topics/TOPIC_ID \
       --message-transforms-file=TRANSFORMS_FILE
   

   Sostituisci quanto segue:

   • SUBSCRIPTION_ID: l'ID o il nome della sottoscrizione che vuoi creare. Per le linee guida su come denominare una sottoscrizione, consulta Nomi delle risorse. Il nome di una sottoscrizione è immutabile.

   • PROJECT_ID: l'ID del progetto che contiene l'argomento.

   • TOPIC_ID: l'ID dell'argomento a cui sottoscrivere.

   • TRANSFORMS_FILE: il percorso del file YAML o JSON che definisce una o più SMT.

Java

Prima di provare questo esempio, segui le istruzioni di configurazione di Java in Guida rapida all'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Pub/Sub Java.

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Python in Guida rapida all'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Pub/Sub Python.

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

L'esempio seguente utilizza la versione principale della libreria client Go Pub/Sub (v2). Se utilizzi ancora la libreria v1, consulta la guida alla migrazione alla v2. Per visualizzare un elenco di esempi di codice della versione 1, consulta gli esempi di codice deprecati.

Prima di provare questo esempio, segui le istruzioni di configurazione di Go in Guida rapida all'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Pub/Sub Go.

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/pubsub/v2"
	"cloud.google.com/go/pubsub/v2/apiv1/pubsubpb"
)

// createSubscriptionWithSMT creates a subscription with a single message transform function applied.
func createSubscriptionWithSMT(w io.Writer, projectID, topicID, subID string) error {
	// projectID := "my-project-id"
	// topicID := "my-topic"
	// subID := "my-sub"
	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 := &pubsubpb.MessageTransform{
		Transform: &pubsubpb.MessageTransform_JavascriptUdf{
			JavascriptUdf: &pubsubpb.JavaScriptUDF{
				FunctionName: "redactSSN",
				Code:         code,
			},
		},
	}

	sub := &pubsubpb.Subscription{
		Name:              fmt.Sprintf("projects/%s/subscriptions/%s", projectID, subID),
		Topic:             fmt.Sprintf("projects/%s/topics/%s", projectID, topicID),
		MessageTransforms: []*pubsubpb.MessageTransform{transform},
	}
	sub, err = client.SubscriptionAdminClient.CreateSubscription(ctx, sub)
	if err != nil {
		return fmt.Errorf("CreateSubscription: %w", err)
	}
	fmt.Fprintf(w, "Created subscription with message transform: %v\n", sub)
	return nil
}