airflow.providers.google.cloud.hooks.dlp

此模組包含一個 CloudDLPHook,允許您連線到 Google Cloud DLP 服務。

屬性

DLP_JOB_PATH_PATTERN

CloudDLPHook

用於 Google Cloud 資料丟失防護 (DLP) API 的 Hook。

模組內容

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

基類: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

用於 Google Cloud 資料丟失防護 (DLP) API 的 Hook。

Cloud DLP 允許客戶端檢測使用者提供的非結構化資料流(如文字塊或影像)中是否存在個人身份資訊 (PII) 和其他隱私敏感資料。該服務還包括敏感資料刪除修訂和在 Google Cloud 資料集上安排資料掃描的方法。

引數:
  • 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()[source]

提供用於與 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=())[source]

開始對長時間執行的 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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=())[source]

建立一個去標識化模板,以重用內容、影像和儲存的常用配置。

引數:
  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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)[source]

建立一個新作業,用於檢查儲存或計算風險指標。

引數:
  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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=())[source]

建立一個檢查模板,以重用內容、影像和儲存的常用配置。

引數:
  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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=())[source]

建立一個作業觸發器,用於按照設定的計劃執行 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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=())[source]

建立一個預建的儲存資訊型別,用於檢查。

引數:
  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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=())[source]

從內容項中去標識化潛在的敏感資訊;限制輸入大小和輸出大小。

引數:
  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – (可選) 提供給方法的附加元資料。

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

刪除一個去標識化模板。

引數:
  • template_id – 要刪除的去標識化模板的 ID。

  • organization_id – (可選) 組織 ID。如果父資源是組織,則必須設定此欄位。

  • project_id – (可選) DLP 例項所在的 Google Cloud 專案 ID。僅當父資源是專案而不是組織時才設定此欄位。

  • retry – (可選) 用於重試請求的重試物件。如果指定為 None,則不會重試請求。

  • timeout – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • metadata – (可選) 提供給方法的附加元資料。

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

刪除一個長時間執行的 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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=())[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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – (可選) 提供給方法的附加元資料。

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

刪除一個作業觸發器。

引數:
  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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=())[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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – (可選) 提供給方法的附加元資料。

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

獲取長時間執行的 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – (可選) 提供給方法的附加元資料。

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

獲取 DLP 作業觸發器。

引數:
  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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 作業。

引數:
  • 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) – (可選)作業型別。

  • order_by (str | None) – (可選)用於排序的可選逗號分隔欄位列表,後跟 asc 或 desc 字尾。

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

  • timeout (float | None) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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]

列出作業觸發器。

引數:
  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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_trigger_id (str) – 要更新的 DLP 作業觸發器的 ID。

  • project_id (str) – (可選) DLP 例項所在的 Google Cloud 專案 ID。如果設定為 None 或缺失,將使用 Google Cloud 連線中的預設 project_id。

  • job_trigger (dict | google.cloud.dlp_v2.types.JobTrigger | 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • 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) – (可選) 等待請求完成的時間量(以秒為單位)。請注意,如果指定了 retry,則 timeout 應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – (可選) 提供給方法的附加元資料。

此條目是否有幫助?