Package google.cloud.metastore.v1alpha

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

string

必須。メタデータを変更する Metastore サービスの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.services.mutateMetadata

string

必須。相対メタデータ リソース名（次の形式）。

databases/{database_id}、databases/{database_id}/tables/{table_id}、または databases/{database_id}/tables/{table_id}/partitions/{partition_id}

string

必須。メタデータ リソースの新しいロケーション URI。

string

必須。メタデータ テーブルのプロパティの変更に使用されている Dataproc Metastore サービスの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.services.mutateMetadata

string

必須。変更するプロパティを含むテーブルの名前（次の形式）。

databases/{database_id}/tables/{table_id}

FieldMask

更新によって上書きされるメタデータ テーブルのプロパティを指定するフィールド マスク。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。フィールドは、マスク内にある場合、上書きされます。

たとえば、次のようなターゲット プロパティがあるとします。

properties {
  a: 1
  b: 2
}

更新プロパティ:

properties {
  a: 2
  b: 3
  c: 4
}

フィールド マスクが次のいずれかの場合:

paths: ["properties.b", "properties.c"]

結果は次のようになります。

properties {
  a: 1
  b: 3
  c: 4
}

map<string, string>

変更する値を記述するマップ。update_mask が空の場合、プロパティは更新されません。それ以外の場合、プロパティは、更新マスクに関連付けられたパスが存在する値のみを変更します。

float

出力専用。自動スケーリングが有効なサービスのスケーリング係数。

bool

省略可。このサービスで自動スケーリングが有効かどうか。

LimitConfig

省略可。サービスの LimitConfig。

string

補助サービスの Hive メタストア バージョン。プライマリ Hive メタストア サービスのバージョンより小さい値にする必要があります。

map<string, string>

プライマリ バージョンのオーバーライドに加えて、補助 Hive メタストア（hive-site.xml で構成）に適用する Hive メタストア構成の Key-Value ペアのマッピング。補助バージョンのオーバーライドとプライマリ バージョンのオーバーライドの両方にキーが存在する場合、補助バージョンのオーバーライドの値が優先されます。

NetworkConfig

出力専用。ネットワーク構成には、補助 Hive メタストア サービスのエンドポイント URI が含まれています。

string

連携されるメタストアの相対リソース名。現在サポートされているメタストアの相対リソース名の形式は次のとおりです。

• BigQuery
  • projects/{project_id}
• Dataproc Metastore
  • projects/{project_id}/locations/{location}/services/{service_id}

MetastoreType

バックエンド メタストアのタイプ。

string

変更不可。バックアップの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}

Timestamp

出力専用。バックアップが開始された日時。

Timestamp

出力専用。バックアップの作成が完了した日時。

State

出力専用。バックアップの現在の状態。

Service

出力専用。バックアップ時のサービスのリビジョン。

string

バックアップの説明。

string

出力専用。バックアップから復元中のサービス。

string

必須。進行中の移行をキャンセルするメタストア サービスの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.migrations.cancel

string

移行実行の相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}。

string

必須。移行先のメタストア サービスの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.migrations.complete

string

移行実行の相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}。

string

必須。次の形式のバックアップを作成するサービスの相対リソース名。

projects/{project_number}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.backups.create

string

必須。バックアップの ID。バックアップ名の最後のコンポーネントとして使用されます。

この値は 1 ～ 64 文字で、先頭は英字、末尾は英字または数字にする必要があります。英数字の ASCII 文字またはハイフンで構成する必要があります。

Backup

必須。作成するバックアップ。name フィールドは無視されます。作成されたバックアップの ID は、リクエストの backup_id フィールドに指定する必要があります。

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

string

必須。連携サービスを作成するロケーションの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.federations.create

string

必須。メタストア連携の ID。メタストア連携の名前の最後のコンポーネントとして使用されます。

この値は 2 ～ 63 文字で、先頭は英字、末尾は英字または数字にする必要があります。英数字の ASCII 文字またはハイフンで構成する必要があります。

Federation

必須。作成する Metastore Federation。name フィールドは無視されます。作成されたメタストア連携の ID は、リクエストの federation_id フィールドに指定する必要があります。

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

string

必須。メタストアのインポートを作成するサービスの相対リソース名。次の形式で指定します。

projects/{project_number}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.imports.create

string

必須。メタデータ インポートの ID。メタデータ インポートの名前の最終的なコンポーネントとして使用されます。

この値は 1 ～ 64 文字で、先頭は英字、末尾は英字または数字にする必要があります。英数字の ASCII 文字またはハイフンで構成する必要があります。

MetadataImport

必須。作成するメタデータのインポート。name フィールドは無視されます。作成されたメタデータ インポートの ID は、リクエストの metadata_import_id フィールドに指定する必要があります。

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

string

必須。メタストア サービスを作成するロケーションの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.services.create

string

必須。メタストア サービスの ID。メタストア サービスの名前の最終的なコンポーネントとして使用されます。

この値は 2 ～ 63 文字で、先頭は英字、末尾は英字または数字にする必要があります。英数字の ASCII 文字またはハイフンで構成する必要があります。

Service

必須。作成する Metastore サービス。name フィールドは無視されます。作成された Metastore サービスの ID は、リクエストの service_id フィールドに指定する必要があります。

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

bool

省略可。Metastore メタデータを Data Catalog に同期するかどうかを定義します。デフォルト値では、Metastore メタデータと Data Catalog の同期が無効になっています。

map<string, Lake>

この Metastore サービスが接続されている Lake リソースへの参照。キーはレイク リソース名です。例: projects/{project_number}/locations/{location_id}/lakes/{lake_id}。

string

必須。削除するバックアップの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.backups.delete

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

string

必須。削除するメタストア連携の相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/federations/{federation_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.federations.delete

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

string

必須。削除する migrationExecution の相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.migrations.delete

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

string

必須。削除するメタストア サービスの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.services.delete

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

string

お客様データの暗号化に使用する、お客様が指定した Cloud KMS 鍵の完全修飾名（次の形式）。

projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}。

map<string, string>

このエラーに関する追加の構造化された詳細情報。

キーは障害項目を定義します。Value は、アイテムの例外または詳細を表します。

string

必須。エクスポートを実行する Metastore サービスの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.services.export

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID である必要があります。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

Type

省略可。データベース ダンプのタイプ。指定しない場合、デフォルトで MYSQL になります。

string

フォルダの Cloud Storage URI（gs://<bucket_name>/<path_inside_bucket> 形式）。エクスポートされたファイルを含むサブフォルダ <export_folder> がその下に作成されます。

string

変更不可。連携の相対リソース名。形式は projects/{project_number}/locations/{location_id}/federations/{federation_id} です。

Timestamp

出力専用。メタストア連携が作成された時刻。

Timestamp

出力専用。メタストア連携が最後に更新された日時。

map<string, string>

メタストア連携のユーザー定義ラベル。

string

変更不可。連携の Apache Hive メタストア バージョン。すべてのバックエンド メタストアのバージョンは、連携のバージョンと互換性がある必要があります。

map<int32, BackendMetastore>

BackendMetastore ランクから、連携サービスがクエリ時にメタデータを提供する BackendMetastore へのマップ。マップキーは、クエリ時にデータベース名を解決するために BackendMetastore が評価される順序を表します。0 より大きい値にする必要があります。数値が小さい BackendMetastore は、数値が大きい BackendMetastore より先に評価されます。

string

出力専用。連携エンドポイント。

State

出力専用。連携の現在の状態。

string

出力専用。メタストア連携の現在の状態に関する追加情報（利用可能な場合）。

string

出力専用。メタストア連携のグローバルに一意のリソース ID。

string

必須。取得するバックアップの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.backups.get

string

必須。取得するメタストア連携の相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/federations/{federation_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.federations.get

string

必須。取得するメタデータ インポートの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.imports.get

string

必須。取得する移行実行の相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.migrations.get

string

必須。取得するメタストア サービスの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

• metastore.services.get

string

変更不可。Hive メタストア スキーマのバージョン。

map<string, string>

Hive metastore に適用する Hive metastore 構成の Key-Value ペアのマッピング（hive-site.xml で構成）。マッピングはシステムのデフォルトをオーバーライドします（一部のキーはオーバーライドできません）。これらのオーバーライドは補助バージョンにも適用され、補助バージョンの AuxiliaryVersionConfig でさらにカスタマイズできます。

KerberosConfig

Kerberos レルムでサービス プリンシパルとして Hive メタストア サービスを構成するために使用される情報。Kerberos を無効にするには、UpdateService メソッドを使用して、リクエストの update_mask にこのフィールドのパス（hive_metastore_config.kerberos_config）を指定し、リクエストの service からこのフィールドを省略します。

EndpointProtocol

metastore サービス エンドポイントに使用するプロトコル。指定しない場合、デフォルトで THRIFT になります。

map<string, AuxiliaryVersionConfig>

Hive メタストア バージョンと補助バージョン構成のマッピング。指定すると、セカンダリ Hive メタストア サービスがプライマリ サービスとともに作成されます。すべての補助バージョンは、サービスのプライマリ バージョンよりも低いバージョンにする必要があります。キーは補助サービス名であり、正規表現 a-z? に一致する必要があります。つまり、最初の文字は小文字にする必要があり、その後の文字はすべてハイフン、小文字、数字にする必要があります。ただし、最後の文字はハイフンにできません。

Secret

Kerberos キー配布センター（KDC）でサービス プリンシパルを認証するために使用できる Kerberos keytab ファイル。

string

認証する KDC と keytab の両方に存在する Kerberos プリンシパル。一般的なプリンシパルは primary/instance@REALM の形式ですが、厳密な形式はありません。

string

krb5.conf ファイルのパスを指定する Cloud Storage URI。形式は gs://{bucket_name}/path/to/krb5.conf ですが、ファイルに krb5.conf という名前を付ける必要はありません。

string

Lake リソース名。例: projects/{project_number}/locations/{location_id}/lakes/{lake_id}

string

出力専用。進行中のスケジュール設定されたバックアップの ID。バックアップが進行中でない場合は空になります。

Timestamp

出力専用。バックアップが開始された日時。

State

出力専用。バックアップの現在の状態。

Duration

出力専用。バックアップの完了時間。

float

省略可。サービスが自動スケーリングされる最大スケーリング係数。

float

省略可。サービスを自動スケーリングする最小スケーリング ファクタ。

string

必須。バックアップを一覧表示するサービスの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/backups。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.backups.list

int32

省略可。返されるバックアップの最大数。レスポンスには、最大数より少ない数値が含まれる場合があります。指定しなかった場合、最大 500 個のバックアップが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に変更されます。

string

省略可。前回の DataprocMetastore.ListBackups 呼び出しから受け取ったページトークン。後続のページを取得するには、このトークンを指定します。

最初のページを取得するには、空のページトークンを指定します。

ページネーションを行う場合、DataprocMetastore.ListBackups に指定する他のパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

string

省略可。リストの結果に適用するフィルタ。

string

省略可。並べ替え順序の説明に従って、結果の並べ替え順序を指定します。指定しない場合、結果はデフォルトの順序で並べ替えられます。

Backup

指定したサービスのバックアップ。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

到達できなかった場所。

string

必須。一覧表示するメタストア連携のロケーションの相対リソース名（projects/{project_number}/locations/{location_id} 形式）。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.federations.list

int32

省略可。返される連携の最大数。レスポンスには、最大数より少ない数値が含まれる場合があります。指定しない場合、返されるサービスは 500 件以下になります。最大値は 1,000 です。1,000 を超える値は 1,000 に変更されます。

string

省略可。前回の ListFederationServices 呼び出しから受け取ったページトークン。後続のページを取得するには、このトークンを指定します。

最初のページを取得するには、空のページトークンを指定します。

ページネーションを行う場合、ListFederationServices に指定する他のパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

string

省略可。リストの結果に適用するフィルタ。

string

省略可。並べ替え順序の説明に従って、結果の並べ替え順序を指定します。指定しない場合、結果はデフォルトの順序で並べ替えられます。

Federation

指定されたロケーションのサービス。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

到達できなかった場所。

string

必須。メタデータをインポートして一覧表示するサービスの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.imports.list

int32

省略可。返されるインポートの最大数。レスポンスには、最大数より少ない数値が含まれる場合があります。指定しない場合、返されるインポートは 500 件以下になります。最大値は 1,000 です。1,000 を超える値は 1,000 に変更されます。

string

省略可。前回の DataprocMetastore.ListServices 呼び出しから受け取ったページトークン。後続のページを取得するには、このトークンを指定します。

最初のページを取得するには、空のページトークンを指定します。

ページネーションを行う場合、DataprocMetastore.ListServices に指定する他のパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

string

省略可。リストの結果に適用するフィルタ。

string

省略可。並べ替え順序の説明に従って、結果の並べ替え順序を指定します。指定しない場合、結果はデフォルトの順序で並べ替えられます。

MetadataImport

指定されたサービスのインポート。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

到達できなかった場所。

string

必須。移行実行を一覧表示するサービスの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.migrations.list

int32

省略可。返される移行実行の最大数。レスポンスには、最大数より少ない数値が含まれる場合があります。指定しない場合、返される移行実行は 500 件以下になります。最大値は 1,000 です。1,000 を超える値は 1,000 に変更されます。

string

省略可。前回の DataprocMetastore.ListMigrationExecutions 呼び出しから受け取ったページトークン。後続のページを取得するには、このトークンを指定します。

最初のページを取得するには、空のページトークンを指定します。

ページネーションを行う場合、DataprocMetastore.ListMigrationExecutions に指定する他のパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

string

省略可。リストの結果に適用するフィルタ。

string

省略可。並べ替え順序の説明に従って、結果の並べ替え順序を指定します。指定しない場合、結果はデフォルトの順序で並べ替えられます。

MigrationExecution

指定されたサービスでの移行実行。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

到達できなかった場所。

string

必須。一覧表示するメタストア サービスのロケーションの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

• metastore.services.list

int32

省略可。返されるサービスの最大数。レスポンスには、最大数より少ない数値が含まれる場合があります。指定しない場合、返されるサービスは 500 件以下になります。最大値は 1,000 です。1,000 を超える値は 1,000 に変更されます。

string

省略可。前回の DataprocMetastore.ListServices 呼び出しから受け取ったページトークン。後続のページを取得するには、このトークンを指定します。

最初のページを取得するには、空のページトークンを指定します。

ページネーションを行う場合、DataprocMetastore.ListServices に指定する他のパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

string

省略可。リストの結果に適用するフィルタ。

string

省略可。並べ替え順序の説明に従って、結果の並べ替え順序を指定します。指定しない場合、結果はデフォルトの順序で並べ替えられます。

Service

指定されたロケーションのサービス。

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

string

到達できなかった場所。

HiveMetastoreVersion

このロケーションで新しいメタストア サービスを作成するときに使用できる Hive Metastore のバージョン。サーバーは、リスト内の 1 つの HiveMetastoreVersion だけに is_default が設定されることを保証します。

MultiRegionMetadata

現在のリージョンがマルチリージョンの場合のマルチリージョン メタデータ。

CustomRegionMetadata

現在のリージョンがカスタム リージョンの場合にサポートされる構成。

string

このカスタム リージョンの読み取り / 書き込みリージョン。

string

このカスタム リージョンの読み取り専用リージョン。

string

このカスタム リージョンの Spanner ウィットネス リージョン。

string

Hive Metastore ソフトウェアのセマンティック バージョン。

bool

version を省略した HiveMetastoreConfig を使用してメタストア サービスが作成された場合、サーバーが version を選択するかどうか。

string

マルチリージョンを構成するリージョン。

Int32Value

時間枠の開始時刻（0 ～ 23）。

DayOfWeek

ウィンドウの開始曜日。

Timestamp

出力専用。エクスポートが開始された時刻。

Timestamp

出力専用。エクスポートが終了した日時。

State

出力専用。エクスポートの現在のステータス。

Type

出力専用。データベース ダンプのタイプ。

string

出力専用。メタデータがエクスポートされるフォルダの Cloud Storage URI（gs://<bucket_name>/<path_inside_bucket>/<export_folder> 形式）。<export_folder> は自動的に生成されます。

string

変更不可。メタデータのインポートの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}。

string

メタデータのインポートの説明。

Timestamp

出力専用。メタデータのインポートが開始された時刻。

Timestamp

出力専用。メタデータのインポートが最後に更新された日時。

Timestamp

出力専用。メタデータのインポートが完了した時刻。

State

出力専用。メタデータのインポートの現在の状態。

DatabaseDump

変更不可。既存のメタストアのデータベースからのデータベース ダンプ。

DatabaseType

データベースのタイプ。

string

メタデータをインポートするソースを指定する Cloud Storage オブジェクトまたはフォルダの URI。先頭を gs:// にする必要があります。

string

ソース データベースの名前。

Type

省略可。データベース ダンプのタイプ。指定しない場合、デフォルトで MYSQL になります。

DataCatalogConfig

省略可。Data Catalog サービスのインテグレーション構成。

DataplexConfig

Dataplex サービスのインテグレーション構成。

MetadataExport

出力専用。メタストア サービスの最新のメタデータ エクスポート。

Restore

出力専用。Metastore サービスの最新の復元。

string

出力専用。移行実行の相対リソース名（projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id} 形式）。

Timestamp

出力専用。移行の実行が開始された時刻。

Timestamp

出力専用。移行実行が完了した時刻。

State

出力専用。移行実行の現在の状態。

Phase

出力専用。移行実行の現在のフェーズ。

string

出力専用。移行実行の現在の状態に関する追加情報。

CloudSQLMigrationConfig

バックエンド データベースとして Cloud SQL を使用する Google Cloud のセルフマネージド Hive メタストアから Dataproc Metastore に移行する場合に固有の構成情報。

CdcConfig

必須。顧客データベースから Dataproc Metastore のバックエンド データベースへの変更データ キャプチャ（CDC）ストリームを開始するための構成情報。移行のカットオーバー フェーズ後、Dataproc Metastore はバックエンド データベースを使用するように切り替わります。

CloudSQLConnectionConfig

必須。移行のカットオーバー フェーズ前に顧客データベース接続を確立するための構成情報

string

必須。Datastream がピアリングする Cloud SQL インスタンスの VPC ネットワークまたは共有 VPC ネットワークの完全修飾名（projects/{project_id}/locations/global/networks/{network_id} の形式）。詳細については、https://cloud.google.com/datastream/docs/network-connectivity-options#privateconnectivity をご覧ください。

string

必須。Datastream とのピアリングに使用する /29 CIDR IP 範囲。

string

必須。Datastream サービスが MySQL 接続に使用するユーザー名。

string

必須。入力のみのDatastream サービスが MySQL 接続に使用するユーザーのパスワード。このフィールドはリクエストで返されません。

string

必須。リバース プロキシをホストする VM インスタンスを作成するサブネットワーク リソースの URL。詳細については、https://cloud.google.com/datastream/docs/private-connectivity#reverse-csql-proxy をご覧ください。サブネットワークは、リクエストで指定された、Datastream がピアリングするネットワークに存在し、Datastream と同じリージョンに存在する必要があります。形式は次のとおりです。projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}

string

省略可。中間ストリーム イベントデータを書き込むバケット。バケット名には、「gs://」などの接頭辞を含めないでください。バケットの命名要件をご覧ください。このフィールドは省略可能です。設定されていない場合は、アーティファクトの Cloud Storage バケットが使用されます。

string

省略可。Cloud Storage バケット内のルートパス。ストリーム イベントデータはこのパスに書き込まれます。デフォルト値は /migration です。

string

必須。Cloud SQL データベース接続名（project_id:region:instance_name）

string

必須。Cloud SQL インスタンスのプライベート IP アドレス。

int32

必須。データベースのネットワーク ポート。

string

必須。Hive データベース名。

string

必須。Dataproc Metastore サービスがデータベースへの接続に使用するユーザー名。

string

必須。入力のみのDataproc Metastore サービスがデータベースへの接続に使用するユーザーのパスワード。このフィールドはリクエストで返されません。

string

必須。SOCKS5 プロキシ サービスをデプロイするサブネットワークの相対リソース名。サブネットワークは、Cloud SQL インスタンスにアクセスできるネットワーク内に存在する必要があります。リソース名は projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} の形式にする必要があります。

string

必須。Private Service Connect に使用されるサブネットワークの相対リソース名。これは通常のサブネットではなく、NAT 専用に使用されます。（https://cloud.google.com/vpc/docs/about-vpc-hosted-services#psc-subnets）このサブネットは、SOCKS5 プロキシ サービスの公開に使用されます。サブネット サイズは /29 以上で、Cloud SQL インスタンスにアクセスできるネットワーク内に存在する必要があります。リソース名は projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} の形式にする必要があります。

string

必須。メタデータを変更する Metastore サービスの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.services.mutateMetadata

string

必須。移動するテーブルの名前。

string

必須。テーブルが存在するデータベースの名前。

string

必須。テーブルを移動するデータベースの名前。

RootCACertificate

出力専用。gRPC クライアントがマルチリージョンの Dataproc Metastore サービスへの接続に使用するルート CA 証明書のリスト。

CustomRegionConfig

string

必須。Metastore サービスが実行される読み取り / 書き込みリージョンのリスト。これらのリージョンは、マルチリージョンの一部（またはサブセット）である必要があります。

string

省略可。Metastore サービスが実行される読み取り専用リージョンのリスト。これらのリージョンは、マルチリージョンの一部（またはサブセット）である必要があります。

string

PEM 形式のルート CA 証明書。最大長は 65,536 バイトです。

Timestamp

証明書の有効期限（タイムスタンプ形式）。

Consumer

変更不可。Dataproc Metastore インスタンスのコンシューマ側のネットワーク構成。

bool

Dataproc Metastore サービスのピアリングされた VPC ネットワークのカスタムルートのインポートとエクスポートを有効にします。

string

出力専用。Metastore サービスへのアクセスに使用されるエンドポイントの URI。

string

出力専用。エンドポイント URI のロケーション。形式: projects/{project}/locations/{location}。

string

変更不可。IP アドレスが予約され、Dataproc Metastore サービスのエンドポイントとして使用される、お客様のプロジェクトのサブネット。サブネット内のホストと、同じリージョンと同じネットワークのサブネット内のすべてのホストからアクセスできます。サブネットのプライマリ範囲で使用可能な IP アドレスが 1 つ以上必要です。サブネットは次の形式で指定します。

projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}

Timestamp

出力専用。オペレーションが作成された時刻。

Timestamp

出力専用。オペレーションの実行が終了した時刻。

string

出力専用。オペレーションのターゲットに対応するサーバー定義のリソースパス。

string

出力専用。オペレーションによって実行される動詞の名前。

string

出力専用。人が読める形式のオペレーションのステータス（存在する場合）。

bool

出力専用。呼び出し元がオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、google.rpc.Status.code が 1 の [Operation.error][] 値を持ちます。これは Code.CANCELLED に相当します。

string

出力専用。オペレーションを開始するために使用された API のバージョン。

string

必須。メタデータをクエリする Metastore サービスの相対リソース名。次の形式で指定します。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.services.queryMetadata

string

必須。メタデータ データベースに対して実行する読み取り専用 SQL クエリ。クエリでデータの変更や変換を行うことはできません。

string

マニフェスト URI は、Cloud Storage 内の JSON インスタンスにリンクされます。このインスタンスは、QueryMetadataResponse とともにすぐにマニフェストされます。メタデータに対する長時間実行オペレーションのクエリが完了するまで、URI のコンテンツを再取得することはできません。

string

必須。IAM ポリシーを削除するデータプレーン リソースの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id} または projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}/tables/{table_id}

bool

省略可。データベースまたはテーブルに適用されている IAM ポリシーが設定されている場合は、非同期で削除します。デフォルト値は false です。

bool

ポリシーが正常に削除された場合は true。

Timestamp

出力専用。復元が開始された時刻。

Timestamp

出力専用。復元が終了した日時。

State

出力専用。復元の現在の状態。

string

出力専用。復元元のメタストア サービス バックアップの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}。

RestoreType

出力専用。復元のタイプ。

string

出力専用。復元先のサービスのリビジョンを含む復元の詳細（JSON 形式）。

string

省略可。バックアップ アーティファクトの保存場所を指定する Cloud Storage URI（gs://<bucket_name>/<path_inside_bucket> 形式）。

string

必須。復元を実行するメタストア サービスの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.services.restore

string

省略可。復元元のメタストア サービス バックアップの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}。backup_location とは相互に排他的で、2 つのいずれか 1 つを設定する必要があります。

認可には、指定されたリソース backup に対する次の IAM の権限が必要です。

• metastore.backups.use

string

省略可。バックアップ アーティファクトの場所（「avro/」の下にあるバックアップ Avro ファイル、backup_metastore.json、service.json）を指定する Cloud Storage URI。形式は次のとおりです。

gs://<path_to_backup>。backup とは相互に排他的で、2 つのいずれか 1 つを設定する必要があります。

RestoreType

省略可。復元のタイプ。指定しない場合、デフォルトで METADATA_ONLY になります。

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID である必要があります。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

AutoscalingConfig

省略可。自動スケーリングの構成。

InstanceSize

読み取り可能なインスタンスサイズの列挙型。各インスタンスサイズは浮動小数点値にマッピングされます（例: InstanceSize.EXTRA_SMALL = スケーリング ファクタ（0.1））。

float

スケーリング係数。1.0 未満の値の場合は 0.1 ずつ、1.0 を超える値の場合は 1.0 ずつ増分します。

bool

省略可。スケジュール設定されたバックアップが有効かどうかを定義します。デフォルト値は false です。

string

省略可。Cron 形式のスケジュール間隔。https://en.wikipedia.org/wiki/Cron を参照。デフォルトは空です。スケジュール設定されたバックアップは有効になりません。スケジュール設定されたバックアップを有効にするには指定する必要があります。

string

省略可。cron_schedule の解釈に使用するタイムゾーンを指定します。タイムゾーン データベース（https://en.wikipedia.org/wiki/List_of_tz_database_time_zones）のタイムゾーン名（例: America/Los_Angeles、Africa/Abidjan）にする必要があります。指定しない場合、デフォルトは UTC です。

Timestamp

出力専用。次のバックアップ実行が開始されるスケジュールされた時刻。

string

省略可。フォルダの Cloud Storage URI（gs://<bucket_name>/<path_inside_bucket> 形式）。バックアップ ファイルを含むサブフォルダ <backup_folder> がその下に保存されます。

LatestBackup

出力専用。最新のスケジュール設定されたバックアップの詳細。

string

Secret Manager シークレット バージョンの相対リソース名。形式は次のとおりです。

projects/{project_number}/secrets/{secret_id}/versions/{version_id}。

string

変更不可。メタストア サービスの相対リソース名（次の形式）。

projects/{project_number}/locations/{location_id}/services/{service_id}。

Timestamp

出力専用。Metastore サービスが作成された時刻。

Timestamp

出力専用。メタストア サービスが最後に更新された時刻。

map<string, string>

metastore サービスのユーザー定義ラベル。

string

変更不可。インスタンスにアクセスできる VPC ネットワークの相対リソース名。次の形式で指定します。

projects/{project_number}/global/networks/{network_id}。

string

出力専用。Metastore サービスへのアクセスに使用されるエンドポイントの URI。

int32

メタストア サービスに到達する TCP ポート。デフォルト: 9083。

State

出力専用。メタストア サービスの現在の状態。

string

出力専用。metastore サービスの現在の状態に関する追加情報（利用可能な場合）。

string

出力専用。Metastore サービスに関連するアーティファクトが保存される場所を指定する Cloud Storage URI（gs:// で始まります）。

Tier

サービスのティア。

MetadataIntegration

省略可。Metastore メタデータを外部サービスやシステムと統合する方法を定義する設定。

MaintenanceWindow

Metastore サービスの 1 時間のメンテナンスの時間枠。メンテナンスのためにサービスを再起動できるタイミングを UTC 時間で指定します。SPANNER データベース タイプのサービスでは、メンテナンスの時間枠は必要ありません。

string

出力専用。メタストア サービスのグローバルに一意のリソース ID。

MetadataManagementActivity

出力専用。メタストア サービスのメタデータ管理アクティビティ。

ReleaseChannel

変更不可。サービスのリリース チャンネル。指定しない場合、デフォルトで STABLE になります。

EncryptionConfig

変更不可。保存中の顧客データを暗号化するように Dataproc Metastore サービスを構成するために使用される情報。この設定は変更できません。

NetworkConfig

Dataproc Metastore サービスのネットワーク設定を指定する構成。

DatabaseType

変更不可。Metastore サービスがデータを保存するデータベースのタイプ。

TelemetryConfig

Dataproc Metastore サービスのテレメトリー設定を指定する構成。指定しない場合、デフォルトの JSON が使用されます。

ScalingConfig

Metastore サービスのスケーリング構成。

MultiRegionConfig

省略可。Hive メタストア サービスのマルチリージョン構成情報を指定します。

ScheduledBackup

省略可。Metastore サービスのスケジュール設定されたバックアップの構成。

bool

省略可。Dataproc Metastore を誤って削除しないように保護するかどうかを示します。

HiveMetastoreConfig

メタストア サービスとして Hive メタストア ソフトウェアを実行する場合に固有の構成情報。

string

必須。移行先の Metastore サービスの相対リソース名（次の形式）。

projects/{project_id}/locations/{location_id}/services/{service_id}。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.migrations.start

MigrationExecution

必須。移行の構成の詳細。

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

LogFormat

Dataproc Metastore サービスのログの出力形式。

FieldMask

必須。更新によってメタストア連携リソースで上書きするフィールドを指定するフィールド マスク。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。フィールドは、マスク内にある場合、上書きされます。

Federation

必須。更新するメタストア連携。サーバーは、update_mask で指定されている場合のみ、サービスのフィールドを統合します。

メタストア連携の name フィールドは、更新するメタストア サービスを識別するために使用されます。

認可には、指定されたリソース federation に対する次の IAM の権限が必要です。

• metastore.federations.update

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

FieldMask

必須。更新によってメタデータ インポート リソースで上書きするフィールドを指定するフィールド マスク。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。フィールドは、マスク内にある場合、上書きされます。

MetadataImport

必須。更新するメタデータのインポート。サーバーは、インポート内のフィールドを update_mask で指定した場合にのみ統合します。

メタデータ インポートの name フィールドは、更新するメタストア インポートを識別するために使用されます。

認可には、指定されたリソース metadataImport に対する次の IAM の権限が必要です。

• metastore.imports.update

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

FieldMask

必須。更新によって Metastore サービス リソースで上書きするフィールドを指定するフィールド マスク。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。フィールドは、マスク内にある場合、上書きされます。

Service

必須。更新する Metastore サービス。サーバーは、update_mask で指定されている場合のみ、サービスのフィールドを統合します。

metastore サービスの name フィールドは、更新する metastore サービスを識別するために使用されます。

認可には、指定されたリソース service に対する次の IAM の権限が必要です。

• metastore.services.update

string

省略可。リクエスト ID。一意のリクエスト ID を指定すると、完了したリクエストについてはサーバーが無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間は、重複するリクエスト ID を指定する後続のリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID で別のリクエストが続いた場合、サーバーは重複するコミットメントの作成を防ぐために 2 番目のリクエストを無視します。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。