• 首頁
• 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 所需的鏈式賬號列表，該賬號將在請求中被模擬。如果設定為字串，該賬號必須授予原始賬號 Service Account Token Creator IAM 角色。如果設定為序列，列表中的身份必須將其直接前一個身份授予 Service Account Token Creator 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) – 必需。要建立的條目。如果提供字典，其形式必須與 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) –

  要建立的條目組。預設為一個空的條目組。

  如果提供字典，其形式必須與 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) – 必需。要建立的標籤。如果提供字典，其形式必須與 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) –

  必需。要建立的標籤模板。

  如果提供字典，其形式必須與 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) –

  必需。要建立的標籤模板欄位。

  如果提供字典，其形式必須與 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=())

列出 Entry 上的標籤。

引數:

• 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”欄位必須設定。

  如果提供字典，其形式必須與 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) –

  必需。要更新的標籤模板欄位。

  如果提供字典，其形式必須與 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]]) – 提供給方法的附加元資料。

上一頁 下一頁

此條目是否有用？