Aggiorna modalità dello schema

La modalità dello schema definisce se un registro di schemi o un soggetto specifico consente modifiche, come la scrittura o la modifica degli schemi.

  • I valori supportati per la modalità schema sono Readonly e Readwrite.

  • La modalità schema viene gestita come un oggetto JSON contenente coppie chiave-valore. Ad esempio, di seguito è riportato un campione:

    {
      "mode": "READWRITE"
    }
    
  • Se non è impostata in modo esplicito a livello di registro di schema, la modalità dello schema è impostata per impostazione predefinita su Readwrite.

  • Se una modalità dello schema non è specificata esplicitamente a livello di soggetto, eredita il valore dal registro degli schemi.

  • Le configurazioni impostate a livello di argomento hanno la precedenza su quelle impostate a livello di registro di schemi.

Per ulteriori informazioni sulla modalità schema, inclusi i relativi valori, vedi Modalità schema.

Ruoli e autorizzazioni richiesti per aggiornare la modalità dello schema

Per ottenere le autorizzazioni necessarie per aggiornare la modalità dello schema per un registro o un argomento di schema, chiedi all'amministratore di concederti il ruolo IAM Editor del registro di schema Managed Kafka (roles/managedkafka.schemaRegistryEditor) nel progetto. Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Questo ruolo predefinito contiene le autorizzazioni necessarie per aggiornare la modalità dello schema per un registro di schema o un argomento. Per vedere quali sono esattamente le autorizzazioni richieste, espandi la sezione Autorizzazioni obbligatorie:

Autorizzazioni obbligatorie

Per aggiornare la modalità dello schema per un registro di schema o un argomento sono necessarie le seguenti autorizzazioni:

  • Concedi la seguente autorizzazione per la risorsa per cui vuoi aggiornare la modalità: managedkafka.mode.update

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

Per saperne di più sui ruoli predefiniti disponibili per Managed Service per Apache Kafka, consulta la documentazione sul controllo dell'accesso.

Aggiorna la modalità dello schema per un registro di schemi

Console

Per aggiornare la modalità dello schema per l'intero registro di schemi, segui questi passaggi:

  1. Nella console Google Cloud , vai alla pagina Registri di schemi.

    Vai a Registri di schema

    Viene visualizzato un elenco dei registri di schema nel tuo progetto.

  2. Fai clic sul nome del registro dello schema per cui vuoi aggiornare la modalità dello schema.

    Viene visualizzata la pagina Dettagli registro schema.

  3. Nella sezione dei dettagli principali del registro, individua l'impostazione Modalità schema e fai clic sull'icona Modifica accanto.

    Viene visualizzata la pagina Modalità Modifica schema.

  4. Nel menu a discesa Modalità schema, seleziona il valore.

    Per ulteriori informazioni su questi valori, vedi Informazioni sulla modalità schema.

  5. Fai clic su Salva.

gcloud

Per aggiornare la modalità dello schema per un registro di schemi, utilizza il comando gcloud alpha managed-kafka schema-registries update:

gcloud alpha managed-kafka schema-registries update SCHEMA_REGISTRY_ID \
    --location=LOCATION \
    --mode=MODE_TYPE
  • SCHEMA_REGISTRY_ID: l'ID del registro degli schemi da aggiornare.
  • LOCATION: la regione del registro di schema da aggiornare.
  • MODE_TYPE: la nuova modalità dello schema. I valori validi sono:
    • READWRITE
    • READONLY

Esempio:

Per aggiornare la modalità dello schema del registro di schemi test-registry nella regione us-central1 a READONLY, esegui questo comando:

gcloud alpha managed-kafka schema-registries update test-registry \
    --location=us-central1 \
    --mode=READONLY

REST

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'applicazione: gcloud auth application-default print-access-token.

Per aggiornare la modalità dello schema, invia una richiesta PUT all'endpoint dell'API REST per il registro degli schemi utilizzando il metodo projects.locations.schemaRegistries.contexts.mode.update.

Aggiornamento della modalità dello schema per il registro di schemi con un contesto predefinito:

PUT https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID/mode

Sostituisci i seguenti parametri di percorso:

  • PROJECT_ID: l'ID del tuo progetto Google Cloud.
  • LOCATION: la regione in cui esiste il registro degli schemi.
  • SCHEMA_REGISTRY_ID: l'ID univoco del registro degli schemi.

Corpo della richiesta:

Includi un oggetto JSON nel corpo della richiesta specificando i dettagli della modalità.

{
  "mode": "MODE_TYPE"
}

Sostituisci MODE_TYPE con una delle opzioni di stringa valide per la modalità:

  • READWRITE
  • READONLY

Se l'operazione va a buon fine, l'API restituisce un codice di stato 200 OK e un corpo della risposta contenente la rappresentazione JSON della configurazione della modalità aggiornata.

Per saperne di più, consulta la documentazione dell'API REST.

Aggiorna la modalità dello schema per un soggetto

Console

Per aggiornare la modalità dello schema per un argomento specifico:

  1. Nella console Google Cloud , vai alla pagina Registri di schemi.

    Vai a Registri di schema

  2. Fai clic sul nome del registro dello schema che contiene l'argomento.

    Viene visualizzata la pagina Dettagli registro schema.

  3. Nella tabella Soggetti in questo registro di schema, fai clic sul nome del soggetto per cui vuoi aggiornare la modalità dello schema.
  4. Trova l'impostazione Modalità schema per l'oggetto e fai clic sull'icona Modifica accanto.

    Viene visualizzata la pagina Modalità Modifica schema.

  5. Nel menu a discesa Modalità schema, seleziona il valore. La scelta di un valore qui sostituisce l'impostazione a livello di registro per questo argomento specifico.

    Per ulteriori informazioni su questi valori, vedi Informazioni sulla modalità schema.

  6. Fai clic su Salva.

gcloud

Per aggiornare la modalità dello schema per un argomento, utilizza il comando gcloud alpha managed-kafka schema-registries subject update:

gcloud alpha managed-kafka schema-registries subject update SUBJECT_NAME \
    --schema-registry=SCHEMA_REGISTRY_ID \
    --location=LOCATION \
    --mode=MODE_TYPE
  • SUBJECT_NAME: il nome dell'argomento da aggiornare.
  • SCHEMA_REGISTRY_ID: l'ID del registro di schema che contiene l'argomento.
  • LOCATION: la regione del registro di schema che contiene l'argomento.
  • MODE_TYPE: la nuova modalità dello schema. I valori validi sono:
    • READWRITE
    • READONLY

Esempio:

Per aggiornare la modalità dello schema dell'argomento test-subject nel registro di schema test-registry nella regione us-central1 a READONLY, esegui questo comando:

gcloud alpha managed-kafka schema-registries subject update test-subject \
    --schema-registry=test-registry \
    --location=us-central1 \
    --mode=READONLY

REST

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'applicazione: gcloud auth application-default print-access-token.

Per aggiornare la modalità schema per un soggetto, invia una richiesta PUT all'endpoint API REST per un soggetto specifico utilizzando il metodo projects.locations.schemaRegistries.contexts.mode.update.

Aggiornamento della modalità dello schema per un soggetto nel contesto predefinito:

PUT https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID/mode/SUBJECT_NAME

Sostituisci i seguenti parametri di percorso:

  • PROJECT_ID: l'ID del tuo progetto Google Cloud.
  • LOCATION: la regione in cui esiste il registro degli schemi.
  • SCHEMA_REGISTRY_ID: l'ID univoco del registro degli schemi.
  • SUBJECT_NAME: il nome della materia.

Corpo della richiesta:

Includi un oggetto JSON nel corpo della richiesta specificando i dettagli della modalità.

{
  "mode": "MODE_TYPE"
}

Sostituisci MODE_TYPE con una delle opzioni di stringa valide per la modalità:

  • READWRITE
  • READONLY

Esempio: imposta la modalità dello schema dell'oggetto user_events su Readonly nel contesto predefinito:

Richiesta a PUT https://managedkafka.googleapis.com/v1main/projects/test-gcp-project/locations/us-east1/schemaRegistries/main_registry/mode/user_events

Con corpo:

{
  "mode": "READONLY"
}

In caso di esito positivo, l'API restituisce un codice di stato 200 OK e un corpo della risposta contenente la rappresentazione JSON della risorsa di contesto o argomento aggiornata che riflette questa modifica.

Aggiornamento della modalità dello schema per un soggetto in un contesto specifico:

PUT https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID/contexts/CONTEXT_NAME/mode/SUBJECT_NAME

Sostituisci i seguenti parametri di percorso:

  • PROJECT_ID: l'ID del tuo progetto Google Cloud.
  • LOCATION: la regione in cui esiste il registro degli schemi.
  • SCHEMA_REGISTRY_ID: l'ID univoco del registro degli schemi.
  • CONTEXT_NAME: il nome del contesto.
  • SUBJECT_NAME: il nome della materia.

Corpo della richiesta:

Includi un oggetto JSON nel corpo della richiesta specificando i dettagli della modalità.

{
  "mode": "MODE_TYPE"
}

Sostituisci MODE_TYPE con una delle opzioni di stringa valide per la modalità:

  • READWRITE
  • READONLY

Esempio: imposta la modalità dello schema dell'oggetto user_events su Readonly nel contesto test_context:

Richiesta a PUT https://managedkafka.googleapis.com/v1main/projects/test-gcp-project/locations/us-east1/schemaRegistries/main_registry/contexts/test_context/mode/user_events

Con corpo:

{
  "mode": "READONLY"
}

In caso di esito positivo, l'API restituisce un codice di stato 200 OK e un corpo della risposta contenente la rappresentazione JSON della risorsa di contesto o argomento aggiornata che riflette questa modifica.

Per saperne di più, consulta la documentazione dell'API REST.

Passaggi successivi

Apache Kafka® è un marchio registrato di Apache Software Foundation o delle sue affiliate negli Stati Uniti e/o in altri paesi.