Eliminare una revisione dello schema per un argomento

Questo documento spiega come eliminare le revisioni dello schema per gli argomenti Pub/Sub. L'operazione di eliminazione di uno schema elimina anche tutte le revisioni associate allo schema.

Attenzione: l'eliminazione è definitiva. Non puoi ripristinare una revisione dello schema eliminata. I messaggi convalidati in base alla revisione dello schema eliminata al momento della pubblicazione non possono essere scritti in BigQuery utilizzando una sottoscrizione BigQuery con l'opzione Utilizza schema argomento attivata. Invece di eliminare una revisione, ti consigliamo di eseguire il rollback di uno schema.

Prima di iniziare

• Scopri come funzionano gli schemi Pub/Sub.
• Crea uno schema.

Ruoli e autorizzazioni richiesti

Per ottenere le autorizzazioni necessarie per eliminare e gestire le revisioni dello schema, chiedi all'amministratore di concederti il ruolo IAM Editor Pub/Sub (roles/pubsub.editor) nel progetto. Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

Questo ruolo predefinito contiene le autorizzazioni necessarie per eliminare e gestire le revisioni dello schema. Per visualizzare le autorizzazioni esatte richieste, espandi la sezione Autorizzazioni richieste:

Autorizzazioni obbligatorie

Per eliminare e gestire le revisioni dello schema sono necessarie le seguenti autorizzazioni:

• Crea schema: pubsub.schemas.create
• Allega lo schema all'argomento: pubsub.schemas.attach
• Esegui il commit di una revisione dello schema: pubsub.schemas.commit
• Elimina uno schema o una revisione dello schema: pubsub.schemas.delete
• Ottieni uno schema o le revisioni dello schema: pubsub.schemas.get
• Elenca schemi: pubsub.schemas.list
• Revisioni dello schema dell'elenco: pubsub.schemas.listRevisions
• Esegui il rollback di uno schema: pubsub.schemas.rollback
• Convalida un messaggio: pubsub.schemas.validate
• Recupera il criterio IAM per uno schema: pubsub.schemas.getIamPolicy
• Configura il criterio IAM per uno schema: pubsub.schemas.setIamPolicy

Potresti anche ottenere queste autorizzazioni con ruoli personalizzati o altri ruoli predefiniti.

Puoi concedere ruoli e autorizzazioni a entità come utenti, gruppi, domini o account di servizio. Puoi creare uno schema in un progetto e agganciarlo a un argomento in un altro progetto. Assicurati di disporre delle autorizzazioni necessarie per ogni progetto.

Eliminare una revisione dello schema

Importante: se tutte le revisioni nell'intervallo di revisione delle impostazioni dello schema per un argomento vengono eliminate, tutti i tentativi di pubblicare messaggi in quell'argomento non vanno a buon fine.

Di seguito sono riportate alcune importanti linee guida per l'eliminazione di una revisione dello schema:

• Puoi eliminare una o più revisioni dello schema da uno schema.

• Se lo schema ha una sola revisione, non puoi eliminarla. Elimina invece lo schema.

• L'operazione di eliminazione di uno schema elimina anche tutte le revisioni associate allo schema.

• Se elimini uno schema, la pubblicazione dei messaggi negli argomenti associati a quel determinato schema non va a buon fine.

• Se elimini una revisione dello schema e questa è specificata come prima revisione per un argomento, per la convalida viene utilizzata la revisione successiva.

  Se la revisione dello schema eliminata è specificata come ultima revisione per un argomento, per la convalida viene utilizzata la revisione dello schema precedente.

  Se la revisione dello schema eliminata rientra nell'intervallo di revisioni specificato per un argomento da convalidare, la revisione viene ignorata.

Puoi eliminare una revisione dello schema utilizzando la console Google Cloud, l'gcloud CLI, l'API Pub/Sub o le librerie client di Cloud.

Console

1. Nella console Google Cloud, vai alla pagina Schemi Pub/Sub.

   Vai a Schemi

2. Fai clic sul nome di uno schema esistente.

   Viene visualizzata la pagina Dettagli schema dello schema.

3. Seleziona la revisione da eliminare. Puoi anche selezionare più revisioni.

4. Fai clic su Elimina revisione.

5. Conferma l'operazione di eliminazione.

gcloud

gcloud pubsub schemas delete-revision SCHEMA_NAME@REVISION_ID

Dove:

• REVISION_ID è la revisione a cui vuoi eseguire il rollback.

REST

Per eliminare una revisione dello schema, invia una richiesta DELETE come la seguente:

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

Il corpo della risposta deve contenere una rappresentazione JSON della risorsa schema eliminata.

C++

Prima di provare questo esempio, segui le istruzioni di configurazione C++ riportate nella guida rapida all'utilizzo delle librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Pub/Sub C++.

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";
}

Vai

Prima di provare questo esempio, segui le istruzioni di configurazione di Go riportate nella guida rapida all'utilizzo delle librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Pub/Sub Go.

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Java riportate nella Guida rapida all'utilizzo delle librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java Pub/Sub.

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Python riportate nella guida rapida all'utilizzo delle librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Pub/Sub per Python.

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js riportate nella Guida rapida all'utilizzo delle librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Pub/Sub Node.js.

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js riportate nella Guida rapida all'utilizzo delle librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Pub/Sub Node.js.

/**
 * 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.`);
}

Passaggi successivi

• Eliminare uno schema
• Schemi di elenco
• Elenca le revisioni di uno schema
• Abbonarsi a un argomento con uno schema