Mode pembaruan skema

Mode skema menentukan apakah registry skema atau subjek tertentu mengizinkan perubahan, seperti menulis atau mengedit skema.

  • Nilai yang didukung untuk mode skema adalah Readonly dan Readwrite.

  • Mode skema dikelola sebagai objek JSON yang berisi key-value pair. Misalnya, berikut adalah contohnya:

    {
      "mode": "READWRITE"
    }
    
  • Jika tidak ditetapkan secara eksplisit di tingkat registry skema, mode skema secara default adalah Readwrite.

  • Jika mode skema tidak ditentukan secara eksplisit di tingkat subjek, mode skema akan mewarisi nilai dari registry skema.

  • Konfigurasi yang ditetapkan di tingkat subjek akan menggantikan konfigurasi yang ditetapkan di tingkat schema registry.

Untuk mengetahui informasi selengkapnya tentang mode skema termasuk nilainya, lihat Mode skema.

Peran dan izin yang diperlukan untuk memperbarui mode skema

Untuk mendapatkan izin yang diperlukan guna memperbarui mode skema untuk registry skema atau subjek, minta administrator untuk memberi Anda peran IAM Managed Kafka Schema Registry Editor (roles/managedkafka.schemaRegistryEditor) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Peran bawaan ini berisi izin yang diperlukan untuk memperbarui mode skema untuk registry atau subjek skema. Untuk melihat izin yang benar-benar diperlukan, perluas bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk memperbarui mode skema untuk registry skema atau subjek:

  • Berikan izin berikut pada resource yang modenya ingin Anda perbarui: managedkafka.mode.update

Anda mungkin juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaan lainnya.

Untuk mengetahui informasi selengkapnya tentang peran standar yang tersedia untuk Managed Service for Apache Kafka, lihat dokumentasi Kontrol akses.

Memperbarui mode skema untuk registry skema

Konsol

Untuk memperbarui mode skema untuk seluruh registry skema, ikuti langkah-langkah berikut:

  1. Di konsol Google Cloud , buka halaman Schema registries.

    Buka Schema registry

    Daftar registry skema di project Anda akan ditampilkan.

  2. Klik nama registry skema yang ingin Anda perbarui mode skemanya.

    Halaman Schema registry details akan terbuka.

  3. Di bagian detail utama untuk registri, temukan setelan Mode skema dan klik ikon Edit di sampingnya.

    Halaman Edit schema mode akan terbuka.

  4. Dari menu dropdown Mode skema, pilih nilai.

    Untuk mengetahui informasi selengkapnya tentang nilai ini, lihat Tentang mode skema.

  5. Klik Simpan.

gcloud

Untuk memperbarui mode skema untuk registry skema, gunakan perintah 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: ID registry skema yang akan diupdate.
  • LOCATION: region registry skema yang akan diperbarui.
  • MODE_TYPE: mode skema baru. Nilai yang valid adalah:
    • READWRITE
    • READONLY

Contoh:

Untuk mengupdate mode skema registry skema test-registry di region us-central1 menjadi READONLY, jalankan perintah berikut:

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

REST

Permintaan harus diautentikasi dengan token akses di header Authorization. Untuk mendapatkan token akses bagi Kredensial Default Aplikasi saat ini: gcloud auth application-default print-access-token.

Untuk memperbarui mode skema, buat permintaan PUT ke endpoint REST API untuk registry skema menggunakan metode projects.locations.schemaRegistries.contexts.mode.update.

Memperbarui mode skema untuk registry skema dengan konteks default:

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

Ganti parameter jalur berikut:

  • PROJECT_ID: Project ID Google Cloud Anda.
  • LOCATION: region tempat schema registry berada.
  • SCHEMA_REGISTRY_ID: ID unik dari registry skema.

Isi permintaan:

Sertakan objek JSON dalam isi permintaan yang menentukan detail mode.

{
  "mode": "MODE_TYPE"
}

Ganti MODE_TYPE dengan salah satu opsi string yang valid untuk mode:

  • READWRITE
  • READONLY

Jika berhasil, API akan menampilkan kode status 200 OK dan isi respons yang berisi representasi JSON dari konfigurasi mode yang diperbarui.

Untuk mengetahui informasi selengkapnya, lihat dokumentasi REST API.

Memperbarui mode skema untuk subjek

Konsol

Untuk memperbarui mode skema untuk subjek tertentu, ikuti langkah-langkah berikut:

  1. Di konsol Google Cloud , buka halaman Schema registries.

    Buka Schema registry

  2. Klik nama registry skema yang berisi subjek.

    Halaman Schema registry details akan terbuka.

  3. Di tabel Subjects in this schema registry, klik nama subjek yang ingin Anda perbarui mode skemanya.
  4. Temukan setelan Mode skema untuk subjek dan klik ikon Edit di sampingnya.

    Halaman Edit schema mode akan terbuka.

  5. Dari menu dropdown Mode skema, pilih nilai. Memilih nilai di sini akan menggantikan setelan tingkat registry untuk subjek tertentu ini.

    Untuk mengetahui informasi selengkapnya tentang nilai ini, lihat Tentang mode skema.

  6. Klik Simpan.

gcloud

Untuk memperbarui mode skema subjek, gunakan perintah 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: nama subjek yang akan diperbarui.
  • SCHEMA_REGISTRY_ID: ID registry skema yang berisi subjek.
  • LOCATION: region schema registry yang berisi subjek.
  • MODE_TYPE: mode skema baru. Nilai yang valid adalah:
    • READWRITE
    • READONLY

Contoh:

Untuk mengupdate mode skema subjek test-subject di registry skema test-registry di region us-central1 menjadi READONLY, jalankan perintah berikut:

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

REST

Permintaan harus diautentikasi dengan token akses di header Authorization. Untuk mendapatkan token akses bagi Kredensial Default Aplikasi saat ini: gcloud auth application-default print-access-token.

Untuk memperbarui mode skema subjek, buat permintaan PUT ke endpoint REST API untuk subjek tertentu menggunakan metode projects.locations.schemaRegistries.contexts.mode.update.

Memperbarui mode skema untuk subjek dalam konteks default:

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

Ganti parameter jalur berikut:

  • PROJECT_ID: Project ID Google Cloud Anda.
  • LOCATION: region tempat schema registry berada.
  • SCHEMA_REGISTRY_ID: ID unik dari registry skema.
  • SUBJECT_NAME: nama subjek.

Isi permintaan:

Sertakan objek JSON dalam isi permintaan yang menentukan detail mode.

{
  "mode": "MODE_TYPE"
}

Ganti MODE_TYPE dengan salah satu opsi string yang valid untuk mode:

  • READWRITE
  • READONLY

Contoh—Menetapkan mode skema subjek user_events ke Readonly dalam konteks default:

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

Dengan isi:

{
  "mode": "READONLY"
}

Jika berhasil, API akan menampilkan kode status 200 OK dan isi respons yang berisi representasi JSON dari resource subjek atau konteks yang diperbarui yang mencerminkan perubahan ini.

Memperbarui mode skema untuk subjek dalam konteks tertentu:

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

Ganti parameter jalur berikut:

  • PROJECT_ID: Project ID Google Cloud Anda.
  • LOCATION: region tempat schema registry berada.
  • SCHEMA_REGISTRY_ID: ID unik dari registry skema.
  • CONTEXT_NAME: nama konteks.
  • SUBJECT_NAME: nama subjek.

Isi permintaan:

Sertakan objek JSON dalam isi permintaan yang menentukan detail mode.

{
  "mode": "MODE_TYPE"
}

Ganti MODE_TYPE dengan salah satu opsi string yang valid untuk mode:

  • READWRITE
  • READONLY

Contoh—Menetapkan mode skema subjek user_events ke Readonly dalam konteks test_context:

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

Dengan isi:

{
  "mode": "READONLY"
}

Jika berhasil, API akan menampilkan kode status 200 OK dan isi respons yang berisi representasi JSON dari resource subjek atau konteks yang diperbarui yang mencerminkan perubahan ini.

Untuk mengetahui informasi selengkapnya, lihat dokumentasi REST API.

Langkah berikutnya

Apache Kafka® adalah merek dagang terdaftar milik The Apache Software Foundation atau afiliasinya di Amerika Serikat dan/atau negara lain.