Package google.cloud.metastore.v1beta

string

這是必要旗標，要修改中繼資料的中繼資料儲存庫服務的相對資源名稱，格式如下：

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 中繼儲存庫設定鍵/值組合的對應關係。如果輔助版本的覆寫值和主要版本的覆寫值都包含鍵，則輔助版本的覆寫值優先。

NetworkConfig

僅供輸出。網路設定包含輔助 Hive 中繼儲存庫服務的端點 URI。

string

要聯結的中繼存放區的相對資源名稱。以下列出目前支援的中介資料儲存庫的相對資源名稱格式：

• BigQuery
  • projects/{project_id}
• Dataproc 中繼存放區
  • 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

這是必要旗標，要取消遷移至的相對 Metastore 服務資源名稱，格式如下：

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

這是必要旗標，要完成遷移的 Metastore 服務相對資源名稱，格式如下：

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 個半形字元之間，開頭須為英文字母，結尾則須為英文字母或數字，而且只能使用英數字元或連字號。

Backup

這是必要旗標，要建立的備份。系統會忽略 name 欄位。建立備份的 ID 必須在要求的 backup_id 欄位中提供。

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

string

這是必要旗標，要建立聯合服務的位置的相對資源名稱，格式如下：

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

授權需要指定資源 parent 的下列 IAM 權限：

• metastore.federations.create

string

這是必要旗標，元資料存放區聯盟的 ID，用於元資料存放區聯盟名稱的最終元件。

這個值的長度必須介於 2 至 63 個半形字元之間 (含)，開頭須為英文字母，結尾須為英文字母或數字，且只能使用英數字元或連字號。

Federation

這是必要旗標，要建立的中繼存放區聯盟。系統會忽略 name 欄位。建立的元資料庫聯集 ID 必須在要求的 federation_id 欄位中提供。

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

string

這是必要旗標，要建立 Metastore 匯入作業的服務相對資源名稱，格式如下：

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

授權需要指定資源 parent 的下列 IAM 權限：

• metastore.imports.create

string

這是必要旗標，中繼資料匯入 ID，用於中繼資料匯入名稱的最終組成部分。

這個值的長度必須介於 1 至 64 個半形字元之間，開頭須為英文字母，結尾則須為英文字母或數字，而且只能使用英數字元或連字號。

MetadataImport

這是必要旗標，要匯入的中繼資料。系統會忽略 name 欄位。您必須在要求的 metadata_import_id 欄位中提供已建立的中繼資料匯入作業 ID。

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

string

這是必要旗標，建立 Metastore 服務的位置的相對資源名稱，格式如下：

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

授權需要指定資源 parent 的下列 IAM 權限：

• metastore.services.create

string

這是必要旗標，Metastore 服務的 ID，用於 Metastore 服務名稱的最終元件。

這個值的長度必須介於 2 至 63 個半形字元之間 (含)，開頭須為英文字母，結尾須為英文字母或數字，且只能使用英數字元或連字號。

Service

這是必要旗標，要建立的 Metastore 服務。系統會忽略 name 欄位。建立的 Metastore 服務 ID 必須在要求的 service_id 欄位中提供。

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

bool

(非必要) 定義是否應將中繼資料中繼資料同步至 Data Catalog。預設值會停用將中繼資料中繼資料同步至 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 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

string

這是必要旗標，要刪除的中繼存放區聯合體的相對資源名稱，格式如下：

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

授權需要指定資源 name 的下列 IAM 權限：

• metastore.federations.delete

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

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 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

string

這是必要旗標，要刪除的 Metastore 服務相對資源名稱，格式如下：

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

授權需要指定資源 name 的下列 IAM 權限：

• metastore.services.delete

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

string

客戶提供的完整 Cloud KMS 金鑰名稱，用於加密客戶資料，格式如下：

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

map<string, string>

這個錯誤的其他結構化詳細資料。

鍵會定義失敗項目。值會說明項目的例外狀況或詳細資料。

string

這是必要旗標，要執行匯出的 Metastore 服務的相對資源名稱，格式如下：

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

授權需要指定資源 service 的下列 IAM 權限：

• metastore.services.export

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 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 以解析資料庫名稱的順序，且應大於或等於零。編號較小的 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

這是必要旗標，要擷取的 Metastore 服務相對資源名稱，格式如下：

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

授權需要指定資源 name 的下列 IAM 權限：

• metastore.services.get

string

不可變動。Hive 中繼存放區結構定義版本。

map<string, string>

將套用至 Hive metastore 的 Hive metastore 設定鍵/值組合對應關係 (在 hive-site.xml 中設定)。對應關係會覆寫系統預設值 (部分鍵無法覆寫)。這些覆寫值也會套用至輔助版本，並可在輔助版本的 AuxiliaryVersionConfig 中進一步自訂。

KerberosConfig

用於將 Hive 中繼存放區服務設為 Kerberos 領域中的服務主體。如要停用 Kerberos，請使用 UpdateService 方法，並在要求的 update_mask 中指定此欄位的路徑 (hive_metastore_config.kerberos_config)，同時在要求的 service 中略過此欄位。

EndpointProtocol

要用於 Metastore 服務端點的通訊協定。如未指定，則預設為 THRIFT。

map<string, AuxiliaryVersionConfig>

將 Hive 中繼儲存庫版本對應至輔助版本設定。如有指定，建立主要服務時就會一併建立次要 Hive 中繼儲存庫服務。所有輔助版本都必須低於服務的主要版本。鍵是輔助服務名稱，且必須符合規則運算式 a-z?。也就是說，第一個字元必須是小寫英文字母，後續的所有字元則須由連字號、小寫英文字母或數字組成，但最後一個字元不得為連字號。

Secret

Kerberos 鍵值檔案，可用於透過 Kerberos 金鑰發布中心 (KDC) 驗證服務主體。

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 個備份。許可的最大值為 1000；超出的數值將一律指定為 1000。

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 項服務。許可的最大值為 1000；超出的數值將一律指定為 1000。

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 個匯入項目。許可的最大值為 1000；超出的數值將一律指定為 1000。

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 次遷移執行作業。許可的最大值為 1000；超出的數值將一律指定為 1000。

string

(非必要) 屬於接收自前一個 DataprocMetastore.ListMigrationExecutions 呼叫的網頁權杖。提供此符記即可擷取後續網頁。

如要擷取第一頁，請提供空白的頁面符記。

進行分頁時，提供至 DataprocMetastore.ListMigrationExecutions 的其他參數須與提供網頁權杖的呼叫相符。

string

(非必要) 套用至清單結果的篩選器。

string

(非必要) 請按照「排序順序」一節所述，指定結果的排序順序。如果未指定，結果會依預設順序排序。

MigrationExecution

指定服務上的遷移執行作業。

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

string

無法抵達的位置。

string

這是必要旗標，要列出的 Metastore 服務位置的相對資源名稱，格式如下：

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

授權需要指定資源 parent 的下列 IAM 權限：

• metastore.services.list

int32

(非必要) 要傳回的服務數量上限。回應中可能包含的數量少於上限。如未指定，最多會傳回 500 項服務。許可的最大值為 1000；超出的數值將一律指定為 1000。

string

(非必要) 屬於接收自前一個 DataprocMetastore.ListServices 呼叫的網頁權杖。提供此符記即可擷取後續網頁。

如要擷取第一頁，請提供空白的頁面符記。

進行分頁時，提供至 DataprocMetastore.ListServices 的其他參數須與提供網頁權杖的呼叫相符。

string

(非必要) 套用至清單結果的篩選器。

string

(非必要) 請按照「排序順序」一節所述，指定結果的排序順序。如果未指定，結果會依預設順序排序。

Service

指定位置的服務。

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

string

無法抵達的位置。

HiveMetastoreVersion

在這個位置建立新中繼存放區服務時，可使用的 Hive Metastore 版本。伺服器可保證清單中只有一個 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

僅供輸出。Metastore 服務的最新中繼資料匯出內容。

Restore

僅供輸出。Metastore 服務的最新還原作業。

string

僅供輸出。遷移執行作業的相對資源名稱，格式如下：projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}

Timestamp

僅供輸出。開始執行遷移作業的時間。

Timestamp

僅供輸出。遷移執行作業完成的時間。

State

僅供輸出。遷移作業目前的執行狀態。

Phase

僅供輸出。遷移作業目前的執行階段。

string

僅供輸出。遷移執行作業目前狀態的其他資訊。

CloudSQLMigrationConfig

針對從 Google Cloud 中的自行管理 Hive 中繼存放區 (使用 Cloud SQL 做為後端資料庫) 遷移至 Dataproc Metastore 的特定設定資訊。

CdcConfig

這是必要旗標，此設定資訊是用於啟動從客戶資料庫到 Dataproc Metastore 後端資料庫的變更資料擷取 (CDC) 串流。在遷移作業的轉換階段結束後，Dataproc Metastore 會改用自己的後端資料庫。

CloudSQLConnectionConfig

這是必要旗標，在遷移的轉換階段前，用於建立客戶資料庫連線的設定資訊

string

這是必要旗標，Cloud SQL 執行個體虛擬私有雲網路或 Datastream 要對接的共用虛擬私有雲網路的完整名稱，格式如下：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

這是必要旗標，子網路資源網址，該資源可用來建立託管反向 Proxy 的 VM 執行個體。如需更多背景資訊，請參閱 https://cloud.google.com/datastream/docs/private-connectivity#reverse-csql-proxy。子網路應位於 Datastream 要進行對接的要求所提供的網路，且應與 Datastream 位於相同區域，格式如下。projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}

string

(非必要) 用來寫入中繼串流事件資料的 bucket。bucket 名稱不得包含前置字串，例如「gs://」。請參閱值區命名規定。這是選填欄位。如未設定，系統會使用 Artifacts Cloud Storage bucket。

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 Proxy 服務的子網路相對資源名稱。子網路應位於可存取 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 Proxy 服務。子網路大小至少須為 /29，且應位於可存取 Cloud SQL 執行個體的網路中。資源名稱的格式應為 projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}

string

這是必要旗標，要修改中繼資料的中繼資料儲存庫服務的相對資源名稱，格式如下：

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

授權需要指定資源 service 的下列 IAM 權限：

• metastore.services.mutateMetadata

string

這是必要旗標，要移動的資料表名稱。

string

這是必要旗標，資料表所在資料庫的名稱。

string

這是必要旗標，資料表應移至的資料庫名稱。

RootCACertificate

僅供輸出。gRPC 用戶端用來連線至多區域 Dataproc Metastore 服務的根憑證授權單位憑證清單。

CustomRegionConfig

string

這是必要旗標，執行元資料庫服務的讀寫區域清單。這些區域應是多區域的一部分 (或子集)。

string

(非必要) 執行 Metastore 服務的唯讀區域清單。這些區域應是多區域的一部分 (或子集)。

string

PEM 格式的根 CA 憑證。長度上限為 65536 個位元組。

Timestamp

憑證到期時間 (以時間戳記格式表示)。

Consumer

不可變動。Dataproc Metastore 執行個體的使用者端網路設定。

bool

可讓您為 Dataproc Metastore 服務的對等虛擬私有雲網路匯入及匯出自訂路徑。

string

僅供輸出。用於存取中繼存放區服務的端點 URI。

string

僅供輸出。端點 URI 的位置。格式：projects/{project}/locations/{location}。

string

不可變動。客戶專案的子網路，系統會從中預留 IP 位址，並用於做為 Dataproc Metastore 服務的端點。子網路中的主機和同區域和同網路中所有子網路的主機都可以存取。子網路的主要範圍中至少必須有一個可用的 IP 位址。子網路的格式如下：

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

Timestamp

僅供輸出。作業的建立時間。

Timestamp

僅供輸出。作業完成的時間。

string

僅供輸出。作業目標的伺服器定義資源路徑。

string

僅供輸出。作業執行的動詞名稱。

string

僅供輸出。作業的狀態 (如果有)，以人類可讀的方式呈現。

bool

僅供輸出。判斷呼叫端是否已要求取消作業。已成功取消的作業會具有 [Operation.error][] 值，且 google.rpc.Status.code 為 1 (也就是 Code.CANCELLED)。

string

僅供輸出。用於啟動作業的 API 版本。

string

這是必要旗標，查詢中繼資料的中繼資料服務相對資源名稱，格式如下：

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

僅供輸出。要從中還原的 Metastore 服務備份的相對資源名稱，格式如下：

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

這是必要旗標，要執行還原作業的 Metastore 服務相對資源名稱，格式如下：

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

授權需要指定資源 service 的下列 IAM 權限：

• metastore.services.restore

string

(非必要) 要從中還原的 Metastore 服務備份的相對資源名稱，格式如下：

projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}：與 backup_location 互斥，必須設定其中一個。

授權需要指定資源 backup 的下列 IAM 權限：

• metastore.backups.use

string

(非必要) 指定備份構件位置的 Cloud Storage URI，也就是「avro/」底下的備份 avro 檔案、backup_metastore.json 和 service.json，格式如下：

gs://<path_to_backup>：與 backup 互斥，必須設定其中一個。

RestoreType

(非必要) 還原類型。如未指定，則預設為 METADATA_ONLY。

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-000000000000)。

AutoscalingConfig

(非必要) 自動調度資源設定。

InstanceSize

可讀取的執行個體大小列舉，其中每個執行個體大小會對應至浮點值 (例如 InstanceSize.EXTRA_SMALL = scaling_factor(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。如果未指定，預設值為世界標準時間。

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

不可變動。Metastore 服務的相對資源名稱，格式如下：

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

Timestamp

僅供輸出。建立 metastore 服務的時間。

Timestamp

僅供輸出。上次更新中繼資料服務的時間。

map<string, string>

metastore 服務的使用者定義標籤。

string

不可變動。可存取執行個體的虛擬私人雲端網路相對資源名稱。其格式如下：

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

string

僅供輸出。用於存取中繼存放區服務的端點 URI。

int32

中繼存放區服務的 TCP 通訊埠。預設值：9083。

State

僅供輸出。metastore 服務目前的狀態。

string

僅供輸出。與 metastore 服務目前狀態相關的其他資訊 (如有)。

string

僅供輸出。Cloud Storage URI (以 gs:// 開頭)，用於指定與元資料庫服務相關的構件儲存位置。

Tier

服務級別。

MetadataIntegration

(非必要) 這個設定會定義 metastore 中繼資料應如何與外部服務和系統整合。

MaintenanceWindow

Metastore 服務的 1 小時維護期間。這項屬性會以世界標準時間指定服務可重新啟動以進行維護的時間。使用 SPANNER 資料庫類型的服務不需要維護時間。

string

僅供輸出。元資料庫服務的全域專屬資源 ID。

MetadataManagementActivity

僅供輸出。metastore 服務的中繼資料管理活動。

ReleaseChannel

不可變動。服務的發布版本。如未指定，則預設為 STABLE。

EncryptionConfig

不可變動。用於設定 Dataproc Metastore 服務，以便加密客戶的靜態資料。設定完成後即無法更新。

NetworkConfig

指定 Dataproc Metastore 服務的網路設定。

DatabaseType

不可變動。Metastore 服務儲存資料的資料庫類型。

TelemetryConfig

指定 Dataproc Metastore 服務遙測設定的設定。如未指定，則預設為 JSON。

ScalingConfig

metastore 服務的資源調度設定。

MultiRegionConfig

(非必要) 指定 Hive 中繼儲存庫服務的多地區設定資訊。

ScheduledBackup

(非必要) 中繼資料服務的排定備份設定。

bool

(非必要) 指出是否應保護 Dataproc 元資料庫，以免發生意外刪除。

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 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

LogFormat

Dataproc Metastore 服務記錄的輸出格式。

FieldMask

這是必要旗標，欄位遮罩用於指定更新時在中繼資料庫聯合資源中要覆寫的欄位。update_mask 中指定的欄位是相對於資源 (而非整個要求)。如果欄位位於遮罩中，就會遭到覆寫。

Federation

這是必要旗標，要更新的中繼資料集聯盟。只有在 update_mask 中指定服務中的欄位時，伺服器才會合併這些欄位。

Metastore 聯合體的 name 欄位可用於識別要更新的 Metastore 服務。

授權需要指定資源 federation 的下列 IAM 權限：

• metastore.federations.update

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

FieldMask

這是必要旗標，欄位遮罩，用於指定更新時要在中繼資料匯入資源中覆寫的欄位。update_mask 中指定的欄位是相對於資源 (而非整個要求)。如果欄位位於遮罩中，就會遭到覆寫。

MetadataImport

這是必要旗標，要更新的中繼資料匯入作業。只有在 update_mask 中指定匯入的欄位時，伺服器才會合併這些欄位。

中繼資料匯入作業的 name 欄位可用於識別要更新的中繼資料庫匯入作業。

授權需要指定資源 metadataImport 的下列 IAM 權限：

• metastore.imports.update

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

FieldMask

這是必要旗標，欄位遮罩用於指定更新作業在 metastore 服務資源中覆寫的欄位。update_mask 中指定的欄位是相對於資源 (而非整個要求)。如果欄位位於遮罩中，就會遭到覆寫。

Service

這是必要旗標，要更新的 Metastore 服務。只有在 update_mask 中指定服務中的欄位時，伺服器才會合併這些欄位。

Metastore 服務的 name 欄位可用來識別要更新的 Metastore 服務。

授權需要指定資源 service 的下列 IAM 權限：

• metastore.services.update

string

(非必要) 要求 ID。指定專屬要求 ID，讓伺服器在要求完成後忽略該要求。在第一個要求後的 60 分鐘內，伺服器會忽略提供重複要求 ID 的後續要求。

舉例來說，如果初始要求逾時，接著出現另一個使用相同要求 ID 的要求，伺服器會忽略第二個要求，以免建立重複的承諾。

要求 ID 必須是有效的 UUID。系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。