airflow.providers.google.cloud.hooks.dlp

This module contains a CloudDLPHook which allows you to connect to Google Cloud DLP service.

Module Contents

Classes

CloudDLPHook

Hook for Google Cloud Data Loss Prevention (DLP) APIs.

Attributes

DLP_JOB_PATH_PATTERN

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]

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Hook for Google Cloud Data Loss Prevention (DLP) APIs.

Cloud DLP allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images. The service also includes methods for sensitive data redaction and scheduling of data scans on Google Cloud based data sets.

Parameters

  • gcp_conn_id (str) – The connection ID to use when fetching connection info.

  • impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account.

get_conn()[source]

Provide a client for interacting with the Cloud DLP API.

Returns

Google Cloud DLP API Client

Return type

google.cloud.dlp.DlpServiceClient

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

Start asynchronous cancellation on a long-running DLP job.

Parameters

  • dlp_job_id (str) – ID of the DLP job resource to be cancelled.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Create a deidentify template to reuse frequently-used configurations for content, images, and storage.

Parameters

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • deidentify_template (dict | google.cloud.dlp_v2.types.DeidentifyTemplate | None) – (Optional) The de-identify template to create.

  • template_id (str | None) – (Optional) The template ID.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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]

Create a new job to inspect storage or calculate risk metrics.

Parameters

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • inspect_job (dict | google.cloud.dlp_v2.types.InspectJobConfig | None) – (Optional) The configuration for the inspect job.

  • risk_job (dict | google.cloud.dlp_v2.types.RiskAnalysisJobConfig | None) – (Optional) The configuration for the risk job.

  • job_id (str | None) – (Optional) The job ID.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

  • wait_until_finished (bool) – (Optional) If true, it will keep polling the job state until it is set to DONE.

  • time_to_sleep_in_seconds (int) – (Optional) Time to sleep, in seconds, between active checks of the operation results. Defaults to 60.

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

Create an inspect template to reuse frequently used configurations for content, images, and storage.

Parameters

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • inspect_template (google.cloud.dlp_v2.types.InspectTemplate | None) – (Optional) The inspect template to create.

  • template_id (str | None) – (Optional) The template ID.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Create a job trigger to run DLP actions such as scanning storage for sensitive info on a set schedule.

Parameters

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • job_trigger (dict | google.cloud.dlp_v2.types.JobTrigger | None) – (Optional) The job trigger to create.

  • trigger_id (str | None) – (Optional) The job trigger ID.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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]

Create a pre-built stored info type to be used for inspection.

Parameters

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • config (dict | google.cloud.dlp_v2.types.StoredInfoTypeConfig | None) – (Optional) The config for the stored info type.

  • stored_info_type_id (str | None) – (Optional) The stored info type ID.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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]

De-identifies potentially sensitive info from a content item; limits input size and output size.

Parameters

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • deidentify_config (dict | google.cloud.dlp_v2.types.DeidentifyConfig | None) – (Optional) Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument.

  • inspect_config (dict | google.cloud.dlp_v2.types.InspectConfig | None) – (Optional) Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument.

  • item (dict | google.cloud.dlp_v2.types.ContentItem | None) – (Optional) The item to de-identify. Will be treated as text.

  • inspect_template_name (str | None) – (Optional) Optional template to use. Any configuration directly specified in inspect_config will override those set in the template.

  • deidentify_template_name (str | None) – (Optional) Optional template to use. Any configuration directly specified in deidentify_config will override those set in the template.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Delete a deidentify template.

Parameters

  • template_id – The ID of deidentify template to be deleted.

  • organization_id – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • retry – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata – (Optional) Additional metadata that is provided to the method.

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

Delete a long-running DLP job.

This method indicates that the client is no longer interested in the DLP job result. The job will be cancelled if possible.

Parameters

  • dlp_job_id (str) – The ID of the DLP job resource to be cancelled.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Delete an inspect template.

Parameters

  • template_id (str) – The ID of the inspect template to be deleted.

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Delete a job trigger.

Parameters

  • job_trigger_id (str) – The ID of the DLP job trigger to be deleted.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Delete a stored info type.

Parameters

  • stored_info_type_id (str) – The ID of the stored info type to be deleted.

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Get a deidentify template.

Parameters

  • template_id (str) – The ID of deidentify template to be read.

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Get the latest state of a long-running Dlp Job.

Parameters

  • dlp_job_id (str) – The ID of the DLP job resource to be read.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Get an inspect template.

Parameters

  • template_id (str) – The ID of inspect template to be read.

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Get a DLP job trigger.

Parameters

  • job_trigger_id (str) – The ID of the DLP job trigger to be read.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Get a stored info type.

Parameters

  • stored_info_type_id (str) – The ID of the stored info type to be read.

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Find potentially sensitive info in content; limits input size, processing time, and output size.

Parameters

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • inspect_config (dict | google.cloud.dlp_v2.types.InspectConfig | None) – (Optional) Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument.

  • item (dict | google.cloud.dlp_v2.types.ContentItem | None) – (Optional) The item to de-identify. Will be treated as text.

  • inspect_template_name (str | None) – (Optional) Optional template to use. Any configuration directly specified in inspect_config will override those set in the template.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

List deidentify templates.

Parameters

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • page_size (int | None) – (Optional) The maximum number of resources contained in the underlying API response.

  • order_by (str | None) – (Optional) Optional comma separated list of fields to order by, followed by asc or desc postfix.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

List DLP jobs that match the specified filter in the request.

Parameters

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • results_filter (str | None) – (Optional) Filter used to specify a subset of results.

  • page_size (int | None) – (Optional) The maximum number of resources contained in the underlying API response.

  • job_type (str | None) – (Optional) The type of job.

  • order_by (str | None) – (Optional) Optional comma separated list of fields to order by, followed by asc or desc postfix.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Return a list of the sensitive information types that the DLP API supports.

Parameters

  • language_code (str | None) – (Optional) Optional BCP-47 language code for localized info type friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.

  • results_filter (str | None) – (Optional) Filter used to specify a subset of results.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

List inspect templates.

Parameters

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • page_size (int | None) – (Optional) The maximum number of resources contained in the underlying API response.

  • order_by (str | None) – (Optional) Optional comma separated list of fields to order by, followed by asc or desc postfix.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

List job triggers.

Parameters

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • page_size (int | None) – (Optional) The maximum number of resources contained in the underlying API response.

  • order_by (str | None) – (Optional) Optional comma separated list of fields to order by, followed by asc or desc postfix.

  • results_filter (str | None) – (Optional) Filter used to specify a subset of results.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

List stored info types.

Parameters

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • page_size (int | None) – (Optional) The maximum number of resources contained in the underlying API response.

  • order_by (str | None) – (Optional) Optional comma separated list of fields to order by, followed by asc or desc postfix.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Redacts potentially sensitive info from an image; limits input size, processing time, and output size.

Parameters

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • inspect_config (dict | google.cloud.dlp_v2.types.InspectConfig | None) – (Optional) Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument.

  • image_redaction_configs (None | list[dict] | list[google.cloud.dlp_v2.types.RedactImageRequest.ImageRedactionConfig]) – (Optional) The configuration for specifying what content to redact from images. list[google.cloud.dlp_v2.types.RedactImageRequest.ImageRedactionConfig]

  • include_findings (bool | None) – (Optional) Whether the response should include findings along with the redacted image.

  • byte_item (dict | google.cloud.dlp_v2.types.ByteContentItem | None) – (Optional) The content must be PNG, JPEG, SVG or BMP.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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]

Re-identifies content that has been de-identified.

Parameters

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • reidentify_config (dict | google.cloud.dlp_v2.types.DeidentifyConfig | None) – (Optional) Configuration for the re-identification of the content item.

  • inspect_config (dict | google.cloud.dlp_v2.types.InspectConfig | None) – (Optional) Configuration for the inspector.

  • item (dict | google.cloud.dlp_v2.types.ContentItem | None) – (Optional) The item to re-identify. Will be treated as text.

  • inspect_template_name (str | None) – (Optional) Optional template to use. Any configuration directly specified in inspect_config will override those set in the template.

  • reidentify_template_name (str | None) – (Optional) Optional template to use. References an instance of deidentify template. Any configuration directly specified in reidentify_config or inspect_config will override those set in the template.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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]

Update the deidentify template.

Parameters

  • template_id (str) – The ID of deidentify template to be updated.

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • deidentify_template (dict | google.cloud.dlp_v2.types.DeidentifyTemplate | None) – New deidentify template value.

  • update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – Mask to control which fields get updated.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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]

Update the inspect template.

Parameters

  • template_id (str) – The ID of the inspect template to be updated.

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • inspect_template (dict | google.cloud.dlp_v2.types.InspectTemplate | None) – New inspect template value.

  • update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – Mask to control which fields get updated.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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

Update a job trigger.

Parameters

  • job_trigger_id (str) – The ID of the DLP job trigger to be updated.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • job_trigger (dict | google.cloud.dlp_v2.types.JobTrigger | None) – New job trigger value.

  • update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – Mask to control which fields get updated.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

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]

Update the stored info type by creating a new version.

Parameters

  • stored_info_type_id (str) – The ID of the stored info type to be updated.

  • organization_id (str | None) – (Optional) The organization ID. Required to set this field if parent resource is an organization.

  • project_id (str) – (Optional) Google Cloud project ID where the DLP Instance exists. Only set this field if the parent resource is a project instead of an organization.

  • config (dict | google.cloud.dlp_v2.types.StoredInfoTypeConfig | None) – Updated configuration for the stored info type. If not provided, a new version of the stored info type will be created with the existing configuration.

  • update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – Mask to control which fields get updated.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[tuple[str, str]]) – (Optional) Additional metadata that is provided to the method.

Was this entry helpful?