airflow.providers.google.cloud.hooks.dlp

此模块包含一个 CloudDLPHook，允许您连接到 Google Cloud DLP 服务。

模块内容

类

CloudDLPHook

用于 Google Cloud 数据丢失防护 (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 数据丢失防护 (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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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)[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

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

删除取消识别模板。

参数

  • 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=())[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • timeout (float | None) – （可选）等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时适用于每个单独的尝试。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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 作业的最新状态。

参数

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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_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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

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

参数

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

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

列出作业触发器。

参数

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[源代码]

重新识别已取消标识的内容。

参数

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[源代码]

更新取消标识模板。

参数

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[源代码]

更新检查模板。

参数

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[源代码]

更新作业触发器。

参数

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • 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=())[源代码]

通过创建新版本来更新存储的信息类型。

参数

  • 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。

  • timeout (float | None) – （可选）等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时适用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – （可选）提供给方法的其他元数据。

此条目是否有帮助？