airflow.providers.google.cloud.hooks.dlp

此模組包含一個 CloudDLPHook，可讓您連線至 Google Cloud DLP 服務。

模組內容

類別

CloudDLPHook

用於 Google Cloud Data Loss Prevention (DLP) API 的 Hook。

屬性

DLP_JOB_PATH_PATTERN

airflow.providers.google.cloud.hooks.dlp.DLP_JOB_PATH_PATTERN = '^projects/[^/]+/dlpJobs/(?P<job>.*?)$'[原始碼]
class airflow.providers.google.cloud.hooks.dlp.CloudDLPHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]

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

用於 Google Cloud Data Loss Prevention (DLP) API 的 Hook。

Cloud DLP 允許用戶端偵測使用者提供的非結構化資料串流（如文字區塊或圖片）中是否存在個人身分識別資訊 (PII) 和其他隱私敏感資料。此服務也包含用於敏感資料修訂和排程在 Google Cloud 基礎資料集上進行資料掃描的方法。

參數

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

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

get_conn()[原始碼]

提供與 Cloud DLP API 互動的用戶端。

傳回

Google Cloud DLP API 用戶端

傳回類型

google.cloud.dlp.DlpServiceClient

cancel_dlp_job(dlp_job_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[原始碼]

對長時間執行的 DLP 工作啟動非同步取消。

參數

  • dlp_job_id (str) – 要取消的 DLP 工作資源 ID。

  • project_id (str) – （可選）DLP 執行個體所在的 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

create_deidentify_template(organization_id=None, project_id=PROVIDE_PROJECT_ID, deidentify_template=None, template_id=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

建立去識別範本，以重複使用內容、圖片和儲存空間的常用設定。

參數

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • deidentify_template (dict | google.cloud.dlp_v2.types.DeidentifyTemplate | None) – （可選）要建立的去識別範本。

  • template_id (str | None) – （可選）範本 ID。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

create_dlp_job(project_id=PROVIDE_PROJECT_ID, inspect_job=None, risk_job=None, job_id=None, retry=DEFAULT, timeout=None, metadata=(), wait_until_finished=True, time_to_sleep_in_seconds=60)[原始碼]

建立新工作以檢查儲存空間或計算風險指標。

參數

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • inspect_job (dict | google.cloud.dlp_v2.types.InspectJobConfig | None) – （可選）檢查工作的設定。

  • risk_job (dict | google.cloud.dlp_v2.types.RiskAnalysisJobConfig | None) – （可選）風險工作的設定。

  • job_id (str | None) – （可選）工作 ID。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

  • wait_until_finished (bool) – （可選）如果為 true，它將持續輪詢工作狀態，直到設定為 DONE。

  • time_to_sleep_in_seconds (int) – （可選）在主動檢查操作結果之間睡眠的時間（以秒為單位）。預設值為 60。

create_inspect_template(organization_id=None, project_id=PROVIDE_PROJECT_ID, inspect_template=None, template_id=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

建立檢查範本，以重複使用內容、圖片和儲存空間的常用設定。

參數

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • inspect_template (google.cloud.dlp_v2.types.InspectTemplate | None) – （可選）要建立的檢查範本。

  • template_id (str | None) – （可選）範本 ID。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

create_job_trigger(project_id=PROVIDE_PROJECT_ID, job_trigger=None, trigger_id=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

建立工作觸發器，以執行 DLP 動作，例如在設定的排程上掃描儲存空間以尋找敏感資訊。

參數

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • job_trigger (dict | google.cloud.dlp_v2.types.JobTrigger | None) – （可選）要建立的工作觸發器。

  • trigger_id (str | None) – （可選）工作觸發器 ID。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

create_stored_info_type(organization_id=None, project_id=PROVIDE_PROJECT_ID, config=None, stored_info_type_id=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

建立預先建立的儲存資訊類型，用於檢查。

參數

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • config (dict | google.cloud.dlp_v2.types.StoredInfoTypeConfig | None) – （可選）儲存資訊類型的設定。

  • stored_info_type_id (str | None) – （可選）儲存資訊類型 ID。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

deidentify_content(project_id=PROVIDE_PROJECT_ID, deidentify_config=None, inspect_config=None, item=None, inspect_template_name=None, deidentify_template_name=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

從內容項目中去識別潛在的敏感資訊；限制輸入大小和輸出大小。

參數

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • deidentify_config (dict | google.cloud.dlp_v2.types.DeidentifyConfig | None) – （可選）用於內容項目去識別的設定。此處指定的項目將覆寫 deidentify_template_name 引數所參考的範本。

  • inspect_config (dict | google.cloud.dlp_v2.types.InspectConfig | None) – （可選）用於檢查器的設定。此處指定的項目將覆寫 inspect_template_name 引數所參考的範本。

  • item (dict | google.cloud.dlp_v2.types.ContentItem | None) – （可選）要取消識別的項目。將被視為文字。

  • inspect_template_name (str | None) – （可選）要使用的可選範本。inspect_config 中直接指定的任何設定都將覆寫範本中設定的設定。

  • deidentify_template_name (str | None) – （可選）要使用的可選範本。deidentify_config 中直接指定的任何設定都將覆寫範本中設定的設定。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

delete_deidentify_template(template_id, organization_id=None, project_id=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

刪除去識別範本。

參數

  • template_id – 要刪除的去識別範本 ID。

  • organization_id – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • retry – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

  • metadata – （可選）提供給方法的其他中繼資料。

delete_dlp_job(dlp_job_id, project_id, retry=DEFAULT, timeout=None, metadata=())[原始碼]

刪除長時間執行的 DLP 工作。

此方法表示用戶端不再對 DLP 工作結果感興趣。如果可能，工作將被取消。

參數

  • dlp_job_id (str) – 要取消的 DLP 工作資源 ID。

  • project_id (str) – （可選）DLP 執行個體所在的 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

delete_inspect_template(template_id, organization_id=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[原始碼]

刪除檢查範本。

參數

  • template_id (str) – 要刪除的檢查範本 ID。

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

delete_job_trigger(job_trigger_id, project_id, retry=DEFAULT, timeout=None, metadata=())[原始碼]

刪除工作觸發器。

參數

  • job_trigger_id (str) – 要刪除的 DLP 工作觸發器 ID。

  • project_id (str) – （可選）DLP 執行個體所在的 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

delete_stored_info_type(stored_info_type_id, organization_id=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[原始碼]

刪除儲存資訊類型。

參數

  • stored_info_type_id (str) – 要刪除的儲存資訊類型 ID。

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

get_deidentify_template(template_id, organization_id=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

取得去識別化範本。

參數

  • template_id (str) – 要讀取的去識別化範本 ID。

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

get_dlp_job(dlp_job_id, project_id, retry=DEFAULT, timeout=None, metadata=())[source]

取得長時間運行的 Dlp Job 的最新狀態。

參數

  • dlp_job_id (str) – 要讀取的 DLP job 資源 ID。

  • project_id (str) – （可選）DLP 執行個體所在的 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

get_inspect_template(template_id, organization_id=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

取得檢查範本。

參數

  • template_id (str) – 要讀取的檢查範本 ID。

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

get_job_trigger(job_trigger_id, project_id, retry=DEFAULT, timeout=None, metadata=())[source]

取得 DLP job 觸發器。

參數

  • job_trigger_id (str) – 要讀取的 DLP job 觸發器 ID。

  • project_id (str) – （可選）DLP 執行個體所在的 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

get_stored_info_type(stored_info_type_id, organization_id=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

取得已儲存的資訊類型。

參數

  • stored_info_type_id (str) – 要讀取的已儲存資訊類型 ID。

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

inspect_content(project_id, inspect_config=None, item=None, inspect_template_name=None, retry=DEFAULT, timeout=None, metadata=())[source]

在內容中尋找潛在的敏感資訊；限制輸入大小、處理時間和輸出大小。

參數

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • inspect_config (dict | google.cloud.dlp_v2.types.InspectConfig | None) – （可選）用於檢查器的設定。此處指定的項目將覆寫 inspect_template_name 引數所參考的範本。

  • item (dict | google.cloud.dlp_v2.types.ContentItem | None) – （可選）要取消識別的項目。將被視為文字。

  • inspect_template_name (str | None) – （可選）要使用的可選範本。inspect_config 中直接指定的任何設定都將覆寫範本中設定的設定。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

list_deidentify_templates(organization_id=None, project_id=PROVIDE_PROJECT_ID, page_size=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

列出去識別化範本。

參數

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • page_size (int | None) – (選填) 底層 API 回應中包含的最大資源數量。

  • order_by (str | None) – (選填) 排序依據的選填逗號分隔欄位清單，後接 asc 或 desc 後綴。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

list_dlp_jobs(project_id, results_filter=None, page_size=None, job_type=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

列出符合請求中指定篩選條件的 DLP job。

參數

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • results_filter (str | None) – (選填) 用於指定結果子集的篩選器。

  • page_size (int | None) – (選填) 底層 API 回應中包含的最大資源數量。

  • job_type (str | None) – (選填) job 的類型。

  • order_by (str | None) – (選填) 排序依據的選填逗號分隔欄位清單，後接 asc 或 desc 後綴。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

list_info_types(language_code=None, results_filter=None, retry=DEFAULT, timeout=None, metadata=())[source]

傳回 DLP API 支援的敏感資訊類型清單。

參數

  • language_code (str | None) – (選填) 資訊類型易記名稱的選填 BCP-47 語言代碼。如果省略，或如果沒有可用的在地化字串，將傳回 en-US 字串。

  • results_filter (str | None) – (選填) 用於指定結果子集的篩選器。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

list_inspect_templates(organization_id=None, project_id=PROVIDE_PROJECT_ID, page_size=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

列出檢查範本。

參數

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • page_size (int | None) – (選填) 底層 API 回應中包含的最大資源數量。

  • order_by (str | None) – (選填) 排序依據的選填逗號分隔欄位清單，後接 asc 或 desc 後綴。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

list_job_triggers(project_id, page_size=None, order_by=None, results_filter=None, retry=DEFAULT, timeout=None, metadata=())[source]

列出 job 觸發器。

參數

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • page_size (int | None) – (選填) 底層 API 回應中包含的最大資源數量。

  • order_by (str | None) – (選填) 排序依據的選填逗號分隔欄位清單，後接 asc 或 desc 後綴。

  • results_filter (str | None) – (選填) 用於指定結果子集的篩選器。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

list_stored_info_types(organization_id=None, project_id=PROVIDE_PROJECT_ID, page_size=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

列出已儲存的資訊類型。

參數

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • page_size (int | None) – (選填) 底層 API 回應中包含的最大資源數量。

  • order_by (str | None) – (選填) 排序依據的選填逗號分隔欄位清單，後接 asc 或 desc 後綴。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

redact_image(project_id, inspect_config=None, image_redaction_configs=None, include_findings=None, byte_item=None, retry=DEFAULT, timeout=None, metadata=())[source]

從圖片中編輯掉潛在的敏感資訊；限制輸入大小、處理時間和輸出大小。

參數

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • inspect_config (dict | google.cloud.dlp_v2.types.InspectConfig | None) – （可選）用於檢查器的設定。此處指定的項目將覆寫 inspect_template_name 引數所參考的範本。

  • image_redaction_configs (None | list[dict] | list[google.cloud.dlp_v2.types.RedactImageRequest.ImageRedactionConfig]) – (選填) 用於指定要從圖片中編輯掉哪些內容的組態。list[google.cloud.dlp_v2.types.RedactImageRequest.ImageRedactionConfig]

  • include_findings (bool | None) – (選填) 回應是否應包含調查結果以及已編輯的圖片。

  • byte_item (dict | google.cloud.dlp_v2.types.ByteContentItem | None) – (選填) 內容必須為 PNG、JPEG、SVG 或 BMP。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

reidentify_content(project_id, reidentify_config=None, inspect_config=None, item=None, inspect_template_name=None, reidentify_template_name=None, retry=DEFAULT, timeout=None, metadata=())[source]

重新識別已去識別化的內容。

參數

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • reidentify_config (dict | google.cloud.dlp_v2.types.DeidentifyConfig | None) – (選填) 用於內容項目重新識別的組態。

  • inspect_config (dict | google.cloud.dlp_v2.types.InspectConfig | None) – (選填) 檢查器的組態。

  • item (dict | google.cloud.dlp_v2.types.ContentItem | None) – (選填) 要重新識別的項目。將被視為文字。

  • inspect_template_name (str | None) – （可選）要使用的可選範本。inspect_config 中直接指定的任何設定都將覆寫範本中設定的設定。

  • reidentify_template_name (str | None) – (選填) 要使用的選填範本。參考去識別化範本的執行個體。直接在 reidentify_config 或 inspect_config 中指定的任何組態，都將覆寫範本中設定的組態。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – （可選）用於重試請求的重試物件。如果未指定 None，則不會重試請求。

  • timeout (float | None) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

update_deidentify_template(template_id, organization_id=None, project_id=PROVIDE_PROJECT_ID, deidentify_template=None, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

更新去識別化範本。

參數

  • template_id (str) – 要更新的去識別化範本 ID。

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • deidentify_template (dict | google.cloud.dlp_v2.types.DeidentifyTemplate | None) – 新的去識別化範本值。

  • 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

update_inspect_template(template_id, organization_id=None, project_id=PROVIDE_PROJECT_ID, inspect_template=None, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

更新檢查範本。

參數

  • template_id (str) – 要更新的檢查範本 ID。

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • inspect_template (dict | google.cloud.dlp_v2.types.InspectTemplate | None) – 新的檢查範本值。

  • 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

update_job_trigger(job_trigger_id, project_id, job_trigger=None, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

更新 job 觸發器。

參數

  • job_trigger_id (str) – 要更新的 DLP job 觸發器 ID。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。

  • job_trigger (dict | google.cloud.dlp_v2.types.JobTrigger | None) – 新的 job 觸發器值。

  • 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

update_stored_info_type(stored_info_type_id, organization_id=None, project_id=PROVIDE_PROJECT_ID, config=None, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

透過建立新版本來更新已儲存的資訊類型。

參數

  • stored_info_type_id (str) – 要更新的已儲存資訊類型 ID。

  • organization_id (str | None) – （可選）組織 ID。如果父資源是組織，則必須設定此欄位。

  • project_id (str) – （可選）DLP 執行個體所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時，才設定此欄位。

  • config (dict | google.cloud.dlp_v2.types.StoredInfoTypeConfig | None) – 已儲存資訊類型的更新組態。如果未提供，將使用現有組態建立已儲存資訊類型的新版本。

  • 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) – （可選）等待請求完成的時間量（以秒為單位）。請注意，如果指定了重試，則逾時適用於每個個別嘗試。

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

此條目是否有幫助？