Modificare i tipi di abbonamento

Dopo aver creato un abbonamento, puoi modificare il metodo di pubblicazione in push, pull o esportazione.

Prima di iniziare

• Crea uno degli abbonamenti supportati.

Ruoli e autorizzazioni richiesti

Per ottenere l'autorizzazione necessaria per modificare un tipo di abbonamento, chiedi all'amministratore di concederti il ruolo IAM Pub/Sub Editor (roles/pubsub.editor) per l'abbonamento. Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Questo ruolo predefinito contiene l'autorizzazione pubsub.subscriptions.update necessaria per modificare un tipo di abbonamento.

Potresti anche ottenere questa autorizzazione con ruoli personalizzati o altri ruoli predefiniti.

Puoi configurare il controllo dell'accesso a livello di progetto e a livello di singola risorsa. Puoi creare una sottoscrizione in un progetto e collegarla a un argomento che si trova in un altro progetto. Assicurati di disporre delle autorizzazioni necessarie per ogni progetto.

Modificare il tipo di consegna di un abbonamento

Per modificare il tipo di consegna di un abbonamento, segui questi passaggi.

Console

1. Nella console Google Cloud , vai alla pagina Sottoscrizioni.

   Vai ad Abbonamenti

2. Fai clic sul nome dell'abbonamento da aggiornare.

3. Nella pagina dei dettagli dell'abbonamento, fai clic su Modifica.

4. In Tipo di pubblicazione, seleziona il nuovo tipo di pubblicazione.

5. Compila le proprietà per il nuovo tipo di abbonamento. Per maggiori informazioni, consulta i seguenti argomenti:

   • Creare una sottoscrizione pull
   • Creare una sottoscrizione push
   • Crea un abbonamento Bigtable
   • Crea una sottoscrizione BigQuery
   • Crea un abbonamento per Cloud Storage cloud

6. Facoltativo. Aggiorna le altre proprietà dell'abbonamento in base alle esigenze.

7. Fai clic su Aggiorna.

gcloud

Per modificare il tipo di consegna, utilizza il comando gcloud pubsub subscriptions update. Cancella la configurazione per il tipo di pubblicazione corrente e imposta la configurazione per il nuovo tipo nel seguente modo:

gcloud pubsub subscriptions update SUBSCRIPTION_ID \
  CLEAR_CONFIG_FLAG \
  NEW_CONFIG_FLAGS

Sostituisci quanto segue:

• SUBSCRIPTION_ID: il nome dell'abbonamento da aggiornare.

• CLEAR_CONFIG_FLAG: un flag per cancellare la configurazione esistente per il tipo di pubblicazione. Utilizza uno dei seguenti flag, a seconda del tipo di pubblicazione corrente:

  • Sottoscrizione pull: --no-enable-exactly-once-delivery

  • Sottoscrizione push: --push-endpoint=""

  • Abbonamento BigQuery: --clear-bigquery-config

  • Abbonamento Bigtable: --clear-bigtable-config

  • Abbonamento Cloud Storage: --clear-cloud-storage-config

• NEW_CONFIG_FLAGS: Flag per configurare il nuovo tipo di pubblicazione. Per saperne di più, consulta la documentazione relativa al comando gcloud pubsub subscriptions update.

Esempi

Modifica una sottoscrizione BigQuery in una sottoscrizione pull:

gcloud pubsub subscriptions update SUBSCRIPTION_ID \
  --clear-bigquery-config

Modifica di una sottoscrizione push in una sottoscrizione BigQuery:

gcloud pubsub subscriptions update SUBSCRIPTION_ID \
  --push-endpoint="" \
  --bigquery-table=BIGQUERY_TABLE

Aggiorna un endpoint di sottoscrizione push

Per aggiornare l'URL dell'endpoint di un sottoscrizione push, segui questi passaggi.

Console

Per modificare l'URL dell'endpoint, completa i seguenti passaggi.

1. Nella console Google Cloud , vai alla pagina Sottoscrizioni.

   Vai ad Abbonamenti

2. Fai clic su accanto all'abbonamento da aggiornare.
3. In Tipo di pubblicazione, scegli un'opzione di pubblicazione.
4. Compila le altre proprietà dell'abbonamento in base alle esigenze.
5. Fai clic su Aggiorna.

gcloud

1. Nella console Google Cloud , attiva Cloud Shell.

   Attiva Cloud Shell

   Nella parte inferiore della console Google Cloud viene avviata una sessione di Cloud Shell e viene visualizzato un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già installata e con valori già impostati per il progetto corrente. L'inizializzazione della sessione può richiedere alcuni secondi.

2. Per modificare l'URL dell'endpoint, esegui il comando gcloud pubsub subscriptions modify-push-config:

   gcloud pubsub subscriptions modify-push-config SUBSCRIPTION_ID \
     --push-endpoint=PUSH_ENDPOINT

   Se l'abbonamento utilizza già il recupero, l'impostazione dell'endpoint push cambia il metodo di consegna in push.

   Puoi passare dalla pubblicazione al recupero modificando l'endpoint di pubblicazione in una stringa vuota.

REST

Per modificare le configurazioni push di un'iscrizione, utilizza il metodo projects.subscriptions.modifyPushConfig:

Richiesta:

La richiesta deve essere autenticata con un token di accesso nell'intestazione Authorization. Per ottenere un token di accesso per le attuali Credenziali predefinite dell'applicazionee: gcloud auth application-default print-access-token.

POST https://pubsub.googleapis.com/v1/projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID:modifyPushConfig
Authorization: Bearer ACCESS_TOKEN
  

Corpo della richiesta:

{
"pushConfig": {
  "pushEndpoint": "PUSH_ENDPOINT"
}
}

Dove:

PROJECT_ID è l'ID progetto.

SUBSCRIPTION_ID è l'ID abbonamento.

PUSH_ENDPOINT è un URL modificato che vuoi applicare come nuovo endpoint push. Ad esempio, https://myproject.appspot.com/myhandler.

Risposta:

Se la richiesta ha esito positivo, la risposta è un oggetto JSON vuoto.

C++

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

namespace pubsub_admin = ::google::cloud::pubsub_admin;
namespace pubsub = ::google::cloud::pubsub;
[](pubsub_admin::SubscriptionAdminClient client,
   std::string const& project_id, std::string const& subscription_id,
   std::string const& endpoint) {
  google::pubsub::v1::ModifyPushConfigRequest request;
  request.set_subscription(
      pubsub::Subscription(project_id, subscription_id).FullName());
  request.mutable_push_config()->set_push_endpoint(endpoint);
  auto status = client.ModifyPushConfig(request);
  if (!status.ok()) throw std::runtime_error(status.message());

  std::cout << "The subscription push configuration was successfully"
            << " modified\n";
}

C#

Prima di provare questo esempio, segui le istruzioni di configurazione di C# nella guida rapida all'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Pub/Sub C#.

using Google.Cloud.PubSub.V1;

public class UpdatePushConfigurationSample
{
    public void UpdatePushConfiguration(string projectId, string subscriptionId, string pushEndpoint)
    {
        SubscriberServiceApiClient subscriber = SubscriberServiceApiClient.Create();
        SubscriptionName subscriptionName = SubscriptionName.FromProjectSubscription(projectId, subscriptionId);

        PushConfig pushConfig = new PushConfig { PushEndpoint = pushEndpoint };

        subscriber.ModifyPushConfig(subscriptionName, pushConfig);
    }
}

Go

L'esempio seguente utilizza la versione principale della libreria client Go Pub/Sub (v2). Se utilizzi ancora la libreria v1, consulta la guida alla migrazione alla v2. Per visualizzare un elenco di esempi di codice della versione 1, consulta gli esempi di codice deprecati.

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

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/pubsub/v2"
	"cloud.google.com/go/pubsub/v2/apiv1/pubsubpb"
	"google.golang.org/protobuf/types/known/fieldmaskpb"
)

func updateEndpoint(w io.Writer, projectID, subscriptionName, endpoint string) error {
	// projectID := "my-project-id"
	// subscriptionName := "projects/my-project/subscriptions/my-sub"
	// endpoint := "https://my-test-project.appspot.com/push"
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewClient: %w", err)
	}
	defer client.Close()

	req := &pubsubpb.UpdateSubscriptionRequest{
		Subscription: &pubsubpb.Subscription{
			Name: subscriptionName,
			PushConfig: &pubsubpb.PushConfig{
				PushEndpoint: endpoint,
			},
		},
		UpdateMask: &fieldmaskpb.FieldMask{
			Paths: []string{"push_config"},
		},
	}
	subConfig, err := client.SubscriptionAdminClient.UpdateSubscription(ctx, req)
	if err != nil {
		return fmt.Errorf("Update: %w", err)
	}
	fmt.Fprintf(w, "Updated subscription config: %v\n", subConfig)
	return nil
}

Java

Prima di provare questo esempio, segui le istruzioni di configurazione di Java nella guida rapida all'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Java di Pub/Sub.

import com.google.cloud.pubsub.v1.SubscriptionAdminClient;
import com.google.pubsub.v1.PushConfig;
import com.google.pubsub.v1.Subscription;
import com.google.pubsub.v1.SubscriptionName;
import java.io.IOException;

public class UpdatePushConfigurationExample {
  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "your-project-id";
    String subscriptionId = "your-subscription-id";
    String pushEndpoint = "https://my-test-project.appspot.com/push";

    updatePushConfigurationExample(projectId, subscriptionId, pushEndpoint);
  }

  public static void updatePushConfigurationExample(
      String projectId, String subscriptionId, String pushEndpoint) throws IOException {
    try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
      SubscriptionName subscriptionName = SubscriptionName.of(projectId, subscriptionId);
      PushConfig pushConfig = PushConfig.newBuilder().setPushEndpoint(pushEndpoint).build();
      subscriptionAdminClient.modifyPushConfig(subscriptionName, pushConfig);
      Subscription subscription = subscriptionAdminClient.getSubscription(subscriptionName);
      System.out.println(
          "Updated push endpoint to: " + subscription.getPushConfig().getPushEndpoint());
    }
  }
}

Node.js

Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js nella guida rapida all'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Pub/Sub Node.js.

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';
// const subscriptionNameOrId = 'YOUR_SUBSCRIPTION_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 modifyPushConfig(topicNameOrId, subscriptionNameOrId) {
  const options = {
    // Set to an HTTPS endpoint of your choice. If necessary, register
    // (authorize) the domain on which the server is hosted.
    pushEndpoint: `https://${pubSubClient.projectId}.appspot.com/push`,
  };

  await pubSubClient
    .topic(topicNameOrId)
    .subscription(subscriptionNameOrId)
    .modifyPushConfig(options);
  console.log(`Modified push config for subscription ${subscriptionNameOrId}.`);
}

Node.ts

Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js nella guida rapida all'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Pub/Sub Node.js.

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';
// const subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID';

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

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

async function modifyPushConfig(
  topicNameOrId: string,
  subscriptionNameOrId: string,
) {
  const options: CreateSubscriptionOptions = {
    // Set to an HTTPS endpoint of your choice. If necessary, register
    // (authorize) the domain on which the server is hosted.
    pushEndpoint: `https://${pubSubClient.projectId}.appspot.com/push`,
  };

  await pubSubClient
    .topic(topicNameOrId)
    .subscription(subscriptionNameOrId)
    .modifyPushConfig(options);
  console.log(`Modified push config for subscription ${subscriptionNameOrId}.`);
}

Python

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

from google.cloud import pubsub_v1

# TODO(developer)
# project_id = "your-project-id"
# topic_id = "your-topic-id"
# subscription_id = "your-subscription-id"
# endpoint = "https://my-test-project.appspot.com/push"

subscriber = pubsub_v1.SubscriberClient()
subscription_path = subscriber.subscription_path(project_id, subscription_id)

push_config = pubsub_v1.types.PushConfig(push_endpoint=endpoint)

subscription = pubsub_v1.types.Subscription(
    name=subscription_path, topic=topic_id, push_config=push_config
)

update_mask = {"paths": {"push_config"}}

# Wrap the subscriber in a 'with' block to automatically call close() to
# close the underlying gRPC channel when done.
with subscriber:
    result = subscriber.update_subscription(
        request={"subscription": subscription, "update_mask": update_mask}
    )

print(f"Subscription updated: {subscription_path}")
print(f"New endpoint for subscription is: {result.push_config}.")

Ruby

L'esempio seguente utilizza la libreria client Ruby Pub/Sub v3. Se utilizzi ancora la libreria v2, consulta la guida alla migrazione alla v3. Per visualizzare un elenco di esempi di codice Ruby v2, consulta gli esempi di codice deprecati.

Prima di provare questo esempio, segui le istruzioni di configurazione di Ruby nella guida rapida all'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Pub/Sub Ruby.

# subscription_id   = "your-subscription-id"
# new_endpoint      = "Endpoint where your app receives messages""

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

subscription = subscription_admin.get_subscription \
  subscription: pubsub.subscription_path(subscription_id)
subscription.push_config = Google::Cloud::PubSub::V1::PushConfig.new \
  push_endpoint: new_endpoint

subscription_admin.update_subscription subscription: subscription,
                                       update_mask: {
                                         paths: ["push_config"]
                                       }

puts "Push endpoint updated."

Nota: il passaggio da un abbonamento push a una sottoscrizione pull richiede diversi minuti per essere completato. In questo intervallo, le richieste di pull potrebbero generare errori e le richieste di push potrebbero continuare.

Passaggi successivi

• Crea o modifica un abbonamento con i comandi gcloud.
• Crea o modifica un abbonamento con le API REST.