• 首頁
• airflow.providers.google
• airflow.providers.google.cloud
• airflow.providers.google.cloud.hooks
• airflow.providers.google.cloud.hooks.datacatalog

airflow.providers.google.cloud.hooks.datacatalog

模組內容

類別

CloudDataCatalogHook

用於 Google Cloud Data Catalog 服務的 Hook。

class airflow.providers.google.cloud.hooks.datacatalog.CloudDataCatalogHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)

基底類別： airflow.providers.google.common.hooks.base_google.GoogleBaseHook

用於 Google Cloud Data Catalog 服務的 Hook。

參數

• gcp_conn_id (str) – 取得連線資訊時使用的連線 ID。

• impersonation_chain (str | collections.abc.Sequence[str] | None) – 選填的服務帳戶，用於模擬短期憑證，或用於取得清單中最後一個帳戶的 access_token 的鏈結帳戶清單，該帳戶將在請求中被模擬。如果設定為字串，則該帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，清單中的第一個帳戶將此角色授予原始帳戶。

get_conn()

檢索允許存取 Cloud Data Catalog 服務的用戶端程式庫物件。

create_entry(location, entry_group, entry_id, entry, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

建立項目。

目前僅能建立 ‘FILESET’ 類型的項目。

參數

• location (str) – 必填。要建立項目的位置。

• entry_group (str) – 必填。建立項目所屬的項目群組 ID。

• entry_id (str) – 必填。要建立的項目 ID。

• entry (dict | google.cloud.datacatalog.Entry) – 必填。要建立的項目。如果提供 dict，則其格式必須與 protobuf 訊息 Entry 相同

• project_id (str) – 擁有項目的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果設定為 None 或遺失，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

create_entry_group(location, entry_group_id, entry_group, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

建立 EntryGroup。

參數

• location (str) – 必填。要建立的項目群組位置。

• entry_group_id (str) – 必填。要建立的項目群組 ID。ID 必須以字母或底線開頭，僅包含英文字母、數字和底線，且長度最多為 64 個字元。

• entry_group (dict | google.cloud.datacatalog.EntryGroup) –

  要建立的項目群組。預設為空白項目群組。

  如果提供 dict，則其格式必須與 protobuf 訊息 EntryGroup 相同

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

create_tag(location, entry_group, entry, tag, project_id=PROVIDE_PROJECT_ID, template_id=None, retry=DEFAULT, timeout=None, metadata=())

在項目上建立標籤。

參數

• location (str) – 必填。要建立標籤的位置。

• entry_group (str) – 必填。建立標籤所屬的項目群組 ID。

• entry (str) – 必填。建立標籤所屬的項目群組 ID。

• tag (dict | google.cloud.datacatalog.Tag) – 必填。要建立的標籤。如果提供 dict，則其格式必須與 protobuf 訊息 Tag 相同

• template_id (str | None) – 必填。用於建立標籤的範本 ID

• project_id (str) – 擁有標籤的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

create_tag_template(location, tag_template_id, tag_template, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

建立標籤範本。

參數

• location – 必填。要建立的標籤範本位置。

• tag_template_id (str) – 必填。要建立的標籤範本 ID。

• tag_template (dict | google.cloud.datacatalog.TagTemplate) –

  必填。要建立的標籤範本。

  如果提供 dict，則其格式必須與 protobuf 訊息 TagTemplate 相同

• project_id (str) – 擁有標籤範本的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

create_tag_template_field(location, tag_template, tag_template_field_id, tag_template_field, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

在標籤範本中建立欄位。

參數

• location (str) – 必填。要建立的標籤範本欄位位置。

• tag_template (str) – 必填。要建立的標籤範本 ID。

• tag_template_field_id (str) – 必填。要建立的標籤範本欄位 ID。欄位 ID 可以包含字母（大小寫皆可）、數字 (0-9)、底線 (_) 和破折號 (-)。欄位 ID 的長度必須至少為 1 個字元，最多為 128 個字元。欄位 ID 在其範本中也必須是唯一的。

• tag_template_field (dict | google.cloud.datacatalog.TagTemplateField) –

  必填。要建立的標籤範本欄位。

  如果提供 dict，則其格式必須與 protobuf 訊息 TagTemplateField 相同

• project_id (str) – 擁有標籤範本欄位的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

delete_entry(location, entry_group, entry, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

刪除現有項目。

參數

• location (str) – 必填。要刪除的項目位置。

• entry_group (str) – 必填。要刪除的項目所屬項目群組 ID。

• entry (str) – 要刪除的項目 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

delete_entry_group(location, entry_group, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

刪除 EntryGroup。

僅可刪除不包含項目的項目群組。

參數

• location – 必填。要刪除的項目群組位置。

• entry_group – 要刪除的項目群組 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

delete_tag(location, entry_group, entry, tag, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

刪除標籤。

參數

• location (str) – 必填。要刪除的標籤位置。

• entry_group (str) – 要刪除的標籤所屬項目群組 ID。

• entry (str) – 要刪除的標籤所屬項目 ID。

• tag (str) – 要刪除的標籤識別碼。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

delete_tag_template(location, tag_template, force, project_id, retry=DEFAULT, timeout=None, metadata=())

刪除標籤範本以及所有使用該範本的標籤。

參數

• location – 必填。要刪除的標籤範本位置。

• tag_template – 要刪除的標籤範本 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• force (bool) – 必填。目前，此欄位必須始終設定為 true。這會確認刪除任何可能使用此範本的標籤。force = false 將在未來支援。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

delete_tag_template_field(location, tag_template, field, force, project_id, retry=DEFAULT, timeout=None, metadata=())

刪除標籤範本中的欄位以及該欄位的所有用法。

參數

• location (str) – 必填。要刪除的標籤範本位置。

• tag_template (str) – 要刪除的標籤範本欄位所屬標籤範本 ID。

• field (str) – 要刪除的欄位名稱。

• force (bool) – 必填。這會確認從任何使用此欄位的標籤中刪除此欄位。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

get_entry(location, entry_group, entry, project_id, retry=DEFAULT, timeout=None, metadata=())

取得項目。

參數

• location (str) – 必填。要取得的項目位置。

• entry_group (str) – 必填。要取得的項目所屬項目群組。

• entry (str) – 要取得的項目 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

get_entry_group(location, entry_group, project_id, read_mask=None, retry=DEFAULT, timeout=None, metadata=())

取得條目群組。

參數

• location (str) – 必要參數。要取得之條目群組的位置。

• entry_group (str) – 要取得之條目群組的 ID。

• read_mask (google.protobuf.field_mask_pb2.FieldMask | None) –

  要傳回的欄位。如果未設定或為空，則傳回所有欄位。

  如果提供字典，則其格式必須與 protobuf 訊息 FieldMask 相同

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

get_tag_template(location, tag_template, project_id, retry=DEFAULT, timeout=None, metadata=())

取得標籤範本。

參數

• location (str) – 必要參數。要取得之標籤範本的位置。

• tag_template (str) – 必要參數。要取得之標籤範本的 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

list_tags(location, entry_group, entry, project_id, page_size=100, retry=DEFAULT, timeout=None, metadata=())

列出條目上的標籤。

參數

• location (str) – 必要參數。要取得之標籤的位置。

• entry_group (str) – 必要參數。要取得之標籤的條目群組。

• entry_group – 必要參數。要取得之標籤的條目。

• page_size (int) – 底層 API 回應中包含的資源最大數量。如果每個資源執行分頁串流，則此參數不會影響傳回值。如果每個頁面執行分頁串流，則此參數會決定一個頁面中的資源最大數量。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

get_tag_for_template_name(location, entry_group, entry, template_name, project_id, retry=DEFAULT, timeout=None, metadata=())

取得特定條目中，具有特定範本的標籤。

參數

• location (str) – 必要參數。包含要搜尋條目的位置。

• entry_group (str) – 包含要搜尋條目的條目群組 ID。

• entry (str) – 要搜尋的條目名稱。

• template_name (str) – 將作為搜尋條件的範本名稱。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

lookup_entry(linked_resource=None, sql_resource=None, retry=DEFAULT, timeout=None, metadata=())

依目標資源名稱取得條目。

此方法讓用戶端能使用來源 Google Cloud 服務的資源名稱，來取得 Data Catalog 條目。

參數

• linked_resource (str | None) – Data Catalog 條目所代表的 Google Cloud 資源完整名稱。請參閱：https://cloud.google.com/apis/design/resource_names#full_resource_name。完整名稱區分大小寫。

• sql_resource (str | None) – 條目的 SQL 名稱。SQL 名稱區分大小寫。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

rename_tag_template_field(location, tag_template, field, new_tag_template_field_id, project_id, retry=DEFAULT, timeout=None, metadata=())

重新命名標籤範本中的欄位。

參數

• location (str) – 必要參數。要重新命名之標籤範本欄位的位置。

• tag_template (str) – 重新命名欄位的標籤範本 ID。

• field (str) – 必要參數。此標籤範本欄位的舊 ID。例如，my_old_field。

• new_tag_template_field_id (str) – 必要參數。此標籤範本欄位的新 ID。例如，my_new_field。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

search_catalog(scope, query, page_size=100, order_by=None, retry=DEFAULT, timeout=None, metadata=())

在 Data Catalog 中搜尋符合查詢的多個資源，例如條目、標籤。

這不會傳回完整的資源，僅傳回資源識別碼和高階欄位。用戶端後續可以呼叫 Get 方法。

請注意，搜尋並非完整回溯。可能會有符合您查詢的結果但未傳回，即使在後續的結果頁面中也是如此。這些遺失的結果可能會因重複呼叫搜尋而異。如果您需要保證完整回溯，請勿依賴此方法。

參數

• scope (dict | google.cloud.datacatalog.SearchCatalogRequest.Scope) –

  必要參數。此搜尋要求的範圍。

  如果提供字典，則其格式必須與 protobuf 訊息 Scope 相同

• query (str) –

  必要參數。搜尋查詢語法中的查詢字串。查詢不得為空。

  查詢字串可以像「x」一樣簡單，或更精確地指定為

  • name:x

  • column:x

  • description:y

  注意：查詢符記至少需要 3 個字元，子字串比對才能正確運作。如需更多資訊，請參閱Data Catalog 搜尋語法。

• page_size (int) – 底層 API 回應中包含的資源最大數量。如果每個資源執行分頁串流，則此參數不會影響傳回值。如果每個頁面執行分頁串流，則此參數會決定一個頁面中的資源最大數量。

• order_by (str | None) –

  指定結果的排序方式，目前支援區分大小寫的選項為

  • relevance，僅支援遞減

  • last_access_timestamp [asc|desc]，如果未指定，則預設為遞減

  • last_modified_timestamp [asc|desc]，如果未指定，則預設為遞減

  如果未指定，則預設為 relevance 遞減。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

update_entry(entry, update_mask, project_id, location=None, entry_group=None, entry_id=None, retry=DEFAULT, timeout=None, metadata=())

更新現有的條目。

參數

• entry (dict | google.cloud.datacatalog.Entry) –

  必要參數。已更新的條目。「name」欄位必須設定。

  如果提供字典，則其格式必須與 protobuf 訊息 Entry 相同

• update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

  要在條目上更新的欄位。如果沒有或為空，則會更新所有可修改的欄位。

  如果提供字典，則其格式必須與 protobuf 訊息 FieldMask 相同

• location (str | None) – 必要參數。要更新之條目的位置。

• entry_group (str | None) – 要更新之條目的條目群組 ID。

• entry_id (str | None) – 要更新的條目 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

update_tag(tag, update_mask, project_id, location=None, entry_group=None, entry=None, tag_id=None, retry=DEFAULT, timeout=None, metadata=())

更新現有的標籤。

參數

• tag (dict | google.cloud.datacatalog.Tag) –

  必要參數。已更新的標籤。「name」欄位必須設定。

  如果提供字典，則其格式必須與 protobuf 訊息 Tag 相同

• update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

  要在標籤上更新的欄位。如果沒有或為空，則會更新所有可修改的欄位。目前唯一可修改的欄位是 fields 欄位。

  如果提供字典，則其格式必須與 protobuf 訊息 FieldMask 相同

• location (str | None) – 必要參數。要重新命名之標籤的位置。

• entry_group (str | None) – 要更新之標籤的條目群組 ID。

• entry (str | None) – 要更新之標籤的條目 ID。

• tag_id (str | None) – 要更新的標籤 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

update_tag_template(tag_template, update_mask, project_id, location=None, tag_template_id=None, retry=DEFAULT, timeout=None, metadata=())

更新標籤範本。

此方法不能用於更新範本的欄位。標籤範本欄位以個別資源表示，應使用其各自的建立/更新/刪除方法進行更新。

參數

• tag_template (dict | google.cloud.datacatalog.TagTemplate) –

  必要參數。要更新的範本。「name」欄位必須設定。

  如果提供 dict，則其格式必須與 protobuf 訊息 TagTemplate 相同

• update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

  欄位遮罩指定要覆寫的範本部分。

  如果沒有或為空，則會更新上述所有允許的欄位。

  如果提供字典，則其格式必須與 protobuf 訊息 FieldMask 相同

• location (str | None) – 必要參數。要重新命名之標籤範本的位置。

• tag_template_id (str | None) – 選用參數。要更新之條目的標籤範本 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

update_tag_template_field(tag_template_field, update_mask, project_id, tag_template_field_name=None, location=None, tag_template=None, tag_template_field_id=None, retry=DEFAULT, timeout=None, metadata=())

更新標籤範本中的欄位。此方法不能用於更新欄位類型。

參數

• tag_template_field (dict | google.cloud.datacatalog.TagTemplateField) –

  必要參數。要更新的範本。

  如果提供 dict，則其格式必須與 protobuf 訊息 TagTemplateField 相同

• update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

  欄位遮罩指定要更新的範本部分。允許的欄位

  • display_name

  • type.enum_type

  如果未設定 update_mask 或為空，則會更新上述所有允許的欄位。

  更新列舉類型時，提供的數值將與現有數值合併。因此，只能新增列舉值，現有的列舉值既不能刪除也不能重新命名。

  如果提供字典，則其格式必須與 protobuf 訊息 FieldMask 相同

• tag_template_field_name (str | None) – 選用參數。要重新命名之標籤範本欄位的名稱。

• location (str | None) – 選用參數。要重新命名之標籤的位置。

• tag_template (str | None) – 選用參數。要重新命名之標籤範本欄位的標籤範本 ID。

• tag_template_field_id (str | None) – 選用參數。要重新命名之標籤範本欄位的 ID。

• project_id (str) – 擁有項目群組的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則將使用預設組態重試請求。

• timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

上一頁 下一頁

這個條目是否有幫助？