Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

Créer un sujet

Dans Pub/Sub, un sujet est une ressource nommée qui représente un flux de messages. Avant de pouvoir publier un sujet ou de vous y abonner, vous devez le créer. Pub/Sub est compatible avec deux types de sujets : un sujet standard et un sujet d'importation.

Ce document explique comment créer un sujet Pub/Sub standard. Pour en savoir plus sur les sujets d'importation et sur la façon d'en créer un, consultez À propos des sujets d'importation.

Pour créer un sujet, vous pouvez utiliser la Google Cloud console, Google Cloud CLI, la bibliothèque cliente ou l'API Pub/Sub.

Avant de commencer

Découvrez le service Pub/Sub et sa terminologie.
En savoir plus sur le processus de publication

Rôles et autorisations nécessaires

Pour obtenir les autorisations nécessaires pour créer un sujet, demandez à votre administrateur de vous accorder le rôle IAM Éditeur Pub/Sub(roles/pubsub.editor) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ce rôle prédéfini contient les autorisations requises pour créer un sujet. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour créer un thème :

Accordez cette autorisation pour créer un sujet dans le projet : pubsub.topics.create

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Vous pouvez configurer le contrôle des accès au niveau du projet et de chaque ressource. Vous pouvez créer un abonnement dans un projet et l'associer à un sujet situé dans un autre projet. Assurez-vous de disposer des autorisations requises pour chaque projet.

Propriétés d'un thème

Lorsque vous créez ou mettez à jour un thème, vous devez spécifier ses propriétés.

Ajouter un abonnement par défaut

Ajoute un abonnement par défaut au sujet Pub/Sub. Vous pouvez créer un autre abonnement pour le sujet après sa création. L'abonnement par défaut présente les propriétés suivantes :

ID d'abonnement de -sub
Type de distribution : pull
Durée de conservation des messages de sept jours
Expiration après 31 jours d'inactivité
Délai de confirmation de 10 secondes
Stratégie de nouvelle tentative : immédiate

Utiliser un schéma

Un schéma est un format que le champ de données du message doit respecter. Un schéma est un contrat entre l'éditeur et l'abonné que Pub/Sub applique. Les schémas de sujets permettent de standardiser les types de messages et les autorisations pour qu'ils puissent être utilisés par différentes équipes de votre organisation. Pub/Sub crée une autorité centrale pour les types de messages et les autorisations. Pour créer un sujet avec un schéma, consultez Présentation des schémas.

Activer l'ingestion

L'activation de cette propriété vous permet d'ingérer des données de flux provenant de sources externes dans un sujet afin de pouvoir utiliser les fonctionnalités de Google Cloud. Pour créer un sujet d'importation pour l'ingestion, consultez les ressources suivantes :

Activer la conservation des messages par sujet

Par défaut, un sujet Pub/Sub ignore les messages dès qu'ils sont confirmés par tous les abonnements associés au sujet. Si vous le souhaitez, vous pouvez configurer un sujet pour qu'il conserve les messages pendant une période maximale de 31 jours, avec une période de conservation minimale de 10 minutes.

La conservation des messages permet aux abonnements de relire les messages précédemment confirmés ou les messages publiés avant la création de l'abonnement. Pour en savoir plus, consultez Relancer et supprimer des messages avec la fonctionnalité de recherche.

Les coûts de stockage des messages conservés par le sujet sont facturés au projet du sujet. Une fois la période de conservation des messages écoulée, Pub/Sub peut supprimer le message, quel que soit son état de confirmation.

Pour afficher les métriques sur les messages conservés, utilisez les métriques Cloud Monitoring suivantes :

topic/num_retained_messages : nombre de messages conservés
topic/oldest_retained_message_age : âge du message le plus ancien conservé.
topic/retained_bytes : taille totale des messages conservés, en octets

Exporter les données des messages vers BigQuery

L'activation de cette propriété vous permet de créer un abonnement BigQuery qui écrit les messages dans une table BigQuery existante à mesure qu'ils sont reçus. Vous n'avez pas besoin de configurer un client abonné distinct. Pour en savoir plus sur les abonnements BigQuery, consultez Abonnements BigQuery.

Sauvegarder les données de message dans Cloud Storage

L'activation de cette propriété vous permet de créer un abonnement Cloud Storage qui écrit les messages dans une table Cloud Storage existante à mesure qu'ils sont reçus. Vous n'avez pas besoin de configurer un client abonné distinct. Pour en savoir plus sur les abonnements Cloud Storage, consultez Abonnements Cloud Storage.

Transformations

Les transformations de message unique de sujet permettent de modifier légèrement les données et les attributs des messages directement dans Pub/Sub. Cette fonctionnalité permet de nettoyer, de filtrer ou de convertir le format des données avant la publication des messages dans le sujet.

Pour en savoir plus sur les SMT, consultez la présentation des SMT.

Google-owned and Google-managed encryption key

Indique que le sujet est chiffré à l'aide deGoogle-owned and Google-managed encryption keys. Pub/Sub chiffre les messages avec Google-owned and Google-managed encryption keys par défaut. Le choix de cette option permet donc de conserver le comportement par défaut. Google gère et fait pivoter automatiquement les clés, ce qui garantit que vos messages sont toujours protégés par le chiffrement le plus efficace disponible. Cette option ne nécessite aucune configuration supplémentaire. Pour en savoir plus sur Google-owned and Google-managed encryption keys, consultez Chiffrement par défaut avec Google-owned and Google-managed encryption keys.

Clé Cloud KMS

Indique si le sujet est chiffré avec une clé de chiffrement gérée par le client (CMEK). Par défaut, Pub/Sub chiffre les messages avec Google-owned and Google-managed encryption keys . Si vous spécifiez cette option, Pub/Sub utilise le modèle de chiffrement d'enveloppe avec CMEK. Dans cette approche, Cloud KMS ne chiffre pas les messages. En revanche, Cloud KMS chiffre les clés de chiffrement de données (DEK) que Pub/Sub crée pour chaque sujet. Pub/Sub chiffre les messages à l'aide de la clé de chiffrement des données (DEK) la plus récente générée pour le sujet. Pub/Sub déchiffre les messages peu de temps avant de les distribuer aux abonnés. Pour savoir comment créer une clé, consultez Configurer le chiffrement des messages.

Créer un sujet

Avant de pouvoir publier un sujet ou de vous y abonner, vous devez le créer.

Console

Pour créer un sujet, procédez comme suit :

Dans la console Google Cloud , accédez à la page Créer un sujet de Pub/Sub.

Accéder à la page "Créer un thème"
Dans le champ ID du sujet, saisissez un ID pour votre sujet. Pour en savoir plus sur la dénomination des thèmes, consultez les consignes de dénomination.
Pour créer un abonnement par défaut pour le sujet, sélectionnez Ajouter un abonnement par défaut. Cette option est activée par défaut.
Facultatif. Pour utiliser un schéma avec le sujet, cliquez sur Utiliser un schéma et fournissez le schéma. Pour en savoir plus, consultez Créer et associer un schéma lorsque vous créez un sujet.
Pour un thème standard, ne cochez pas Activer l'ingestion.
Facultatif. Pour conserver les messages après leur publication, sélectionnez Activer la conservation des messages. Sélectionnez la période de conservation en jours, heures et minutes. Pour en savoir plus, consultez Activer la conservation des messages.
Facultatif. Pour exporter les messages publiés vers une table BigQuery, sélectionnez Exporter les données vers BigQuery, puis saisissez les informations concernant la table. Pour en savoir plus, consultez Créer des abonnements BigQuery.
Facultatif. Pour sauvegarder les messages publiés dans un bucket Cloud Storage, sélectionnez Sauvegarder les données de message dans Cloud Storage, puis saisissez les informations concernant le bucket Cloud Storage. Pour en savoir plus, consultez Créer des abonnements Cloud Storage.
Facultatif. Sous Transformations, ajoutez une ou plusieurs transformations de message unique (SMT) pour manipuler et filtrer les données des messages. Pour en savoir plus, consultez Créer un sujet avec des SMT.
Facultatif. Pour utiliser une clé de chiffrement gérée par le client (CMEK) pour chiffrer les messages, sélectionnez Clé Cloud KMS. Par défaut, Pub/Sub utilise le chiffrement par défaut de Google, qui ne nécessite pas de clé CMEK. Pour en savoir plus, consultez Configurer le chiffrement des messages.
Facultatif. Pour gérer les clés associées à la rubrique, cliquez sur Gérer les clés. Pour en savoir plus, consultez la présentation des tags.
Cliquez sur Créer un sujet.

gcloud

Dans la console Google Cloud , activez Cloud Shell.

Activer Cloud Shell

En bas de la console Google Cloud , une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.
Pour créer un sujet, exécutez la commande gcloud pubsub topics create :
```
gcloud pubsub topics create TOPIC_ID
```

REST

Pour créer un sujet, utilisez la méthode projects.topics.create :

La requête doit être authentifiée à l'aide d'un jeton d'accès dans l'en-tête Authorization. Pour obtenir un jeton d'accès pour les identifiants par défaut de l'application actuelle : gcloud auth application-default print-access-token.

PUT https://pubsub.googleapis.com/v1/projects/PROJECT_ID/topics/TOPIC_ID
Authorization: Bearer ACCESS_TOKEN

Où :

PROJECT_ID est l'ID de votre projet.
TOPIC_ID est l'ID de votre sujet.

Réponse :

{
"name": "projects/PROJECT_ID/topics/TOPIC_ID"
}

C++

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

namespace pubsub = ::google::cloud::pubsub;
namespace pubsub_admin = ::google::cloud::pubsub_admin;
[](pubsub_admin::TopicAdminClient client, std::string project_id,
   std::string topic_id) {
  auto topic = client.CreateTopic(
      pubsub::Topic(std::move(project_id), std::move(topic_id)).FullName());
  // Note that kAlreadyExists is a possible error when the library retries.
  if (topic.status().code() == google::cloud::StatusCode::kAlreadyExists) {
    std::cout << "The topic already exists\n";
    return;
  }
  if (!topic) throw std::move(topic).status();

  std::cout << "The topic was successfully created: " << topic->DebugString()
            << "\n";
}

C#

Avant d'essayer cet exemple, suivez les instructions d'installation dans le langage C# qui se trouvent sur la page Démarrage rapide : utiliser des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub C#.


using Google.Cloud.PubSub.V1;
using Grpc.Core;
using System;

public class CreateTopicSample
{
    public Topic CreateTopic(string projectId, string topicId)
    {
        PublisherServiceApiClient publisher = PublisherServiceApiClient.Create();
        var topicName = TopicName.FromProjectTopic(projectId, topicId);
        Topic topic = null;

        try
        {
            topic = publisher.CreateTopic(topicName);
            Console.WriteLine($"Topic {topic.Name} created.");
        }
        catch (RpcException e) when (e.Status.StatusCode == StatusCode.AlreadyExists)
        {
            Console.WriteLine($"Topic {topicName} already exists.");
        }
        return topic;
    }
}

Go

L'exemple suivant utilise la version majeure de la bibliothèque cliente Go Pub/Sub (v2). Si vous utilisez toujours la bibliothèque v1, consultez le guide de migration vers la v2. Pour obtenir la liste des exemples de code v1, consultez les exemples de code obsolètes.

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

import (
	"context"
	"fmt"
	"io"

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

func create(w io.Writer, projectID, topicID string) error {
	// projectID := "my-project-id"
	// topicID := "my-topic"
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewClient: %w", err)
	}
	defer client.Close()

	topic := &pubsubpb.Topic{
		Name: fmt.Sprintf("projects/%s/topics/%s", projectID, topicID),
	}
	t, err := client.TopicAdminClient.CreateTopic(ctx, topic)
	if err != nil {
		return fmt.Errorf("CreateTopic: %w", err)
	}
	fmt.Fprintf(w, "Topic created: %v\n", t)
	return nil
}

Java

Avant d'essayer cet exemple, suivez les instructions d'installation dans le langage Java se trouvant sur la page Démarrage rapide : utiliser des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub en langage Java.


import com.google.cloud.pubsub.v1.TopicAdminClient;
import com.google.pubsub.v1.Topic;
import com.google.pubsub.v1.TopicName;
import java.io.IOException;

public class CreateTopicExample {
  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";

    createTopicExample(projectId, topicId);
  }

  public static void createTopicExample(String projectId, String topicId) throws IOException {
    try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
      TopicName topicName = TopicName.of(projectId, topicId);
      Topic topic = topicAdminClient.createTopic(topicName);
      System.out.println("Created topic: " + topic.getName());
    }
  }
}

Node.js

Avant d'essayer cet exemple, suivez les instructions d'installation dans le langage Node.js qui se trouvent sur la page Démarrage rapide : utiliser des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub en langage Node.js.

/**
 * TODO(developer): Uncomment this variable before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';

// Imports the Google Cloud client library
const {PubSub} = require('@google-cloud/pubsub');

// Creates a client; cache this for further use
const pubSubClient = new PubSub();

async function createTopic(topicNameOrId) {
  // Creates a new topic
  await pubSubClient.createTopic(topicNameOrId);
  console.log(`Topic ${topicNameOrId} created.`);
}

Node.ts

/**
 * TODO(developer): Uncomment this variable before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';

// Imports the Google Cloud client library
import {PubSub} from '@google-cloud/pubsub';

// Creates a client; cache this for further use
const pubSubClient = new PubSub();

async function createTopic(topicNameOrId: string) {
  // Creates a new topic
  await pubSubClient.createTopic(topicNameOrId);
  console.log(`Topic ${topicNameOrId} created.`);
}

PHP

Avant d'essayer cet exemple, suivez les instructions d'installation dans le langage PHP qui se trouvent sur la page Démarrage rapide : utiliser des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub en langage PHP.

use Google\Cloud\PubSub\PubSubClient;

/**
 * Creates a Pub/Sub topic.
 *
 * @param string $projectId  The Google project ID.
 * @param string $topicName  The Pub/Sub topic name.
 */
function create_topic($projectId, $topicName)
{
    $pubsub = new PubSubClient([
        'projectId' => $projectId,
    ]);
    $topic = $pubsub->createTopic($topicName);

    printf('Topic created: %s' . PHP_EOL, $topic->name());
}

Python

Avant d'essayer cet exemple, suivez les instructions d'installation dans le langage Python qui se trouvent sur la page Démarrage rapide : utiliser des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub en langage Python.

from google.cloud import pubsub_v1

# TODO(developer)
# project_id = "your-project-id"
# topic_id = "your-topic-id"

publisher = pubsub_v1.PublisherClient()
topic_path = publisher.topic_path(project_id, topic_id)

topic = publisher.create_topic(request={"name": topic_path})

print(f"Created topic: {topic.name}")

Ruby

L'exemple suivant utilise la bibliothèque cliente Ruby Pub/Sub v3. Si vous utilisez toujours la bibliothèque v2, consultez le guide de migration vers la v3. Pour obtenir la liste des exemples de code Ruby v2, consultez les exemples de code obsolètes.

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

# topic_id = "your-topic-id"

pubsub = Google::Cloud::PubSub.new
topic_admin = pubsub.topic_admin

topic = topic_admin.create_topic name: pubsub.topic_path(topic_id)

puts "Topic #{topic.name} created."

Rust

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

use google_cloud_pubsub::client::TopicAdmin;

pub async fn sample(client: &TopicAdmin, project_id: &str, topic_id: &str) -> anyhow::Result<()> {
    let topic = client
        .create_topic()
        .set_name(format!("projects/{project_id}/topics/{topic_id}"))
        .send()
        .await?;

    println!("successfully created topic {topic:?}");
    Ok(())
}

Contraintes liées aux règles d'administration

Les règles d'administration peuvent limiter la création de sujets. Par exemple, une règle peut limiter le stockage des messages dans une région Compute Engine. Pour éviter les erreurs de création de sujets, examinez et mettez à jour les règles de l'organisation, si nécessaire, avant de créer un sujet.

Si votre projet est récent, attendez quelques minutes que la règle d'administration de l'organisation s'initialise avant de créer un sujet.

Accéder à la page Règles d'administration

Pour en savoir plus, consultez Configurer des règles de stockage des messages.

Étapes suivantes

Choisissez le type d'abonnement pour votre sujet.
Découvrez comment publier un message dans un sujet.
Résolvez un problème lié à un thème.
Créez ou modifiez un sujet avec gcloud CLI, les API REST ou les bibliothèques clientes.

Apache Kafka® est une marque déposée d'Apache Software Foundation ou de ses filiales aux États-Unis et/ou dans d'autres pays.

Créer un sujet Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Avant de commencer

Rôles et autorisations nécessaires

Autorisations requises

Propriétés d'un thème

Ajouter un abonnement par défaut

Utiliser un schéma

Activer l'ingestion

Activer la conservation des messages par sujet

Exporter les données des messages vers BigQuery

Sauvegarder les données de message dans Cloud Storage

Transformations

Google-owned and Google-managed encryption key

Clé Cloud KMS

Créer un sujet

Console

gcloud

REST

C++

C#

Go

Java

Node.js

Node.ts

PHP

Python

Ruby

Rust

Contraintes liées aux règles d'administration

Étapes suivantes

Créer un sujet