创建和使用主题

本文档介绍了如何创建、更新、查看和删除 Pub/Sub 主题。本文档还介绍了如何为主题和订阅命名。

要点：了解 Pub/Sub 主题的属性，例如主题架构、消息保留以及使用 CMEK 密钥。使用 Google Cloud 控制台、Google Cloud CLI 或 Pub/Sub API 创建和管理主题。

主题中的数据复制

Pub/Sub 主题使用三个可用区来存储数据。该服务保证至少两个可用区的同步复制，并尽最大努力复制到另一个第三方可用区。Pub/Sub 复制操作仅在一个区域内。

主题的属性

创建或更新主题时，必须指定其属性。

• 添加默认订阅。向 Pub/Sub 主题添加默认订阅。创建主题后，您可以为该主题再创建一个订阅。默认订阅具有以下属性：

  • -sub的订阅 ID
  • 拉取传送类型
  • 邮件保留期限为 7 天
  • 闲置 31 天后过期
  • 确认时限为 10 秒
  • 立即重试政策

• 架构。架构是消息数据字段必须遵循的格式。架构是 Pub/Sub 强制执行发布者与订阅者之间的合约。主题架构有助于实现消息类型和权限标准化，以允许组织中的不同团队使用它们。Pub/Sub 会为消息类型和权限创建集中管理中心。如需创建具有架构的主题，请参阅创建和管理架构。

• 消息保留时长：指定 Pub/Sub 主题在发布后保留多长时间。消息保留期结束后，无论其确认状态如何，Pub/Sub 都可能会舍弃消息。您需要为存储到该主题的所有消息支付消息存储费用。

  • 默认 = 未启用
  • 最小值 = 10 分钟
  • 最大值 = 31 天

• 使用客户管理的加密密钥 (CMEK)。指定主题是否使用 CMEK 加密。默认情况下，Pub/Sub 使用 Google 管理的密钥加密消息。如果您指定此选项，Pub/Sub 会将信封加密模式与 CMEK 结合使用。在此方法中，Cloud KMS 不会加密消息。相反，Cloud KMS 会对 Pub/Sub 为每个主题创建的数据加密密钥 (DEK) 进行加密。Pub/Sub 使用为主题生成的最新 DEK 来加密消息。Pub/Sub 会在消息传送给订阅者之前不久对其进行解密。如需详细了解如何创建密钥，请参阅配置消息加密。

主题、订阅或快照的命名准则

Pub/Sub 资源名称用于唯一标识 Pub/Sub 资源，例如主题、订阅或快照。资源名称必须符合以下格式：

projects/project-identifier/collection/ID

• project-identifier：必须是可在 Google Cloud 控制台中获取的项目 ID。例如 my-cool-project。

• collection：必须是 topics、subscriptions 或 snapshots 中的一个。

• ID：必须符合以下准则：

  • 不以字符串 goog 开头
  • 以字母开头
  • 包含 3 到 255 个字符
  • 只能包含以下字符：字母 [A-Za-z]、数字 [0-9]、短划线 -、下划线 _、英文句号 .、波浪线 ~、加号 + 和百分号 %

  您可以在不带网址编码的资源名称中使用上述列表中的特殊字符。不过，在网址中使用其他特殊字符时，请务必确保这些字符能够正确编码或解码。例如，mi-tópico 是无效的 ID。不过，mi-t%C3%B3pico 是有效的。此格式在您进行 REST 调用时至关重要。

注意：客户端库可以采用不同的方法来命名资源，例如在单独的字段中指定项目标识符和 ID。

创建主题

请先创建主题，然后才能发布或订阅。

控制台

如需创建主题，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 Pub/Sub 主题页面。

   转到“主题”

2. 点击创建主题。

3. 在主题 ID 字段中，输入主题 ID。

4. 保留添加默认订阅选项。

5. 请勿选择其他选项。

6. 点击创建主题。

gcloud CLI

如需创建主题，请运行 gcloud pubsub topics create 命令：

gcloud pubsub topics create TOPIC_ID

REST

如需创建主题，请使用 projects.topics.create 方法：

必须使用 Authorization 标头中的访问令牌对请求进行身份验证。如需获取当前应用默认凭据的访问令牌，请运行以下命令：gcloud auth application-default print-access-token。

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

其中：

PROJECT_ID 是项目 ID。

TOPIC_ID 是您的主题 ID。

响应：

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

C++

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 C++ 设置说明进行操作。如需了解详情，请参阅 Pub/Sub C++ API 参考文档。

在 GitHub 上查看 反馈

namespace pubsub = ::google::cloud::pubsub;
[](pubsub::TopicAdminClient client, std::string project_id,
   std::string topic_id) {
  auto topic = client.CreateTopic(pubsub::TopicBuilder(
      pubsub::Topic(std::move(project_id), std::move(topic_id))));
  // 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#

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 C# 设置说明进行操作。如需了解详情，请参阅 Pub/Sub C# API 参考文档。

在 GitHub 上查看 反馈

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

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Go 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Go API 参考文档。

在 GitHub 上查看 反馈

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: %v", err)
	}
	defer client.Close()

	t, err := client.CreateTopic(ctx, topicID)
	if err != nil {
		return fmt.Errorf("CreateTopic: %v", err)
	}
	fmt.Fprintf(w, "Topic created: %v\n", t)
	return nil
}

Java

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Java 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Java API 参考文档。

在 GitHub 上查看 反馈

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

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Node.js 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Node.js API 参考文档。

在 GitHub 上查看 反馈

/**
 * 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() {
  // Creates a new topic
  await pubSubClient.createTopic(topicNameOrId);
  console.log(`Topic ${topicNameOrId} created.`);
}

createTopic();

PHP

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 PHP 设置说明进行操作。如需了解详情，请参阅 Pub/Sub PHP API 参考文档。

在 GitHub 上查看 反馈

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

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Python 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Python API 参考文档。

在 GitHub 上查看 反馈

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

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Ruby 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Ruby API 参考文档。

在 GitHub 上查看 反馈

# topic_id = "your-topic-id"
require "google/cloud/pubsub"

pubsub = Google::Cloud::Pubsub.new

topic = pubsub.create_topic topic_id

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

组织政策限制条件

组织政策可以限制主题创建，例如，某项政策可以限制 Compute Engine 区域中的消息存储。为避免主题创建错误，请在创建主题之前根据需要检查和更新组织政策。

如果是新创建的项目，请等待几分钟，等待组织政策初始化，然后再创建主题。

转到组织政策

使用架构创建主题

创建主题时，可能需要为其分配架构。

以下是关于使用架构的一些准则：

• 您无法向现有主题添加架构。
• 您只能在创建主题时指定架构。
• 架构与主题关联后，您便无法更新架构或移除其与该主题的关联。
• 您可以将同一架构应用于其他新主题。
• 如果您删除架构，则无法发布到所有关联的主题。

如需详细了解架构，请参阅创建和管理架构。

控制台

要创建主题并为其分配架构，请按照下列步骤操作：

1. 在 Google Cloud 控制台中，转到 Pub/Sub 主题页面。

   打开“主题”。

2. 点击创建主题。

3. 在主题 ID 字段中，输入主题 ID。

4. 选中使用架构复选框。其他选项保留为默认设置。

5. 点击选择 Pub/Sub 架构，然后选择创建新架构。如果要使用现有架构，请跳到第 7 步。

6. 在架构 ID 字段中，输入架构的 ID。

7. 对于架构类型，请选择 Avro 或协议缓冲区。

8. 在架构定义字段中，为您的架构输入 Avro 或协议缓冲区定义。

9. 点击创建以保存架构。

10. 在创建主题对话窗口的选择 Pub/Sub 架构字段中，搜索您的架构。

11. 点击创建以保存主题，并向其分配选定的架构。

gcloud

如需创建使用先前创建的架构分配的主题，请运行 gcloud pubsub topics create 命令：

gcloud pubsub topics create TOPIC_ID \
        --message-encoding=ENCODING_TYPE \
        --schema=SCHEMA_ID

其中：

• TOPIC_ID 是您正在创建的主题的 ID。
• ENCODING_TYPE 是针对架构验证的消息的编码。该值必须设置为 JSON 或 BINARY。
• SCHEMA_ID 是现有架构的 ID。

您也可以从其他 Google Cloud 项目分配架构：

gcloud pubsub topics create TOPIC_ID \
        --message-encoding=ENCODING_TYPE \
        --schema=SCHEMA_ID \
        --schema-project=SCHEMA_PROJECT \
        --project=TOPIC_PROJECT

其中：

• SCHEMA_PROJECT 是架构的 Google Cloud 项目的项目 ID。
• TOPIC_PROJECT 是主题的 Google Cloud 项目的项目 ID。

REST

如需创建主题，请使用 projects.topics.create 方法：

请求：

必须使用 Authorization 标头中的访问令牌对请求进行身份验证。如需获取当前应用默认凭据的访问令牌，请运行以下命令：gcloud auth application-default print-access-token。

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

请求正文：

{
  "schemaSettings": {
    "schema": "SCHEMA_NAME",
    "encoding": "ENCODING_TYPE"
  }
}

其中：

• PROJECT_ID 是项目 ID。
• TOPIC_ID 是您的主题 ID。
• SCHEMA_NAME 是应该根据其验证发布消息的架构的名称。格式为 projects/PROJECT_ID/schemas/SCHEMA_ID。
• ENCODING_TYPE 是根据架构验证过的消息的编码。其必须设置为 JSON 或 BINARY。

响应：

{
  "name": "projects/PROJECT_ID/topics/TOPIC_ID",
  "schemaSettings": {
    "schema": "SCHEMA_NAME",
    "encoding": "ENCODING_TYPE"
  }
}

C++

在尝试此示例之前，请按照《快速入门：使用客户端库》中的 C++ 设置说明进行操作。如需了解详情，请参阅 Pub/Sub C++ API 参考文档。

在 GitHub 上查看 反馈

namespace pubsub = ::google::cloud::pubsub;
[](pubsub::TopicAdminClient client, std::string project_id,
   std::string topic_id, std::string schema_id, std::string const& encoding) {
  auto const& schema = pubsub::Schema(project_id, std::move(schema_id));
  auto topic = client.CreateTopic(
      pubsub::TopicBuilder(
          pubsub::Topic(std::move(project_id), std::move(topic_id)))
          .set_schema(schema)
          .set_encoding(encoding == "JSON" ? google::pubsub::v1::JSON
                                           : google::pubsub::v1::BINARY));
  // 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#

在尝试此示例之前，请按照《快速入门：使用客户端库》中的 C# 设置说明进行操作。 如需了解详情，请参阅 Pub/Sub C# API 参考文档。

在 GitHub 上查看 反馈

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

public class CreateTopicWithSchemaSample
{
    public Topic CreateTopicWithSchema(string projectId, string topicId, string schemaName, Encoding encoding)
    {
        PublisherServiceApiClient publisher = PublisherServiceApiClient.Create();
        var topicName = TopicName.FromProjectTopic(projectId, topicId);
        Topic topic = new Topic
        {
            Name = topicName.ToString(),
            SchemaSettings = new SchemaSettings
            {
                Schema = schemaName,
                Encoding = encoding
            }
        };

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

Go

在尝试此示例之前，请按照《快速入门：使用客户端库》中的 Go 设置说明进行操作。 如需了解详情，请参阅 Pub/Sub Go API 参考文档。

在 GitHub 上查看 反馈

import (
	"context"
	"fmt"
	"io"

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

func createTopicWithSchema(w io.Writer, projectID, topicID, schemaID string, encoding pubsub.SchemaEncoding) error {
	// projectID := "my-project-id"
	// topicID := "my-topic"
	// schemaID := "my-schema-id"
	// encoding := pubsub.EncodingJSON
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewClient: %v", err)
	}

	tc := &pubsub.TopicConfig{
		SchemaSettings: &pubsub.SchemaSettings{
			Schema:   fmt.Sprintf("projects/%s/schemas/%s", projectID, schemaID),
			Encoding: encoding,
		},
	}
	t, err := client.CreateTopicWithConfig(ctx, topicID, tc)
	if err != nil {
		return fmt.Errorf("CreateTopicWithConfig: %v", err)
	}
	fmt.Fprintf(w, "Topic with schema created: %#v\n", t)
	return nil
}

Java

在尝试此示例之前，请按照《快速入门：使用客户端库》中的 Java 设置说明进行操作。 如需了解详情，请参阅 Pub/Sub Java API 参考文档。

在 GitHub 上查看 反馈

import com.google.api.gax.rpc.AlreadyExistsException;
import com.google.cloud.pubsub.v1.TopicAdminClient;
import com.google.pubsub.v1.Encoding;
import com.google.pubsub.v1.SchemaName;
import com.google.pubsub.v1.SchemaSettings;
import com.google.pubsub.v1.Topic;
import com.google.pubsub.v1.TopicName;
import java.io.IOException;

public class CreateTopicWithSchemaExample {

  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";
    // Use an existing schema.
    String schemaId = "your-schema-id";
    // Choose either BINARY or JSON message serialization in this topic.
    Encoding encoding = Encoding.BINARY;

    createTopicWithSchemaExample(projectId, topicId, schemaId, encoding);
  }

  public static void createTopicWithSchemaExample(
      String projectId, String topicId, String schemaId, Encoding encoding) throws IOException {
    TopicName topicName = TopicName.of(projectId, topicId);
    SchemaName schemaName = SchemaName.of(projectId, schemaId);

    SchemaSettings schemaSettings =
        SchemaSettings.newBuilder().setSchema(schemaName.toString()).setEncoding(encoding).build();

    try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {

      Topic topic =
          topicAdminClient.createTopic(
              Topic.newBuilder()
                  .setName(topicName.toString())
                  .setSchemaSettings(schemaSettings)
                  .build());

      System.out.println("Created topic with schema: " + topic.getName());
    } catch (AlreadyExistsException e) {
      System.out.println(schemaName + "already exists.");
    }
  }
}

Node.js

在尝试此示例之前，请按照《快速入门：使用客户端库》中的 Node.js 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Node.js API 参考文档。

在 GitHub 上查看 反馈

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';
// const schemaName = 'YOUR_SCHEMA_NAME_OR_ID';
// const encodingType = 'BINARY';

// 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 createTopicWithSchema(
  topicNameOrId,
  schemaNameOrId,
  encodingType
) {
  // Get the fully qualified schema name.
  const schema = pubSubClient.schema(schemaNameOrId);
  const fullName = await schema.getName();

  // Creates a new topic with a schema. Note that you might also
  // pass Encodings.Json or Encodings.Binary here.
  await pubSubClient.createTopic({
    name: topicNameOrId,
    schemaSettings: {
      schema: fullName,
      encoding: encodingType,
    },
  });
  console.log(`Topic ${topicNameOrId} created with schema ${fullName}.`);
}

PHP

在尝试此示例之前，请按照《快速入门：使用客户端库》中的 PHP 设置说明进行操作。如需了解详情，请参阅 Pub/Sub PHP API 参考文档。

在 GitHub 上查看 反馈

use Google\Cloud\PubSub\PubSubClient;
use Google\Cloud\PubSub\Schema;

/**
 * Create a topic with a schema.
 *
 * @param string $projectId
 * @param string $topicId
 * @param string $schemaId
 * @param string $encoding
 */
function create_topic_with_schema($projectId, $topicId, $schemaId, $encoding)
{
    $pubsub = new PubSubClient([
        'projectId' => $projectId,
    ]);

    $schema = $pubsub->schema($schemaId);

    $topic = $pubsub->createTopic($topicId, [
        'schemaSettings' => [
            // The schema may be provided as an instance of the schema type,
            // or by using the schema ID directly.
            'schema' => $schema,
            // Encoding may be either `BINARY` or `JSON`.
            // Provide a string or a constant from Google\Cloud\PubSub\V1\Encoding.
            'encoding' => $encoding,
        ]
    ]);

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

Python

在尝试此示例之前，请按照《快速入门：使用客户端库》中的 Python 设置说明进行操作。 如需了解详情，请参阅 Pub/Sub Python API 参考文档。

在 GitHub 上查看 反馈

from google.api_core.exceptions import AlreadyExists, InvalidArgument
from google.cloud.pubsub import PublisherClient, SchemaServiceClient
from google.pubsub_v1.types import Encoding

# TODO(developer): Replace these variables before running the sample.
# project_id = "your-project-id"
# topic_id = "your-topic-id"
# schema_id = "your-schema-id"
# Choose either BINARY or JSON as valid message encoding in this topic.
# message_encoding = "BINARY"

publisher_client = PublisherClient()
topic_path = publisher_client.topic_path(project_id, topic_id)

schema_client = SchemaServiceClient()
schema_path = schema_client.schema_path(project_id, schema_id)

if message_encoding == "BINARY":
    encoding = Encoding.BINARY
elif message_encoding == "JSON":
    encoding = Encoding.JSON
else:
    encoding = Encoding.ENCODING_UNSPECIFIED

try:
    response = publisher_client.create_topic(
        request={
            "name": topic_path,
            "schema_settings": {"schema": schema_path, "encoding": encoding},
        }
    )
    print(f"Created a topic:\n{response}")

except AlreadyExists:
    print(f"{topic_id} already exists.")
except InvalidArgument:
    print("Please choose either BINARY or JSON as a valid message encoding type.")

Ruby

在尝试此示例之前，请按照《快速入门：使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情，请参阅 Pub/Sub Ruby API 参考文档。

在 GitHub 上查看 反馈

# topic_id = "your-topic-id"
# schema_id = "your-schema-id"
# Choose either BINARY or JSON as valid message encoding in this topic.
# message_encoding = :binary
require "google/cloud/pubsub"

pubsub = Google::Cloud::Pubsub.new

topic = pubsub.create_topic topic_id, schema_name: schema_id, message_encoding: message_encoding

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

删除主题

注意：删除是永久性操作。您无法恢复已删除的主题。

删除主题后，其订阅不会被删除。订阅者可以通过订阅积压消息积压消息。在主题被删除后，其订阅的主题名称为 _deleted-topic_。如果您尝试创建的主题与您刚刚删除的主题名称相同，可能在短期内会出现错误。

控制台

1. 在 Google Cloud 控制台中，转到 Pub/Sub 主题页面。

   转到“主题”

2. 选择一个主题，然后点击 更多操作。

3. 点击删除。

   系统会显示删除主题窗口。

4. 输入 delete，然后点击删除。

gcloud CLI

如需删除主题，请使用 gcloud pubsub topics delete 命令：

gcloud pubsub topics delete TOPIC_ID

REST

如需删除主题，请使用 projects.topics.delete 方法：

请求：

必须使用 Authorization 标头中的访问令牌对请求进行身份验证。如需获取当前应用默认凭据的访问令牌，请运行以下命令：gcloud auth application-default print-access-token。

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

其中：

PROJECT_ID 是项目 ID。

TOPIC_ID 是您的主题 ID。

响应：

如果请求成功，响应将为空的 JSON 对象。

C++

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 C++ 设置说明进行操作。如需了解详情，请参阅 Pub/Sub C++ API 参考文档。

在 GitHub 上查看 反馈

namespace pubsub = ::google::cloud::pubsub;
[](pubsub::TopicAdminClient client, std::string const& project_id,
   std::string const& topic_id) {
  auto status = client.DeleteTopic(
      pubsub::Topic(std::move(project_id), std::move(topic_id)));
  // Note that kNotFound is a possible result when the library retries.
  if (status.code() == google::cloud::StatusCode::kNotFound) {
    std::cout << "The topic was not found\n";
    return;
  }
  if (!status.ok()) throw std::runtime_error(status.message());

  std::cout << "The topic was successfully deleted\n";
}

C#

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 C# 设置说明进行操作。如需了解详情，请参阅 Pub/Sub C# API 参考文档。

在 GitHub 上查看 反馈

using Google.Cloud.PubSub.V1;

public class DeleteTopicSample
{
    public void DeleteTopic(string projectId, string topicId)
    {
        PublisherServiceApiClient publisher = PublisherServiceApiClient.Create();
        TopicName topicName = TopicName.FromProjectTopic(projectId, topicId);
        publisher.DeleteTopic(topicName);
    }
}

Go

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Go 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Go API 参考文档。

在 GitHub 上查看 反馈

import (
	"context"
	"fmt"
	"io"

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

func delete(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: %v", err)
	}
	defer client.Close()

	t := client.Topic(topicID)
	if err := t.Delete(ctx); err != nil {
		return fmt.Errorf("Delete: %v", err)
	}
	fmt.Fprintf(w, "Deleted topic: %v\n", t)
	return nil
}

Java

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Java 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Java API 参考文档。

在 GitHub 上查看 反馈

import com.google.api.gax.rpc.NotFoundException;
import com.google.cloud.pubsub.v1.TopicAdminClient;
import com.google.pubsub.v1.TopicName;
import java.io.IOException;

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

    deleteTopicExample(projectId, topicId);
  }

  public static void deleteTopicExample(String projectId, String topicId) throws IOException {
    try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
      TopicName topicName = TopicName.of(projectId, topicId);
      try {
        topicAdminClient.deleteTopic(topicName);
        System.out.println("Deleted topic.");
      } catch (NotFoundException e) {
        System.out.println(e.getMessage());
      }
    }
  }
}

Node.js

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Node.js 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Node.js API 参考文档。

在 GitHub 上查看 反馈

/**
 * 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 deleteTopic() {
  /**
   * TODO(developer): Uncomment the following line to run the sample.
   */
  // const topicName = 'my-topic';

  // Deletes the topic
  await pubSubClient.topic(topicNameOrId).delete();
  console.log(`Topic ${topicNameOrId} deleted.`);
}

deleteTopic().catch(console.error);

PHP

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 PHP 设置说明进行操作。如需了解详情，请参阅 Pub/Sub PHP API 参考文档。

在 GitHub 上查看 反馈

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 delete_topic($projectId, $topicName)
{
    $pubsub = new PubSubClient([
        'projectId' => $projectId,
    ]);
    $topic = $pubsub->topic($topicName);
    $topic->delete();

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

Python

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Python 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Python API 参考文档。

在 GitHub 上查看 反馈

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)

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

print(f"Topic deleted: {topic_path}")

Ruby

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Ruby 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Ruby API 参考文档。

在 GitHub 上查看 反馈

# topic_id = "your-topic-id"
require "google/cloud/pubsub"

pubsub = Google::Cloud::Pubsub.new

topic = pubsub.topic topic_id
topic.delete

puts "Topic #{topic_id} deleted."

列出主题

控制台

• 在 Google Cloud 控制台中，转到 Pub/Sub 主题页面。

  转到“主题”

  主题页面列出了所有可用的主题。

gcloud CLI

如需列出主题，请使用 gcloud pubsub topics list 命令：

gcloud pubsub topics list

REST

如需列出主题，请使用 projects.topics.list 方法：

请求：

必须使用 Authorization 标头中的访问令牌对请求进行身份验证。如需获取当前应用默认凭据的访问令牌，请运行以下命令：gcloud auth application-default print-access-token。

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

其中：

PROJECT_ID 是项目 ID。

响应：

{
  "topics": [
    {
      "name": "projects/PROJECT_ID/topics/mytopic1",
      ...
    },
    {
      "name": "projects/PROJECT_ID/topics/mytopic2",
      ...
    }
  ]
}

C++

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 C++ 设置说明进行操作。如需了解详情，请参阅 Pub/Sub C++ API 参考文档。

在 GitHub 上查看 反馈

namespace pubsub = ::google::cloud::pubsub;
[](pubsub::TopicAdminClient client, std::string const& project_id) {
  int count = 0;
  for (auto& topic : client.ListTopics(project_id)) {
    if (!topic) throw std::move(topic).status();
    std::cout << "Topic Name: " << topic->name() << "\n";
    ++count;
  }
  if (count == 0) {
    std::cout << "No topics found in project " << project_id << "\n";
  }
}

C#

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 C# 设置说明进行操作。如需了解详情，请参阅 Pub/Sub C# API 参考文档。

在 GitHub 上查看 反馈

using Google.Api.Gax.ResourceNames;
using Google.Cloud.PubSub.V1;
using System.Collections.Generic;

public class ListProjectTopicsSample
{
    public IEnumerable<Topic> ListProjectTopics(string projectId)
    {
        PublisherServiceApiClient publisher = PublisherServiceApiClient.Create();
        ProjectName projectName = ProjectName.FromProject(projectId);
        IEnumerable<Topic> topics = publisher.ListTopics(projectName);
        return topics;
    }
}

Go

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Go 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Go API 参考文档。

在 GitHub 上查看 反馈

import (
	"context"
	"fmt"

	"cloud.google.com/go/pubsub"
	"google.golang.org/api/iterator"
)

func list(projectID string) ([]*pubsub.Topic, error) {
	// projectID := "my-project-id"
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return nil, fmt.Errorf("pubsub.NewClient: %v", err)
	}
	defer client.Close()

	var topics []*pubsub.Topic

	it := client.Topics(ctx)
	for {
		topic, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return nil, fmt.Errorf("Next: %v", err)
		}
		topics = append(topics, topic)
	}

	return topics, nil
}

Java

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Java 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Java API 参考文档。

在 GitHub 上查看 反馈

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

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

    listTopicsExample(projectId);
  }

  public static void listTopicsExample(String projectId) throws IOException {
    try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
      ProjectName projectName = ProjectName.of(projectId);
      for (Topic topic : topicAdminClient.listTopics(projectName).iterateAll()) {
        System.out.println(topic.getName());
      }
      System.out.println("Listed all topics.");
    }
  }
}

Node.js

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Node.js 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Node.js API 参考文档。

在 GitHub 上查看 反馈

// 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 listAllTopics() {
  // Lists all topics in the current project
  const [topics] = await pubSubClient.getTopics();
  console.log('Topics:');
  topics.forEach(topic => console.log(topic.name));
}

listAllTopics().catch(console.error);

PHP

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 PHP 设置说明进行操作。如需了解详情，请参阅 Pub/Sub PHP API 参考文档。

在 GitHub 上查看 反馈

use Google\Cloud\PubSub\PubSubClient;

/**
 * Lists all Pub/Sub topics.
 *
 * @param string $projectId  The Google project ID.
 */
function list_topics($projectId)
{
    $pubsub = new PubSubClient([
        'projectId' => $projectId,
    ]);
    foreach ($pubsub->topics() as $topic) {
        printf('Topic: %s' . PHP_EOL, $topic->name());
    }
}

Python

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Python 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Python API 参考文档。

在 GitHub 上查看 反馈

from google.cloud import pubsub_v1

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

publisher = pubsub_v1.PublisherClient()
project_path = f"projects/{project_id}"

for topic in publisher.list_topics(request={"project": project_path}):
    print(topic)

Ruby

在尝试此示例之前，请按照使用客户端库的 Pub/Sub 快速入门中的 Ruby 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Ruby API 参考文档。

在 GitHub 上查看 反馈

require "google/cloud/pubsub"

pubsub = Google::Cloud::Pubsub.new

topics = pubsub.topics

puts "Topics in project:"
topics.each do |topic|
  puts topic.name
end

默认情况下，每个查询最多返回 100 个结果。 您可以使用页面大小参数指定一个其他值（最高 1000）。

监控主题

您可以在 Pub/Sub 中监控主题。

后续步骤

• 为您的主题选择订阅类型。

• 为您的主题创建订阅。

• 使用 gcloud CLI 创建或修改主题。

• 使用 REST API 创建或修改主题。