- リソース: Service
- JSON 表現
- HiveMetastoreConfig
- KerberosConfig
- シークレット
- EndpointProtocol
- AuxiliaryVersionConfig
- NetworkConfig
- コンシューマ
- 都道府県
- ティア
- MetadataIntegration
- DataCatalogConfig
- DataplexConfig
- 湖
- MaintenanceWindow
- MetadataManagementActivity
- MetadataExport
- 都道府県
- 復元
- 都道府県
- RestoreType
- ReleaseChannel
- EncryptionConfig
- DatabaseType
- TelemetryConfig
- LogFormat
- ScalingConfig
- InstanceSize
- AutoscalingConfig
- LimitConfig
- MultiRegionConfig
- RootCACertificate
- CustomRegionConfig
- ScheduledBackup
- LatestBackup
- 状態
- メソッド
リソース: Service
メタデータ クエリを提供するマネージド メタストア サービス。
JSON 表現 |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "network": string, "endpointUri": string, "port": integer, "state": enum ( |
フィールド | |
---|---|
name |
変更不可。メタストア サービスの相対リソース名(次の形式)。
|
createTime |
出力専用。Metastore サービスが作成された時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
updateTime |
出力専用。メタストア サービスが最後に更新された時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
labels |
metastore サービスのユーザー定義ラベル。
|
network |
変更不可。インスタンスにアクセスできる VPC ネットワークの相対リソース名。次の形式で指定します。
|
endpointUri |
出力専用。Metastore サービスへのアクセスに使用されるエンドポイントの URI。 |
port |
メタストア サービスに到達する TCP ポート。デフォルト: 9083。 |
state |
出力専用。メタストア サービスの現在の状態。 |
stateMessage |
出力専用。metastore サービスの現在の状態に関する追加情報(利用可能な場合)。 |
artifactGcsUri |
出力専用。Metastore サービスに関連するアーティファクトが保存される場所を指定する Cloud Storage URI( |
tier |
サービスのティア。 |
metadataIntegration |
省略可。Metastore メタデータを外部サービスやシステムと統合する方法を定義する設定。 |
maintenanceWindow |
Metastore サービスの 1 時間のメンテナンスの時間枠。メンテナンスのためにサービスを再起動できるタイミングを UTC 時間で指定します。SPANNER データベース タイプのサービスでは、メンテナンスの時間枠は必要ありません。 |
uid |
出力専用。メタストア サービスのグローバルに一意のリソース ID。 |
metadataManagementActivity |
出力専用。メタストア サービスのメタデータ管理アクティビティ。 |
releaseChannel |
変更不可。サービスのリリース チャンネル。指定しない場合、デフォルトで |
encryptionConfig |
変更不可。保存中の顧客データを暗号化するように Dataproc Metastore サービスを構成するために使用される情報。この設定は変更できません。 |
networkConfig |
Dataproc Metastore サービスのネットワーク設定を指定する構成。 |
databaseType |
変更不可。Metastore サービスがデータを保存するデータベースのタイプ。 |
telemetryConfig |
Dataproc Metastore サービスのテレメトリー設定を指定する構成。指定しない場合、デフォルトの |
scalingConfig |
Metastore サービスのスケーリング構成。 |
multiRegionConfig |
省略可。Hive メタストア サービスのマルチリージョン構成情報を指定します。 |
scheduledBackup |
省略可。Metastore サービスのスケジュール設定されたバックアップの構成。 |
deletionProtection |
省略可。Dataproc Metastore を誤って削除しないように保護するかどうかを示します。 |
共用体フィールド metastore_config 。基盤となるメタストア サービス テクノロジー(メタストア クエリを提供するソフトウェア)に固有の構成プロパティ。metastore_config は次のいずれかになります。 |
|
hiveMetastoreConfig |
メタストア サービスとして Hive メタストア ソフトウェアを実行する場合に固有の構成情報。 |
HiveMetastoreConfig
Hive メタストア ソフトウェアをメタストア サービスとして実行する場合に固有の構成情報を指定します。
JSON 表現 |
---|
{ "version": string, "configOverrides": { string: string, ... }, "kerberosConfig": { object ( |
フィールド | |
---|---|
version |
変更不可。Hive メタストア スキーマのバージョン。 |
configOverrides |
Hive metastore に適用する Hive metastore 構成の Key-Value ペアのマッピング(
|
kerberosConfig |
Kerberos レルムでサービス プリンシパルとして Hive メタストア サービスを構成するために使用される情報。Kerberos を無効にするには、 |
endpointProtocol |
metastore サービス エンドポイントに使用するプロトコル。指定しない場合、デフォルトで |
auxiliaryVersions |
Hive メタストア バージョンと補助バージョン構成のマッピング。指定すると、セカンダリ Hive メタストア サービスがプライマリ サービスとともに作成されます。すべての補助バージョンは、サービスのプライマリ バージョンよりも低いバージョンにする必要があります。キーは補助サービス名であり、正規表現 a-z? に一致する必要があります。つまり、最初の文字は小文字にする必要があり、その後の文字はすべてハイフン、小文字、数字にする必要があります。ただし、最後の文字はハイフンにできません。
|
KerberosConfig
Kerberos プリンシパルの構成情報。
JSON 表現 |
---|
{
"keytab": {
object ( |
フィールド | |
---|---|
keytab |
Kerberos キー配布センター(KDC)でサービス プリンシパルを認証するために使用できる Kerberos keytab ファイル。 |
principal |
認証する KDC と keytab の両方に存在する Kerberos プリンシパル。一般的なプリンシパルは |
krb5ConfigGcsUri |
krb5.conf ファイルのパスを指定する Cloud Storage URI。形式は |
シークレット
安全に保存された値。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
cloudSecret |
Secret Manager シークレット バージョンの相対リソース名。形式は次のとおりです。
|
EndpointProtocol
metastore サービス エンドポイントの提供に使用できるプロトコル。
列挙型 | |
---|---|
ENDPOINT_PROTOCOL_UNSPECIFIED |
プロトコルが設定されていません。 |
THRIFT |
metastore サービス エンドポイントに、以前の Apache Thrift プロトコルを使用します。 |
GRPC |
metastore サービス エンドポイントにモダナイズ済みの gRPC プロトコルを使用してください。 |
AuxiliaryVersionConfig
補助サービス バージョンの構成情報。
JSON 表現 |
---|
{
"version": string,
"configOverrides": {
string: string,
...
},
"networkConfig": {
object ( |
フィールド | |
---|---|
version |
補助サービスの Hive メタストア バージョン。プライマリ Hive メタストア サービスのバージョンより小さい値にする必要があります。 |
configOverrides |
プライマリ バージョンのオーバーライドに加えて、補助 Hive メタストア(
|
networkConfig |
出力専用。ネットワーク構成には、補助 Hive メタストア サービスのエンドポイント URI が含まれています。 |
NetworkConfig
Dataproc Metastore サービスのネットワーク構成。
JSON 表現 |
---|
{
"consumers": [
{
object ( |
フィールド | |
---|---|
consumers[] |
変更不可。Dataproc Metastore インスタンスのコンシューマ側のネットワーク構成。 |
customRoutesEnabled |
Dataproc Metastore サービスのピアリングされた VPC ネットワークのカスタムルートのインポートとエクスポートを有効にします。 |
コンシューマー
お客様のネットワーク構成に関する情報が含まれています。
JSON 表現 |
---|
{ "endpointUri": string, "endpointLocation": string, // Union field |
フィールド | |
---|---|
endpointUri |
出力専用。Metastore サービスへのアクセスに使用されるエンドポイントの URI。 |
endpointLocation |
出力専用。エンドポイント URI のロケーション。形式: |
共用体フィールド
|
|
subnetwork |
変更不可。IP アドレスが予約され、Dataproc Metastore サービスのエンドポイントとして使用される、お客様のプロジェクトのサブネット。サブネット内のホストと、同じリージョンと同じネットワークのサブネット内のすべてのホストからアクセスできます。サブネットのプライマリ範囲で使用可能な IP アドレスが 1 つ以上必要です。サブネットは次の形式で指定します。
|
州
メタストア サービスの現在の状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
メタストア サービスの状態は不明です。 |
CREATING |
Metastore サービスは作成中です。 |
ACTIVE |
Metastore サービスが実行され、クエリを処理する準備が整っています。 |
SUSPENDING |
メタストア サービスが一時停止状態になります。クエリ処理の可用性が予期せず停止する可能性があります。 |
SUSPENDED |
Metastore サービスが停止しているため、クエリを処理できません。 |
UPDATING |
Metastore サービスが更新されています。引き続き使用できますが、現時点では追加の更新リクエストを受け入れたり、削除したりすることはできません。 |
DELETING |
Metastore サービスが削除中です。使用できません。 |
ERROR |
Metastore サービスでエラーが発生したため、使用できません。Metastore サービスは削除する必要があります。 |
AUTOSCALING |
Dataproc Metastore サービス 2 がスケールアップまたはスケールダウンされています。 |
MIGRATING |
Metastore サービスがマネージド移行を処理しています。 |
階層
利用可能なサービス階層。
列挙型 | |
---|---|
TIER_UNSPECIFIED |
ティアが設定されていません。 |
DEVELOPER |
デベロッパー ティアでは、拡張性に制限があり、フォールト トレラントもありません。低コストの概念実証に適しています。 |
ENTERPRISE |
エンタープライズ ティアはマルチゾーンの高可用性を備えており、エンタープライズ レベルの Dataproc Metastore ワークロード向けに十分な拡張性があります。 |
MetadataIntegration
メタストアのメタデータを外部サービスと統合する方法を指定する。
JSON 表現 |
---|
{ "dataCatalogConfig": { object ( |
フィールド | |
---|---|
dataCatalogConfig |
省略可。Data Catalog サービスのインテグレーション構成。 |
dataplexConfig |
Dataplex サービスのインテグレーション構成。 |
DataCatalogConfig
Metastore メタデータを Data Catalog サービスと統合する方法を指定する。
JSON 表現 |
---|
{ "enabled": boolean } |
フィールド | |
---|---|
enabled |
省略可。Metastore メタデータを Data Catalog に同期するかどうかを定義します。デフォルト値では、Metastore メタデータと Data Catalog の同期が無効になっています。 |
DataplexConfig
Metastore メタデータを Dataplex サービスと統合する方法を指定する。
JSON 表現 |
---|
{
"lakeResources": {
string: {
object ( |
フィールド | |
---|---|
lakeResources |
この Metastore サービスが接続されている Lake リソースへの参照。キーはレイク リソース名です。例:
|
レイク
Lake リソースを表します。
JSON 表現 |
---|
{ "name": string } |
フィールド | |
---|---|
name |
Lake リソース名。例: |
MaintenanceWindow
メンテナンスの時間枠。Dataproc Metastore がサービスに対してシステム メンテナンス オペレーションを実行できるタイミングを指定します。
JSON 表現 |
---|
{
"hourOfDay": integer,
"dayOfWeek": enum ( |
フィールド | |
---|---|
hourOfDay |
時間枠の開始時刻(0 ~ 23)。 |
dayOfWeek |
ウィンドウの開始曜日。 |
MetadataManagementActivity
メタストア サービスのメタデータ管理アクティビティ。
JSON 表現 |
---|
{ "metadataExports": [ { object ( |
フィールド | |
---|---|
metadataExports[] |
出力専用。メタストア サービスの最新のメタデータ エクスポート。 |
restores[] |
出力専用。Metastore サービスの最新の復元。 |
MetadataExport
メタデータ エクスポート オペレーションの詳細。
フィールド | |
---|---|
startTime |
出力専用。エクスポートが開始された時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
endTime |
出力専用。エクスポートが終了した日時。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
state |
出力専用。エクスポートの現在のステータス。 |
databaseDumpType |
出力専用。データベース ダンプのタイプ。 |
共用体フィールド
|
|
destinationGcsUri |
出力専用。メタデータがエクスポートされるフォルダの Cloud Storage URI( |
州
メタデータ エクスポートの現在の状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
メタデータのエクスポートの状態は不明です。 |
RUNNING |
メタデータのエクスポートが実行中です。 |
SUCCEEDED |
メタデータのエクスポートが正常に完了しました。 |
FAILED |
メタデータのエクスポートに失敗しました。 |
CANCELLED |
メタデータのエクスポートがキャンセルされます。 |
復元
メタデータ復元オペレーションの詳細。
JSON 表現 |
---|
{ "startTime": string, "endTime": string, "state": enum ( |
フィールド | |
---|---|
startTime |
出力専用。復元が開始された時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
endTime |
出力専用。復元が終了した日時。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
state |
出力専用。復元の現在の状態。 |
backup |
出力専用。復元元のメタストア サービス バックアップの相対リソース名(次の形式)。
|
type |
出力専用。復元のタイプ。 |
details |
出力専用。復元先のサービスのリビジョンを含む復元の詳細(JSON 形式)。 |
backupLocation |
省略可。バックアップ アーティファクトの保存場所を指定する Cloud Storage URI( |
州
復元の現在の状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
メタデータの復元の状態は不明です。 |
RUNNING |
メタデータの復元が実行中です。 |
SUCCEEDED |
メタデータの復元が正常に完了しました。 |
FAILED |
メタデータの復元に失敗しました。 |
CANCELLED |
メタデータの復元がキャンセルされます。 |
RestoreType
復元のタイプ。指定しない場合、デフォルトで METADATA_ONLY
になります。
列挙型 | |
---|---|
RESTORE_TYPE_UNSPECIFIED |
復元タイプが不明です。 |
FULL |
サービスのメタデータと構成が復元されます。 |
METADATA_ONLY |
サービスのメタデータのみが復元されます。 |
ReleaseChannel
リリース チャンネルは、安定性のレベルが異なる機能をバンドルします。新しい機能は、最初は安定性の低いリリース チャンネルに導入され、より安定したリリース チャンネルに自動的に昇格される場合があります。
列挙型 | |
---|---|
RELEASE_CHANNEL_UNSPECIFIED |
リリース チャンネルが指定されていません。 |
CANARY |
CANARY リリース チャンネルには最新の機能が含まれていますが、安定しておらず、既知の回避策のない未解決の問題が存在する可能性があります。CANARY リリース チャンネルを使用するサービスは、SLA の対象ではありません。 |
STABLE |
STABLE リリース チャンネルには、安定していると見なされ、さらに本番環境での使用が検証された機能が含まれています。 |
EncryptionConfig
サービスの暗号化設定。
JSON 表現 |
---|
{ "kmsKey": string } |
フィールド | |
---|---|
kmsKey |
お客様データの暗号化に使用する、お客様が指定した Cloud KMS 鍵の完全修飾名(次の形式)。
|
DatabaseType
Metastore サービスのバックエンド データベース タイプ。
列挙型 | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
DATABASE_TYPE が設定されていません。 |
MYSQL |
MySQL は、メタストア データの永続化に使用されます。 |
SPANNER |
Spanner は、メタストア データを保持するために使用されます。 |
TelemetryConfig
Dataproc Metastore サービスのテレメトリー構成。
JSON 表現 |
---|
{
"logFormat": enum ( |
フィールド | |
---|---|
logFormat |
Dataproc Metastore サービスのログの出力形式。 |
LogFormat
列挙型 | |
---|---|
LOG_FORMAT_UNSPECIFIED |
LOG_FORMAT が設定されていません。 |
LEGACY |
ロギング出力では、従来の textPayload 形式が使用されます。 |
JSON |
ロギング出力は jsonPayload 形式を使用します。 |
ScalingConfig
メタストア サービスのスケーリング構成を表します。
JSON 表現 |
---|
{ "autoscalingConfig": { object ( |
フィールド | |
---|---|
autoscalingConfig |
省略可。自動スケーリングの構成。 |
共用体フィールド scaling_model 。事前定義されたインスタンス サイズまたは数値スケーリング係数を表します。scaling_model は次のいずれかになります。 |
|
instanceSize |
読み取り可能なインスタンスサイズの列挙型。各インスタンスサイズは浮動小数点値にマッピングされます(例: InstanceSize.EXTRA_SMALL = scalingFactor(0.1))。 |
scalingFactor |
スケーリング係数。1.0 未満の値の場合は 0.1 ずつ、1.0 を超える値の場合は 1.0 ずつ増分します。 |
InstanceSize
メタストア インスタンスのサイズ。
列挙型 | |
---|---|
INSTANCE_SIZE_UNSPECIFIED |
インスタンス サイズ未指定 |
EXTRA_SMALL |
エクストラ スモール インスタンス サイズ。スケーリング ファクタは 0.1 です。 |
SMALL |
小さいインスタンス サイズ。スケーリング係数は 0.5 です。 |
MEDIUM |
中程度のインスタンスサイズ。スケーリング係数は 1.0 です。 |
LARGE |
大規模なインスタンス サイズは、スケーリング係数 3.0 にマッピングされます。 |
EXTRA_LARGE |
エクストララージ インスタンス サイズ。スケーリング係数は 6.0 です。 |
AutoscalingConfig
Metastore サービスの自動スケーリング構成を表します。
JSON 表現 |
---|
{
"autoscalingFactor": number,
"autoscalingEnabled": boolean,
"limitConfig": {
object ( |
フィールド | |
---|---|
autoscalingFactor |
出力専用。自動スケーリングが有効なサービスのスケーリング係数。 |
autoscalingEnabled |
省略可。このサービスで自動スケーリングが有効かどうか。 |
limitConfig |
省略可。サービスの LimitConfig。 |
LimitConfig
Metastore サービスの自動スケーリングの上限構成を表します。
JSON 表現 |
---|
{ "maxScalingFactor": number, "minScalingFactor": number } |
フィールド | |
---|---|
maxScalingFactor |
省略可。サービスが自動スケーリングされる最大スケーリング係数。 |
minScalingFactor |
省略可。サービスを自動スケーリングする最小スケーリング ファクタ。 |
MultiRegionConfig
Dataproc Metastore サービスのマルチリージョン構成。
JSON 表現 |
---|
{ "certificates": [ { object ( |
フィールド | |
---|---|
certificates[] |
出力専用。gRPC クライアントがマルチリージョンの Dataproc Metastore サービスへの接続に使用するルート CA 証明書のリスト。 |
customRegionConfig |
|
RootCACertificate
gRPC クライアントは、マルチリージョンの Dataproc Metastore サービスに接続してフェイルオーバーを実現するために、すべてのルート CA 証明書をインストールする必要があります。
JSON 表現 |
---|
{ "certificate": string, "expirationTime": string } |
フィールド | |
---|---|
certificate |
PEM 形式のルート CA 証明書。最大長は 65,536 バイトです。 |
expirationTime |
証明書の有効期限(タイムスタンプ形式)。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
CustomRegionConfig
Metastore サービスが実行されるリージョンを指定するのに使用されるカスタム構成。現在、us
マルチリージョンでのみサポートされています。
JSON 表現 |
---|
{ "readWriteRegions": [ string ], "readOnlyRegions": [ string ] } |
フィールド | |
---|---|
readWriteRegions[] |
必須。Metastore サービスが実行される読み取り / 書き込みリージョンのリスト。これらのリージョンは、マルチリージョンの一部(またはサブセット)である必要があります。 |
readOnlyRegions[] |
省略可。Metastore サービスが実行される読み取り専用リージョンのリスト。これらのリージョンは、マルチリージョンの一部(またはサブセット)である必要があります。 |
ScheduledBackup
スケジュール設定されたバックアップの構成を指定します。
JSON 表現 |
---|
{
"enabled": boolean,
"cronSchedule": string,
"timeZone": string,
"nextScheduledTime": string,
"backupLocation": string,
"latestBackup": {
object ( |
フィールド | |
---|---|
enabled |
省略可。スケジュール設定されたバックアップが有効かどうかを定義します。デフォルト値は false です。 |
cronSchedule |
省略可。Cron 形式のスケジュール間隔。https://en.wikipedia.org/wiki/Cron を参照。デフォルトは空です。スケジュール設定されたバックアップは有効になりません。スケジュール設定されたバックアップを有効にするには指定する必要があります。 |
timeZone |
省略可。cronSchedule の解釈に使用するタイムゾーンを指定します。タイムゾーン データベース(https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)のタイムゾーン名(例: America/Los_Angeles、Africa/Abidjan)にする必要があります。指定しない場合、デフォルトは UTC です。 |
nextScheduledTime |
出力専用。次のバックアップ実行が開始されるスケジュールされた時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
backupLocation |
省略可。フォルダの Cloud Storage URI( |
latestBackup |
出力専用。最新のスケジュール設定されたバックアップの詳細。 |
LatestBackup
最新のスケジュール設定されたバックアップの詳細。
JSON 表現 |
---|
{
"backupId": string,
"startTime": string,
"state": enum ( |
フィールド | |
---|---|
backupId |
出力専用。進行中のスケジュール設定されたバックアップの ID。バックアップが進行中でない場合は空になります。 |
startTime |
出力専用。バックアップが開始された日時。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
state |
出力専用。バックアップの現在の状態。 |
duration |
出力専用。バックアップの完了時間。
|
州
バックアップの現在の状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
バックアップの状態は不明です。 |
IN_PROGRESS |
バックアップは進行中です。 |
SUCCEEDED |
バックアップが完了しました。 |
FAILED |
バックアップに失敗しました。 |
メソッド |
|
---|---|
|
メタデータ リソースのロケーションを変更します。 |
|
メタデータ テーブルのプロパティを変更します。 |
|
進行中のマネージド移行プロセスをキャンセルします。 |
|
マネージド移行プロセスが完了します。 |
|
プロジェクトとロケーションにメタストア サービスを作成します。 |
|
単一のサービスを削除します。 |
|
サービスからメタデータをエクスポートします。 |
|
1 つのサービスの詳細を取得します。 |
|
リソースのアクセス制御ポリシーを取得します。 |
|
プロジェクトとロケーションのサービスを一覧表示します。 |
|
テーブルを別のデータベースに移動します。 |
|
単一サービスのパラメータを更新します。 |
|
Dataproc Metastore メタデータに対してクエリを実行します。 |
|
リソースに適用されている IAM ポリシーを削除します。 |
|
バックアップからサービスを復元します。 |
|
指定したリソースにアクセス制御ポリシーを設定します。 |
|
マネージド移行プロセスを開始します。 |
|
指定したリソースに対して呼び出し元が持っている権限を返します。 |