Créer un sujet

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

Ce document explique comment créer un sujet Pub/Sub standard. Si vous souhaitez en savoir plus sur un sujet d'importation et sur la façon d'en créer un, consultez la section Créer un sujet d'importation.

Pour créer un sujet, vous pouvez utiliser la console Google Cloud, la 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 requis pour gérer les sujets

Pour obtenir les autorisations nécessaires pour créer et gérer des sujets, demandez à votre administrateur de vous attribuer le rôle IAM Éditeur Pub/Sub(roles/pubsub.editor) sur votre sujet ou votre projet. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Ce rôle prédéfini contient les autorisations requises pour créer et gérer des sujets. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour créer et gérer des sujets:

Créez un sujet : pubsub.topics.create
Supprimer un sujet : pubsub.topics.delete
Dissocier un abonnement d'un sujet : pubsub.topics.detachSubscription
Obtenir un thème : pubsub.topics.get
Listez un sujet : pubsub.topics.list
Publier dans un sujet : pubsub.topics.publish
Mettre à jour un sujet : pubsub.topics.update
Obtenez la stratégie IAM d'un sujet : pubsub.topics.getIamPolicy
Configurez la stratégie IAM d'un sujet : pubsub.topics.setIamPolicy

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 au niveau des ressources individuelles. 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 sujet, vous devez spécifier ses propriétés.

Ajoutez 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 la création du sujet. L'abonnement par défaut présente les propriétés suivantes:
- ID d'abonnement de -sub
- Type de distribution pull
- Conservation des messages pendant sept jours
- Expiration après 31 jours d'inactivité
- Délai d'accusé de réception de 10 secondes
- Stratégie de nouvelle tentative immédiate
Schéma. Un schéma est un format que le champ de données des messages doit respecter. Un schéma est un contrat entre l'éditeur et l'abonné, qui est appliqué par Pub/Sub. Les schémas de sujets permettent de standardiser les types de messages et les autorisations afin de permettre à différentes équipes de votre organisation de les utiliser. Pub/Sub crée une autorité centrale pour les types de messages et les autorisations. Pour créer un sujet avec schéma, consultez Présentation du schéma.
Activez l'ingestion. L'activation de cette propriété vous permet d'ingérer des flux de données provenant de sources externes dans un sujet afin de pouvoir exploiter les fonctionnalités de Google Cloud. Pour créer un sujet d'importation en vue de l'ingestion, consultez la section Créer un sujet d'importation.
Durée de conservation des messages : Spécifie la durée pendant laquelle le sujet Pub/Sub conserve les messages après leur publication. Une fois la durée de conservation des messages écoulée, Pub/Sub peut supprimer le message, quel que soit son état de confirmation. Des frais de stockage des messages sont facturés pour le stockage de tous les messages publiés dans le sujet.
- Par défaut = désactivé
- Valeur minimale = 10 minutes
- Valeur maximale = 31 jours
Utilisez une clé de chiffrement gérée par le client (CMEK). Indique si le sujet est chiffré avec une clé CMEK. Par défaut, Pub/Sub chiffre les messages à l'aide de clés gérées par Google. Si vous spécifiez cette option, Pub/Sub utilise le modèle de chiffrement encapsulé avec CMEK. Dans cette approche, Cloud KMS ne chiffre pas les messages. À la place, 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 DEK la plus récente générée pour le sujet. Pub/Sub déchiffre les messages peu de temps avant qu'ils ne soient distribués aux abonnés. Pour en savoir plus sur la création d'une clé, consultez Configurer le chiffrement des messages.

Créer un sujet

Créez un sujet avant de pouvoir le publier ou de vous y abonner.

Console

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

Dans la console Google Cloud, accédez à la page Sujets de Pub/Sub.

Accéder aux sujets
Cliquez sur Create topic (Créer un sujet).
Dans le champ ID du sujet, saisissez un ID pour votre sujet. Pour en savoir plus sur l'attribution de noms aux sujets, consultez les consignes relatives aux noms.
Conservez l'option Ajouter un abonnement par défaut.
Ne sélectionnez pas les autres options.
Cliquez sur Créer un sujet.

gcloud

Dans la console Google Cloud, activez Cloud Shell.

Activer Cloud Shell

En bas de la fenêtre 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 demande 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 actuels de l'application, exécutez la commande suivante : 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.

Solution :

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

C++

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

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.

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 de configuration de C# décrites dans le guide de démarrage rapide de Pub/Sub à l'aide 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

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

import (
	"context"
	"fmt"
	"io"

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

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()

	t, err := client.CreateTopic(ctx, topicID)
	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 de configuration de Java décrites dans le guide de démarrage rapide de Pub/Sub à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub 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

/**
 * 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.js

/**
 * 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 de configuration de PHP décrites dans le guide de démarrage rapide de Pub/Sub à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub 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 de configuration de Python décrites dans le guide de démarrage rapide de Pub/Sub à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub 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

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

# topic_id = "your-topic-id"

pubsub = Google::Cloud::Pubsub.new

topic = pubsub.create_topic topic_id

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

Contraintes liées aux règles d'administration

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

Si votre projet vient d'être créé, attendez quelques minutes que la règle d'administration s'initialise avant de créer un sujet.

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

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

Étapes suivantes

Choisissez le type d'abonnement à votre sujet.
Découvrez comment publier un message dans un sujet.
Créez ou modifiez un sujet à l'aide de la gcloud CLI, des API REST ou des bibliothèques clientes.