トピックのスキーマリビジョンを削除する

このドキュメントでは、Pub/Sub トピックのスキーマリビジョンを削除する方法について説明します。スキーマの削除オペレーションでは、スキーマに関連付けられているすべてのリビジョンも削除されます。

準備

Pub/Sub スキーマの仕組みを理解する。
スキーマの作成

必要なロールと権限

スキーマリビジョンを削除および管理するために必要な権限を取得するには、管理者にプロジェクトに対する Pub/Sub 編集者（roles/pubsub.editor） IAM ロールを付与するよう依頼してください。ロールの付与の詳細については、アクセス権の管理をご覧ください。

この事前定義ロールには、スキーマリビジョンを削除して管理するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

スキーマリビジョンを削除して管理するには、次の権限が必要です。

スキーマを作成します: pubsub.schemas.create
スキーマをトピックに添付します: pubsub.schemas.attach
スキーマのリビジョンを commit します: pubsub.schemas.commit
スキーマまたはスキーマリビジョンを削除します: pubsub.schemas.delete
スキーマまたはスキーマのリビジョンを取得します: pubsub.schemas.get
スキーマを一覧表示します: pubsub.schemas.list
スキーマのリビジョンを一覧表示します: pubsub.schemas.listRevisions
スキーマをロールバックします: pubsub.schemas.rollback
メッセージを検証します: pubsub.schemas.validate
スキーマの IAM ポリシーを取得します: pubsub.schemas.getIamPolicy
スキーマの IAM ポリシーを構成します: pubsub.schemas.setIamPolicy

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

ユーザー、グループ、ドメイン、サービスアカウントなどのプリンシパルにロールと権限を付与できます。あるプロジェクトにスキーマを作成し、別のプロジェクトにあるトピックにアタッチできます。プロジェクトごとに必要な権限があることを確認します。

スキーマリビジョンを削除する

スキーマリビジョンを削除するための重要なガイドラインは次のとおりです。

スキーマから 1 つ以上のスキーマリビジョンを削除できます。
スキーマのリビジョンが 1 つしかない場合、そのリビジョンを削除することはできません。代わりに、スキーマを削除してください。
スキーマの削除オペレーションでは、スキーマに関連付けられているすべてのリビジョンも削除されます。
スキーマを削除すると、そのスキーマに関連付けられているトピックへのメッセージのパブリッシュ試行は失敗します。
スキーマリビジョンを削除し、それがトピックの最初のリビジョンとして指定されている場合、代わりに次のリビジョンが検証に使用されます。

削除されたスキーマリビジョンがトピックの最後のリビジョンとして指定されている場合、代わりに前のスキーマリビジョンが検証に使用されます。

削除されたスキーマリビジョンが、検証用に指定されたトピックのリビジョン範囲内にある場合、そのリビジョンはスキップされます。

スキーマのリビジョンを削除するには、Google Cloud コンソール、gcloud CLI、Pub/Sub API、Cloud クライアントライブラリを使用します。

Console

Google Cloud コンソールで、[Pub/Sub スキーマ] ページに移動します。

スキーマに移動
既存のスキーマの名前をクリックします。

スキーマの [スキーマの詳細] ページが開きます。
削除するリビジョンを選択します。複数のリビジョンを選択することもできます。
[リビジョンを削除] をクリックします。
削除の操作を確定します。

gcloud

gcloud pubsub schemas delete-revision SCHEMA_NAME@REVISION_ID

ここで

REVISION_ID は、ロールバックするリビジョンです。

REST

スキーマリビジョンを削除するには、次のように DELETE リクエストを送信します。

POST https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/SCHEMA_ID@REVISION_ID:deleteRevision
Authorization: Bearer $(gcloud auth application-default print-access-token)
Content-Type: application/json --data @response-body.json

レスポンスの本文には、削除されたスキーマリソースの JSON 表現を含める必要があります。

C++

このサンプルを試す前に、クイックスタート: クライアントライブラリの使用の C++ の設定手順を実施してください。詳細については、Pub/Sub C++ API のリファレンスドキュメントをご覧ください。

namespace pubsub = ::google::cloud::pubsub;
[](pubsub::SchemaServiceClient client, std::string const& project_id,
   std::string const& schema_id, std::string const& revision_id) {
  std::string const schema_id_with_revision = schema_id + "@" + revision_id;

  google::pubsub::v1::DeleteSchemaRevisionRequest request;
  request.set_name(
      pubsub::Schema(project_id, schema_id_with_revision).FullName());
  auto schema = client.DeleteSchemaRevision(request);
  if (!schema) throw std::move(schema).status();

  std::cout << "Deleted schema. Its metadata is:"
            << "\n"
            << schema->DebugString() << "\n";
}

Go

このサンプルを試す前に、クイックスタート: クライアントライブラリの使用の Go の設定手順を実施してください。詳細については、Pub/Sub Go API リファレンスドキュメントをご覧ください。

import (
	"context"
	"fmt"
	"io"

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

func deleteSchemaRevision(w io.Writer, projectID, schemaID, revisionID string) error {
	// projectID := "my-project-id"
	// schemaID := "my-schema-id"
	// revisionID := "my-revision-id"
	ctx := context.Background()
	client, err := pubsub.NewSchemaClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewSchemaClient: %w", err)
	}
	defer client.Close()

	if _, err := client.DeleteSchemaRevision(ctx, schemaID, revisionID); err != nil {
		return fmt.Errorf("client.DeleteSchema revision: %w", err)
	}
	fmt.Fprintf(w, "Deleted a schema revision: %s@%s", schemaID, revisionID)
	return nil
}

Java

このサンプルを試す前に、クイックスタート: クライアントライブラリの使用の Java の設定手順を実施してください。詳細については、Pub/Sub Java API のリファレンスドキュメントをご覧ください。


import com.google.api.gax.rpc.NotFoundException;
import com.google.cloud.pubsub.v1.SchemaServiceClient;
import com.google.pubsub.v1.DeleteSchemaRevisionRequest;
import com.google.pubsub.v1.SchemaName;
import java.io.IOException;

public class DeleteSchemaRevisionExample {

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

    deleteSchemaRevisionExample(projectId, schemaId);
  }

  public static void deleteSchemaRevisionExample(String projectId, String schemaId)
      throws IOException {
    SchemaName schemaName = SchemaName.of(projectId, schemaId);

    try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {

      DeleteSchemaRevisionRequest request =
          DeleteSchemaRevisionRequest.newBuilder().setName(schemaName.toString()).build();

      schemaServiceClient.deleteSchemaRevision(request);

      System.out.println("Deleted a schema revision:" + schemaName);

    } catch (NotFoundException e) {
      System.out.println(schemaName + "not found.");
    }
  }
}

Python

このサンプルを試す前に、クイックスタート: クライアントライブラリの使用の Python の設定手順を実施してください。詳細については、Pub/Sub Python API のリファレンスドキュメントをご覧ください。

from google.api_core.exceptions import NotFound
from google.cloud.pubsub import SchemaServiceClient

# TODO(developer): Replace these variables before running the sample.
# project_id = "your-project-id"
# schema_id = "your-schema-id"
# revision_id = "your-revision-id"

schema_client = SchemaServiceClient()
schema_path = schema_client.schema_path(project_id, schema_id + "@" + revision_id)

try:
    schema_client.delete_schema_revision(request={"name": schema_path})
    print(f"Deleted a schema revision:\n{schema_path}")
except NotFound:
    print(f"{schema_id} not found.")

Node.js

このサンプルを試す前に、クイックスタート: クライアントライブラリの使用の Node.js の設定手順を実施してください。詳細については、Pub/Sub Node.js API リファレンスドキュメントをご覧ください。

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const schemaNameOrId = 'YOUR_SCHEMA_NAME_OR_ID';
// const revisionId = 'YOUR_REVISION_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 deleteSchemaRevision(schemaNameOrId, revisionId) {
  // Get the fully qualified schema name.
  const schema = pubSubClient.schema(schemaNameOrId);
  const name = await schema.getName();

  // Use the gapic client to delete the schema revision.
  const schemaClient = await pubSubClient.getSchemaClient();
  await schemaClient.deleteSchemaRevision({
    name: `${name}@${revisionId}`,
  });

  console.log(`Schema ${name} revision ${revisionId} deleted.`);
}

Node.js

このサンプルを試す前に、クイックスタート: クライアントライブラリの使用の Node.js の設定手順を実施してください。詳細については、Pub/Sub Node.js API のリファレンスドキュメントをご覧ください。

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const schemaNameOrId = 'YOUR_SCHEMA_NAME_OR_ID';
// const revisionId = 'YOUR_REVISION_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 deleteSchemaRevision(
  schemaNameOrId: string,
  revisionId: string
) {
  // Get the fully qualified schema name.
  const schema = pubSubClient.schema(schemaNameOrId);
  const name = await schema.getName();

  // Use the gapic client to delete the schema revision.
  const schemaClient = await pubSubClient.getSchemaClient();
  await schemaClient.deleteSchemaRevision({
    name: `${name}@${revisionId}`,
  });

  console.log(`Schema ${name} revision ${revisionId} deleted.`);
}

トピックのスキーマ リビジョンを削除する

準備

必要なロールと権限

必要な権限

スキーマ リビジョンを削除する

Console

gcloud

REST

C++

Go

Java

Python

Node.js

Node.js

次のステップ

トピックのスキーマリビジョンを削除する

スキーマリビジョンを削除する