airflow.providers.google.cloud.hooks.dataplex¶

這個模組包含 Google Dataplex hook。

屬性¶

PATH_DATA_SCAN

異常¶

`AirflowDataQualityScanException`	當資料質量掃描規則失敗時丟擲。
`AirflowDataQualityScanResultTimeoutException`	在指定秒數後未找到結果時丟擲。

類¶

`DataplexHook`	Google Dataplex 的 Hook。
`DataplexAsyncHook`	用於 Google Cloud Dataplex API 的非同步 Hook。

模組內容¶

airflow.providers.google.cloud.hooks.dataplex.PATH_DATA_SCAN = 'projects/{project_id}/locations/{region}/dataScans/{data_scan_id}'[source]¶

exception airflow.providers.google.cloud.hooks.dataplex.AirflowDataQualityScanException[source]¶

繼承自: airflow.exceptions.AirflowException

當資料質量掃描規則失敗時丟擲。

exception airflow.providers.google.cloud.hooks.dataplex.AirflowDataQualityScanResultTimeoutException[source]¶

繼承自: airflow.exceptions.AirflowException

在指定秒數後未找到結果時丟擲。

class airflow.providers.google.cloud.hooks.dataplex.DataplexHook(api_version='v1', gcp_conn_id='google_cloud_default', impersonation_chain=None, location=None, **kwargs)[source]¶

繼承自: airflow.providers.google.common.hooks.base_google.GoogleBaseHook, airflow.providers.google.common.hooks.operation_helpers.OperationHelper

Google Dataplex 的 Hook。

引數:

api_version (str) – 要請求的 API 版本，例如 'v3'。
gcp_conn_id (str) – 獲取連線資訊時使用的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可選的服務賬號，用於使用短期憑據進行模擬，或所需賬號的鏈式列表，以獲取列表中最後一個賬號的 access_token，該 access_token 將在請求中進行模擬。如果設定為字串，則該賬號必須授予原始賬號 Service Account Token Creator IAM 角色。如果設定為序列，則列表中的身份必須將其 Service Account Token Creator IAM 角色授予直接前一個身份，列表中第一個賬號將此角色授予原始賬號（模板化）。

api_version = 'v1'[source]¶

location = None[source]¶

get_dataplex_client()[source]¶

返回 DataplexServiceClient。

get_dataplex_data_scan_client()[source]¶

返回 DataScanServiceClient。

get_dataplex_catalog_client()[source]¶

返回 CatalogServiceClient。

wait_for_operation(operation, timeout=None)[source]¶

等待長時間執行的操作完成。

create_entry(location, entry_id, entry_group_id, entry_configuration, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

建立一個 EntryType 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_id (str) –
必需。Entry 識別符號。它在 Entry Group 中必須是唯一的。對應於 Google Cloud 資源的 Entry 使用基於完整資源名稱的 Entry ID 格式。該格式是資源的完整資源名稱，但去除了完整資源名稱中 API 服務名部分的雙斜槓字首。這允許使用關聯的資源名稱檢索 Entry。

例如，如果資源的完整資源名稱是//library.googleapis.com/shelves/shelf1/books/book2，則建議的 entry_id 是library.googleapis.com/shelves/shelf1/books/book2。

對於對應於 Google Cloud 以外提供者或系統的資源的 Entry，也建議遵循相同的約定。該欄位的最大長度為 4000 個字元。
entry_group_id (str) – 必需。建立的 Entry 所屬的 EntryGroup 資源名稱。
entry_configuration (google.cloud.dataplex_v1.types.Entry | dict) – 必需。Entry 配置主體。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_id, entry_group_id, view=None, aspect_types=None, paths=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取一個 Entry 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_id (str) –
必需。Entry 識別符號。它在 Entry Group 中必須是唯一的。對應於 Google Cloud 資源的 Entry 使用基於完整資源名稱的 Entry ID 格式。該格式是資源的完整資源名稱，但去除了完整資源名稱中 API 服務名部分的雙斜槓字首。這允許使用關聯的資源名稱檢索 Entry。

例如，如果資源的完整資源名稱是//library.googleapis.com/shelves/shelf1/books/book2，則建議的 entry_id 是library.googleapis.com/shelves/shelf1/books/book2。

對於對應於 Google Cloud 以外提供者或系統的資源的 Entry，也建議遵循相同的約定。該欄位的最大長度為 4000 個字元。
entry_group_id (str) – 必需。建立的 Entry 所屬的 EntryGroup 資源名稱。
view (google.cloud.dataplex_v1.types.EntryView | str | None) – 可選。用於控制服務應返回 Entry 的哪些部分的檢視。
aspect_types (collections.abc.MutableSequence[str] | None) – 可選。將返回的 Aspect 限制為提供的 Aspect 型別。僅適用於 CUSTOM 檢視。
paths (collections.abc.MutableSequence[str] | None) – 可選。將返回的 Aspect 限制為 Entry 內與提供的路徑關聯的 Aspect。僅適用於 CUSTOM 檢視。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_id, entry_group_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除一個 AspectType 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_id (str) –
必需。Entry 識別符號。它在 Entry Group 中必須是唯一的。對應於 Google Cloud 資源的 Entry 使用基於完整資源名稱的 Entry ID 格式。該格式是資源的完整資源名稱，但去除了完整資源名稱中 API 服務名部分的雙斜槓字首。這允許使用關聯的資源名稱檢索 Entry。

例如，如果資源的完整資源名稱是//library.googleapis.com/shelves/shelf1/books/book2，則建議的 entry_id 是library.googleapis.com/shelves/shelf1/books/book2。

對於對應於 Google Cloud 以外提供者或系統的資源的 Entry，也建議遵循相同的約定。該欄位的最大長度為 4000 個字元。
entry_group_id (str) – 必需。建立的 Entry 所屬的 EntryGroup 資源名稱。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_entries(location, entry_group_id, filter_by=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

列出特定位置的 Entries 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_group_id (str) – 必需。建立的 Entry 所屬的 EntryGroup 資源名稱。
filter_by (str | None) –
可選。用於篩選要返回的 Entry 的過濾器。過濾器區分大小寫。您可以按以下欄位過濾請求：
- entry_type
- entry_source.display_name
比較運算子為 =, !=, <, >, <=, >=。服務根據字典順序比較字串。您可以在過濾器中使用邏輯運算子 AND, OR, NOT。您可以使用萬用字元 “*”，但對於 entry_type，您需要提供完整的專案 ID 或編號。過濾器表示式示例：
- ”entry_source.display_name=AnExampleDisplayName”
- ”entry_type=projects/example-project/locations/global/entryTypes/example-entry_type”
- ”entry_type=projects/example-project/locations/us/entryTypes/a*
  OR entry_type=projects/another-project/locations/*”
- ”NOT entry_source.display_name=AnotherExampleDisplayName”。
page_size (int | None) – 可選。每頁返回的項數。如果還有剩餘結果，服務會返回一個 next_page_token。如果未指定，服務最多返回 10 個 Entry。最大值為 100；大於 100 的值將被強制轉換為 100。
page_token (str | None) – 可選。從上一個 ListEntries 呼叫接收到的頁面令牌。提供此令牌以檢索下一頁。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_entries(location, query, order_by=None, scope=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

搜尋與給定查詢和範圍匹配的 Entry。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
query (str) – 必需。與範圍內的 Entry 進行匹配的查詢。查詢語法在Dataplex Catalog 的搜尋語法中定義。
order_by (str | None) –
可選。指定結果的排序。支援的值有：
- relevance（預設）
- last_modified_timestamp
- last_modified_timestamp asc
scope (str | None) – 可選。搜尋應在其下執行的範圍。必須是 organizations/<org_id> 或 projects/<project_ref>。如果未指定，則預設為 name 中提供的專案所在的組織。
page_size (int | None) – 可選。每頁返回的項數。如果還有剩餘結果，服務會返回一個 next_page_token。如果未指定，服務最多返回 10 個 Entry。最大值為 100；大於 100 的值將被強制轉換為 100。
page_token (str | None) – 可選。從上一個 ListEntries 呼叫接收到的頁面令牌。提供此令牌以檢索下一頁。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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(location, entry_id, entry_group_id, view=None, aspect_types=None, paths=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

使用源系統上的許可權按名稱查詢單個 Entry。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_id (str) – 必需。Entry 識別符號。它在 Entry Group 中必須是唯一的。對應於 Google Cloud 資源的 Entry 使用基於完整資源名稱的 Entry ID 格式。該格式是資源的完整資源名稱，但去除了完整資源名稱中 API 服務名部分的雙斜槓字首。這允許使用關聯的資源名稱檢索 Entry。例如，如果資源的完整資源名稱是//library.googleapis.com/shelves/shelf1/books/book2，則建議的 entry_id 是library.googleapis.com/shelves/shelf1/books/book2。對於對應於 Google Cloud 以外提供者或系統的資源的 Entry，也建議遵循相同的約定。該欄位的最大長度為 4000 個字元。
entry_group_id (str) – 必需。建立的 Entry 所屬的 EntryGroup 資源名稱。
view (google.cloud.dataplex_v1.types.EntryView | str | None) – 可選。用於控制服務應返回 Entry 的哪些部分的檢視。
aspect_types (collections.abc.MutableSequence[str] | None) – 可選。將返回的 Aspect 限制為提供的 Aspect 型別。僅適用於 CUSTOM 檢視。
paths (collections.abc.MutableSequence[str] | None) – 可選。將返回的 Aspect 限制為 Entry 內與提供的路徑關聯的 Aspect。僅適用於 CUSTOM 檢視。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_entry(location, entry_id, entry_group_id, entry_configuration, allow_missing=False, delete_missing_aspects=False, aspect_keys=None, update_mask=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

更新一個 Entry 資源。

引數:

entry_id (str) – 必需。Entry 識別符號。它在 Entry Group 中必須是唯一的。對應於 Google Cloud 資源的 Entry 使用基於完整資源名稱的 Entry ID 格式。該格式是資源的完整資源名稱，但去除了完整資源名稱中 API 服務名部分的雙斜槓字首。這允許使用關聯的資源名稱檢索 Entry。例如，如果資源的完整資源名稱是//library.googleapis.com/shelves/shelf1/books/book2，則建議的 entry_id 是library.googleapis.com/shelves/shelf1/books/book2。對於對應於 Google Cloud 以外提供者或系統的資源的 Entry，也建議遵循相同的約定。該欄位的最大長度為 4000 個字元。
entry_group_id (str) – 必需。建立的 Entry 所屬的 EntryGroup 資源名稱。
entry_configuration (dict | google.cloud.dataplex_v1.types.Entry) – 必需。更新後的 Entry 配置主體。
location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
update_mask (list[str] | google.protobuf.field_mask_pb2.FieldMask | None) – 可選。要覆蓋 Entry Group 欄位值的欄位名稱。如果此引數不存在或為空，則所有可修改欄位都將被覆蓋。如果請求正文中省略了此類非必需欄位，則其值將為空。
allow_missing (bool | None) – 可選。如果設定為 true 且 Entry 不存在，服務將建立它。
delete_missing_aspects (bool | None) – 可選。如果設定為 true 並且 aspect_keys 指定了 Aspect 範圍，服務將刪除請求中未提供的該範圍內的任何現有 Aspect。
aspect_keys (collections.abc.MutableSequence[str] | None) –
可選。服務應修改的 Aspect 的 map 鍵。它支援以下語法：
- <aspect_type_reference> - 匹配給定型別且路徑為空的 Aspect。
- <aspect_type_reference>@path - 匹配給定型別和指定路徑的 Aspect。
  例如，要將 Aspect 附加到由 schema Aspect 指定的欄位，路徑應具有 Schema.<field_name> 格式。
- <aspect_type_reference>@* - 匹配給定型別的所有路徑的 Aspect。
- *@path - 匹配給定路徑上的所有型別的 Aspect。
除非將 delete_missing_aspects 設定為 true，否則服務不會刪除與語法匹配的現有 Aspect。如果此欄位留空，服務會將其視為指定請求中精確存在的那些 Aspect。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_aspect_type(location, aspect_type_id, aspect_type_configuration, project_id=PROVIDE_PROJECT_ID, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]¶

建立一個 EntryType 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
aspect_type_id (str) – 必需。AspectType 識別符號。
aspect_type_configuration (google.cloud.dataplex_v1.types.AspectType | dict) – 必需。AspectType 配置主體。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 ID。
validate_only (bool) – 可選。如果設定，則執行請求驗證，但不實際執行建立請求。
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_aspect_type(location, aspect_type_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取 AspectType 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
aspect_type_id (str) – 必需。AspectType 識別符號。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_type(location, entry_type_id, entry_type_configuration, project_id=PROVIDE_PROJECT_ID, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]¶

建立一個 EntryType 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_type_id (str) – 必需。EntryType 識別符號。
entry_type_configuration (google.cloud.dataplex_v1.types.EntryType | dict) – 必需。EntryType 配置主體。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 ID。
validate_only (bool) – 可選。如果設定，則執行請求驗證，但不實際執行建立請求。
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_type(location, entry_type_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取 EntryType 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_type_id (str) – 必需。EntryGroup 識別符號。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_aspect_type(location, aspect_type_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除一個 AspectType 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
aspect_type_id (str) – 必需。AspectType 識別符號。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_aspect_types(location, filter_by=None, order_by=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

列出特定位置的 AspectTypes 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
filter_by (str | None) – 可選。應用於列表結果的過濾器。
order_by (str | None) – 可選。用於對結果排序的欄位。
page_size (int | None) – 可選。單頁要返回的最大 EntryGroup 數量。
page_token (str | None) – 可選。用於檢索下一頁結果的令牌。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_aspect_type(location, aspect_type_id, aspect_type_configuration, project_id=PROVIDE_PROJECT_ID, update_mask=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]¶

更新 AspectType 資源。

引數:

aspect_type_id (str) – 必需。要更新的 AspectType 的 ID。
aspect_type_configuration (dict | google.cloud.dataplex_v1.types.AspectType) – 必需。AspectType 更新後的配置主體。
location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
update_mask (list[str] | google.protobuf.field_mask_pb2.FieldMask | None) – 可選。要覆蓋 Entry Group 欄位值的欄位名稱。如果此引數不存在或為空，則所有可修改欄位都將被覆蓋。如果請求正文中省略了此類非必需欄位，則其值將為空。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 ID。
validate_only (bool | None) – 可選。服務驗證請求，但不執行任何更改。
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_type(location, entry_type_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除 EntryType 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_type_id (str) – 必需。EntryType 識別符號。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_entry_types(location, filter_by=None, order_by=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

列出特定位置的 EntryTypes 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
filter_by (str | None) – 可選。應用於列表結果的過濾器。
order_by (str | None) – 可選。用於對結果排序的欄位。
page_size (int | None) – 可選。單頁要返回的最大 EntryGroup 數量。
page_token (str | None) – 可選。用於檢索下一頁結果的令牌。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_entry_type(location, entry_type_id, entry_type_configuration, project_id=PROVIDE_PROJECT_ID, update_mask=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]¶

更新 EntryType 資源。

引數:

entry_type_id (str) – 必需。要更新的 EntryType 的 ID。
entry_type_configuration (dict | google.cloud.dataplex_v1.types.EntryType) – 必需。EntryType 更新後的配置主體。
location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
update_mask (list[str] | google.protobuf.field_mask_pb2.FieldMask | None) – 可選。要覆蓋 Entry Group 欄位值的欄位名稱。如果此引數不存在或為空，則所有可修改欄位都將被覆蓋。如果請求正文中省略了此類非必需欄位，則其值將為空。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 ID。
validate_only (bool | None) – 可選。服務驗證請求，但不執行任何更改。
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_configuration, project_id=PROVIDE_PROJECT_ID, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]¶

建立 Entry 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_group_id (str) – 必需。EntryGroup 識別符號。
entry_group_configuration (google.cloud.dataplex_v1.types.EntryGroup | dict) – 必需。EntryGroup 配置主體。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 ID。
validate_only (bool) – 可選。如果設定，則執行請求驗證，但不實際執行建立請求。
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_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取 EntryGroup 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_group_id (str) – 必需。EntryGroup 識別符號。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除 EntryGroup 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
entry_group_id (str) – 必需。EntryGroup 識別符號。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_entry_groups(location, filter_by=None, order_by=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

列出特定位置的 EntryGroups 資源。

引數:

location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
filter_by (str | None) – 可選。應用於列表結果的過濾器。
order_by (str | None) – 可選。用於對結果排序的欄位。
page_size (int | None) – 可選。單頁要返回的最大 EntryGroup 數量。
page_token (str | None) – 可選。用於檢索下一頁結果的令牌。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 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_entry_group(location, entry_group_id, entry_group_configuration, project_id=PROVIDE_PROJECT_ID, update_mask=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]¶

更新 EntryGroup 資源。

引數:

entry_group_id (str) – 必需。要更新的 EntryGroup 的 ID。
entry_group_configuration (dict | google.cloud.dataplex_v1.types.EntryGroup) – 必需。EntryGroup 更新後的配置主體。
location (str) – 必需。任務所屬的 Google Cloud 位置 ID。
update_mask (list[str] | google.protobuf.field_mask_pb2.FieldMask | None) – 可選。要覆蓋 Entry Group 欄位值的欄位名稱。如果此引數不存在或為空，則所有可修改欄位都將被覆蓋。如果請求正文中省略了此類非必需欄位，則其值將為空。
project_id (str) – 可選。任務所屬的 Google Cloud 專案 ID。
validate_only (bool | None) – 可選。服務驗證請求，但不執行任何更改。
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_task(project_id, region, lake_id, body, dataplex_task_id, validate_only=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

在湖中建立任務資源。

引數:

project_id (str) – 必需。任務所屬的 Google Cloud 專案的 ID。
region (str) – 必需。任務所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。任務所屬的 Google Cloud 湖的 ID。
body (dict[str, Any] | google.cloud.dataplex_v1.types.Task) – 必需。請求主體包含 Task 例項。
dataplex_task_id (str) – 必需。任務識別符號。
validate_only (bool | None) – 可選。僅驗證請求，但不執行更改。預設為 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_task(project_id, region, lake_id, dataplex_task_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除任務資源。

引數:

project_id (str) – 必需。任務所屬的 Google Cloud 專案的 ID。
region (str) – 必需。任務所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。任務所屬的 Google Cloud 湖的 ID。
dataplex_task_id (str) – 必需。要刪除的 Google Cloud 任務的 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_tasks(project_id, region, lake_id, page_size=None, page_token=None, filter=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

列出給定湖下的任務。

引數:

project_id (str) – 必需。任務所屬的 Google Cloud 專案的 ID。
region (str) – 必需。任務所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。任務所屬的 Google Cloud 湖的 ID。
page_size (int | None) – 可選。要返回的最大任務數。服務返回的數量可能少於此值。如果未指定，則最多返回 10 個任務。最大值為 1000；大於 1000 的值將被強制轉換為 1000。
page_token (str | None) – 可選。從上一個 ListZones 呼叫接收到的頁面令牌。提供此令牌以檢索後續頁面。分頁時，提供給 ListZones 的所有其他引數必須與提供頁面令牌的呼叫相匹配。
filter (str | None) – 可選。篩選請求。
order_by (str | None) – 可選。結果的排序欄位。
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_task(project_id, region, lake_id, dataplex_task_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取任務資源。

引數:

project_id (str) – 必需。任務所屬的 Google Cloud 專案的 ID。
region (str) – 必需。任務所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。任務所屬的 Google Cloud 湖的 ID。
dataplex_task_id (str) – 必需。要檢索的 Google Cloud 任務的 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_lake(project_id, region, lake_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除湖泊資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。要刪除的 Google Cloud 湖泊的 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_lake(project_id, region, lake_id, body, validate_only=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

建立湖泊資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。湖泊識別符號。
body (dict[str, Any] | google.cloud.dataplex_v1.types.Lake) – 必需。請求正文包含一個 Lake 例項。
validate_only (bool | None) – 可選。僅驗證請求，但不執行更改。預設為 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]]) – 提供給該方法的附加元資料。

get_lake(project_id, region, lake_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取 Lake 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。要檢索的 Google Cloud Lake 的 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_zone(project_id, region, lake_id, zone_id, body, retry=DEFAULT, timeout=None, metadata=())[source]¶

在 Lake 中建立 Zone 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。要檢索的 Google Cloud Lake 的 ID。
body (dict[str, Any] | google.cloud.dataplex_v1.types.Zone) – 必需。請求正文包含一個 Zone 例項。
zone_id (str) – 必需。Zone 識別符號。
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_zone(project_id, region, lake_id, zone_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除 Zone 資源。Zone 中的所有 Asset 都必須先刪除，才能刪除 Zone。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。要檢索的 Google Cloud Lake 的 ID。
zone_id (str) – 必需。Zone 識別符號。
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_asset(project_id, region, lake_id, zone_id, asset_id, body, retry=DEFAULT, timeout=None, metadata=())[source]¶

建立 Asset 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。要檢索的 Google Cloud Lake 的 ID。
zone_id (str) – 必需。Zone 識別符號。
asset_id (str) – 必需。Asset 識別符號。
body (dict[str, Any] | google.cloud.dataplex_v1.types.Asset) – 必需。請求正文包含一個 Asset 例項。
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_asset(project_id, region, lake_id, asset_id, zone_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除 Asset 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
lake_id (str) – 必需。要檢索的 Google Cloud Lake 的 ID。
zone_id (str) – 必需。Zone 識別符號。
asset_id (str) – 必需。Asset 識別符號。
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_data_scan(project_id, region, body, data_scan_id=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

建立 DataScan 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
data_scan_id (str | None) – 必需。資料質量掃描識別符號。
body (dict[str, Any] | google.cloud.dataplex_v1.types.DataScan) – 必需。請求正文包含一個 DataScan 例項。
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]]) – 提供給該方法的附加元資料。

run_data_scan(project_id, region, data_scan_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

執行 DataScan 的按需執行。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
data_scan_id (str) – 必需。資料質量掃描識別符號。
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_data_scan_job(project_id, region, data_scan_id=None, job_id=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取 DataScan Job 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
data_scan_id (str | None) – 必需。資料質量掃描識別符號。
job_id (str | None) – 必需。DataScanJob 的資源名稱：projects/{project_id}/locations/{region}/dataScans/{data_scan_id}/jobs/{data_scan_job_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]]) – 提供給該方法的附加元資料。

wait_for_data_scan_job(data_scan_id, job_id=None, project_id=PROVIDE_PROJECT_ID, region=None, wait_time=10, result_timeout=None)[source]¶

等待 Dataplex 資料掃描作業。

引數:

job_id (str | None) – 必需。要等待的 job_id。
data_scan_id (str) – 必需。資料質量掃描識別符號。
region (str | None) – 必需。Lake 所屬的 Google Cloud 區域的 ID。
project_id (str) – 可選。Google Cloud 專案 ID。
wait_time (int) – 兩次檢查之間的秒數。
result_timeout (float | None) – 運算子等待資料質量掃描結果的秒數值。如果在指定的秒數後未找到結果，則丟擲異常。

get_data_scan(project_id, region, data_scan_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取 DataScan 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
data_scan_id (str) – 必需。資料質量掃描識別符號。
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_data_scan(project_id, region, data_scan_id, body, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

更新 DataScan 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
data_scan_id (str) – 必需。資料質量掃描識別符號。
body (dict[str, Any] | google.cloud.dataplex_v1.types.DataScan) – 必需。請求正文包含一個 DataScan 例項。
update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – 必需。要更新的欄位掩碼。
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_data_scan(project_id, region, data_scan_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

刪除 DataScan 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
data_scan_id (str) – 必需。資料質量掃描識別符號。
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_data_scan_jobs(project_id, region, data_scan_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

列出給定 DataScan 下的 DataScanJob。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
data_scan_id (str) – 必需。資料質量掃描識別符號。
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]]) – 提供給該方法的附加元資料。

class airflow.providers.google.cloud.hooks.dataplex.DataplexAsyncHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

繼承自：airflow.providers.google.common.hooks.base_google.GoogleBaseAsyncHook

用於 Google Cloud Dataplex API 的非同步 Hook。

Hook 中所有使用 project_id 的方法都必須使用關鍵字引數呼叫，而不是位置引數。

sync_hook_class[source]¶

async get_dataplex_data_scan_client()[source]¶

返回 DataScanServiceAsyncClient。

async get_data_scan_job(project_id, region, data_scan_id=None, job_id=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

獲取 DataScan Job 資源。

引數:

project_id (str) – 必需。湖泊所屬的 Google Cloud 專案的 ID。
region (str) – 必需。湖泊所屬的 Google Cloud 區域的 ID。
data_scan_id (str | None) – 必需。DataScan 識別符號。
job_id (str | None) – 必需。DataScanJob 的資源名稱：projects/{project_id}/locations/{region}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}
retry (google.api_core.retry_async.AsyncRetry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定為 None，請求將不會被重試。
timeout (float | None) – 等待請求完成的時間量（秒）。請注意，如果指定了 retry，則超時適用於每次單獨嘗試。
metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給該方法的附加元資料。