スキーマ更新モード

スキーマモードは、スキーマレジストリまたは特定のサブジェクトでスキーマの書き込みや編集などの変更が許可されるかどうかを定義します。

スキーマモードでサポートされている値は、Readonly と Readwrite です。
スキーマモードは、Key-Value ペアを含む JSON オブジェクトとして管理されます。たとえば、次のようなサンプルがあります。
```
{
  "mode": "READWRITE"
}
```
スキーマレジストリレベルで明示的に設定されていない場合、スキーマモードはデフォルトで Readwrite になります。
スキーマモードがサブジェクトレベルで明示的に指定されていない場合、スキーマレジストリから値が継承されます。
サブジェクトレベルで設定された構成は、スキーマレジストリレベルで設定された構成をオーバーライドします。

スキーマモードとその値の詳細については、スキーマモードをご覧ください。

スキーマモードの更新に必要なロールと権限

スキーマレジストリまたはサブジェクトのスキーマモードを更新するために必要な権限を取得するには、プロジェクトに対する Managed Kafka Schema Registry 編集者（roles/managedkafka.schemaRegistryEditor）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

この事前定義ロールには、スキーマレジストリまたはサブジェクトのスキーマモードを更新するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

スキーマレジストリまたはサブジェクトのスキーマモードを更新するには、次の権限が必要です。

モードを更新するリソースに対して、次の権限を付与します。 managedkafka.mode.update

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

Managed Service for Apache Kafka で使用できる事前定義ロールの詳細については、アクセス制御のドキュメントをご覧ください。

スキーマレジストリのスキーマモードを更新する

コンソール

スキーマレジストリ全体のスキーマモードを更新する手順は次のとおりです。

Google Cloud コンソールで、[スキーマレジストリ] ページに移動します。
スキーマレジストリに移動

プロジェクト内のスキーマレジストリのリストが表示されます。
スキーマモードを更新するスキーマレジストリの名前をクリックします。
[スキーマレジストリの詳細] ページが開きます。
レジストリのメインの詳細セクションで、[スキーマモード] 設定を見つけて、その横にある [編集] アイコンをクリックします。
[スキーマの編集モード] ページが開きます。
[スキーマモード] プルダウンメニューから値を選択します。
これらの値の詳細については、スキーマモードについてをご覧ください。
[保存] をクリックします。

gcloud

スキーマレジストリのスキーマモードを更新するには、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。
LOCATION: 更新するスキーマレジストリのリージョン。
MODE_TYPE: 新しいスキーマモード。有効な値は次のとおりです。
- READWRITE
- READONLY

例:

us-central1 リージョンの test-registry スキーマレジストリのスキーマモードを READONLY に更新するには、次のコマンドを実行します。

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

REST

リクエストは、Authorization ヘッダー内のアクセストークンにより認証を受ける必要があります。現在のアプリケーションのデフォルト認証情報のアクセストークンを取得する場合は、gcloud auth application-default print-access-token を使用します。

スキーマモードを更新するには、projects.locations.schemaRegistries.contexts.mode.update メソッドを使用して、スキーマレジストリの REST API エンドポイントに PUT リクエストを行います。

デフォルトのコンテキストを使用してスキーマレジストリのスキーマモードを更新する:

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

次のパスパラメータを置き換えます。

PROJECT_ID: Google Cloud プロジェクト ID。
LOCATION: スキーマレジストリが存在するリージョン。
SCHEMA_REGISTRY_ID: スキーマレジストリの一意の ID。

リクエスト本文:

モードの詳細を指定する JSON オブジェクトをリクエストの本文に含めます。

{
  "mode": "MODE_TYPE"
}

MODE_TYPE は、モードの有効な文字列オプションのいずれかに置き換えます。

READWRITE
READONLY

成功すると、API は 200 OK ステータスコードと、更新されたモード構成の JSON 表現を含むレスポンス本文を返します。

詳細については、REST API のドキュメントをご覧ください。

サブジェクトのスキーマモードを更新する

コンソール

特定のサブジェクトのスキーマモードを更新する手順は次のとおりです。

Google Cloud コンソールで、[スキーマレジストリ] ページに移動します。
スキーマレジストリに移動
サブジェクトを含むスキーマレジストリの名前をクリックします。
[スキーマレジストリの詳細] ページが開きます。
[Subjects in this schema registry] テーブルで、スキーマモードを更新するサブジェクトの名前をクリックします。
サブジェクトの [スキーマモード] 設定を見つけて、その横にある [編集] アイコンをクリックします。
[スキーマの編集モード] ページが開きます。
[スキーマモード] プルダウンメニューから値を選択します。ここで値を選択すると、この特定のサブジェクトのレジストリレベルの設定がオーバーライドされます。
これらの値の詳細については、スキーマモードについてをご覧ください。
[保存] をクリックします。

gcloud

サブジェクトのスキーマモードを更新するには、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: 更新するサブジェクトの名前。
SCHEMA_REGISTRY_ID: サブジェクトを含むスキーマレジストリの ID。
LOCATION: サブジェクトを含むスキーマレジストリのリージョン。
MODE_TYPE: 新しいスキーマモード。有効な値は次のとおりです。
- READWRITE
- READONLY

例:

us-central1 リージョンの test-registry スキーマレジストリで test-subject サブジェクトのスキーマモードを READONLY に更新するには、次のコマンドを実行します。

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

REST

サブジェクトのスキーマモードを更新するには、projects.locations.schemaRegistries.contexts.mode.update メソッドを使用して、特定のサブジェクトの REST API エンドポイントに PUT リクエストを送信します。

デフォルトコンテキストのサブジェクトのスキーマモードを更新する:

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

次のパスパラメータを置き換えます。

PROJECT_ID: Google Cloud プロジェクト ID。
LOCATION: スキーマレジストリが存在するリージョン。
SCHEMA_REGISTRY_ID: スキーマレジストリの一意の ID。
SUBJECT_NAME: サブジェクトの名前。

リクエスト本文:

モードの詳細を指定する JSON オブジェクトをリクエストの本文に含めます。

{
  "mode": "MODE_TYPE"
}

MODE_TYPE は、モードの有効な文字列オプションのいずれかに置き換えます。

READWRITE
READONLY

例 - デフォルトのコンテキストでサブジェクト user_events スキーマモードを Readonly に設定します。

PUT https://managedkafka.googleapis.com/v1main/projects/test-gcp-project/locations/us-east1/schemaRegistries/main_registry/mode/user_events さんへのリクエスト

本文あり:

{
  "mode": "READONLY"
}

成功した場合、API は 200 OK ステータスコードと、この変更を反映した更新されたサブジェクトまたはコンテキストリソースの JSON 表現を含むレスポンスの本文を返します。

特定のコンテキストのサブジェクトのスキーマモードを更新する:

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

次のパスパラメータを置き換えます。

PROJECT_ID: Google Cloud プロジェクト ID。
LOCATION: スキーマレジストリが存在するリージョン。
SCHEMA_REGISTRY_ID: スキーマレジストリの一意の ID。
CONTEXT_NAME: コンテキストの名前。
SUBJECT_NAME: サブジェクトの名前。

リクエスト本文:

モードの詳細を指定する JSON オブジェクトをリクエストの本文に含めます。

{
  "mode": "MODE_TYPE"
}

MODE_TYPE は、モードの有効な文字列オプションのいずれかに置き換えます。

READWRITE
READONLY

例 - コンテキスト test_context でサブジェクト user_events スキーマモードを Readonly に設定する:

PUT https://managedkafka.googleapis.com/v1main/projects/test-gcp-project/locations/us-east1/schemaRegistries/main_registry/contexts/test_context/mode/user_events さんへのリクエスト

本文あり:

{
  "mode": "READONLY"
}

詳細については、REST API のドキュメントをご覧ください。

次のステップ

Apache Kafka® は、Apache Software Foundation または米国その他の諸国における関連会社の商標です。

スキーマ更新モード コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

スキーマ モードの更新に必要なロールと権限

必要な権限

スキーマ レジストリのスキーマモードを更新する

コンソール

gcloud

REST

サブジェクトのスキーマモードを更新する

コンソール

gcloud

REST

次のステップ

スキーマ更新モード

スキーマモードの更新に必要なロールと権限

スキーマレジストリのスキーマモードを更新する