Class DlpServiceClient (0.15.2)

DlpServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

The Cloud Data Loss Prevention (DLP) API is a service that 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 Platform based data sets.

To learn more about concepts and find how-to guides see https://cloud.google.com/dlp/docs/.

Methods

DlpServiceClient

DlpServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
Name	Description
`channel`	`grpc.Channel` DEPRECATED. A `Channel` instance through which to make calls. This argument is mutually exclusive with `credentials`; providing both will raise an exception.
`credentials`	`google.auth.credentials.Credentials` The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to `transport`; doing so will raise an exception.
`client_config`	`dict` DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.
`client_options`	`Union[dict, google.api_core.client_options.ClientOptions]` Client options used to set user options on the client. API Endpoint should be set through client_options.

cancel_dlp_job

cancel_dlp_job(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

TODO: Initialize name:

name = ''

client.cancel_dlp_job(name)

Parameters
Name	Description
`name`	`str` Required. The name of the DlpJob resource to be cancelled.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

create_deidentify_template

create_deidentify_template(parent, deidentify_template, template_id=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.organization_location_path('[ORGANIZATION]', '[LOCATION]')

TODO: Initialize deidentify_template:

deidentify_template = {}

response = client.create_deidentify_template(parent, deidentify_template)

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}.
`deidentify_template`	`Union[dict, DeidentifyTemplate]` Required. The DeidentifyTemplate to create. If a dict is provided, it must be of the same form as the protobuf message DeidentifyTemplate
`template_id`	`str` The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

create_dlp_job

create_dlp_job(parent, inspect_job=None, risk_job=None, job_id=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.project_path('[PROJECT]')

response = client.create_dlp_job(parent)

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.
`inspect_job`	`Union[dict, InspectJobConfig]` Set to control what and how to inspect. If a dict is provided, it must be of the same form as the protobuf message InspectJobConfig
`risk_job`	`Union[dict, RiskAnalysisJobConfig]` Set to choose what metric to calculate. If a dict is provided, it must be of the same form as the protobuf message RiskAnalysisJobConfig
`job_id`	`str` The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

create_inspect_template

create_inspect_template(parent, inspect_template, template_id=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.organization_location_path('[ORGANIZATION]', '[LOCATION]')

TODO: Initialize inspect_template:

inspect_template = {}

response = client.create_inspect_template(parent, inspect_template)

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location-id}.
`inspect_template`	`Union[dict, InspectTemplate]` Required. The InspectTemplate to create. If a dict is provided, it must be of the same form as the protobuf message InspectTemplate
`template_id`	`str` The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

create_job_trigger

create_job_trigger(parent, job_trigger, trigger_id=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.project_path('[PROJECT]')

TODO: Initialize job_trigger:

job_trigger = {}

response = client.create_job_trigger(parent, job_trigger)

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.
`job_trigger`	`Union[dict, JobTrigger]` Required. The JobTrigger to create. If a dict is provided, it must be of the same form as the protobuf message JobTrigger
`trigger_id`	`str` The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

create_stored_info_type

create_stored_info_type(parent, config, stored_info_type_id=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.organization_location_path('[ORGANIZATION]', '[LOCATION]')

TODO: Initialize config:

config = {}

response = client.create_stored_info_type(parent, config)

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}
`config`	`Union[dict, StoredInfoTypeConfig]` Required. Configuration of the storedInfoType to create. If a dict is provided, it must be of the same form as the protobuf message StoredInfoTypeConfig
`stored_info_type_id`	`str` The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

deidentify_content

deidentify_content(parent=None, deidentify_config=None, inspect_config=None, item=None, inspect_template_name=None, deidentify_template_name=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more.

When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

response = client.deidentify_content()

Parameters
Name	Description
`parent`	`str` The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.
`deidentify_config`	`Union[dict, DeidentifyConfig]` Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument. If a dict is provided, it must be of the same form as the protobuf message DeidentifyConfig
`inspect_config`	`Union[dict, InspectConfig]` Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument. If a dict is provided, it must be of the same form as the protobuf message InspectConfig
`item`	`Union[dict, ContentItem]` The item to de-identify. Will be treated as text. If a dict is provided, it must be of the same form as the protobuf message ContentItem
`inspect_template_name`	`str` Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
`deidentify_template_name`	`str` Template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

deidentify_template_path

deidentify_template_path(organization, deidentify_template)

Return a fully-qualified deidentify_template string.

delete_deidentify_template

delete_deidentify_template(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_deidentify_template_path('[ORGANIZATION]', '[DEIDENTIFY_TEMPLATE]')

client.delete_deidentify_template(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

delete_dlp_job

delete_dlp_job(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

TODO: Initialize name:

name = ''

client.delete_dlp_job(name)

Parameters
Name	Description
`name`	`str` Required. The name of the DlpJob resource to be deleted.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

delete_inspect_template

delete_inspect_template(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_inspect_template_path('[ORGANIZATION]', '[INSPECT_TEMPLATE]')

client.delete_inspect_template(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

delete_job_trigger

delete_job_trigger(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.project_job_trigger_path('[PROJECT]', '[JOB_TRIGGER]')

client.delete_job_trigger(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

delete_stored_info_type

delete_stored_info_type(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_stored_info_type_path('[ORGANIZATION]', '[STORED_INFO_TYPE]')

client.delete_stored_info_type(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

dlp_job_path

dlp_job_path(project, dlp_job)

Return a fully-qualified dlp_job string.

finish_dlp_job

finish_dlp_job(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

TODO: Initialize name:

name = ''

client.finish_dlp_job(name)

Parameters
Name	Description
`name`	`str` Required. The name of the DlpJob resource to be cancelled.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`DlpServiceClient`	The constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`DlpServiceClient`	The constructed client.

get_deidentify_template

get_deidentify_template(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_deidentify_template_path('[ORGANIZATION]', '[DEIDENTIFY_TEMPLATE]')

response = client.get_deidentify_template(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

get_dlp_job

get_dlp_job(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

TODO: Initialize name:

name = ''

response = client.get_dlp_job(name)

Parameters
Name	Description
`name`	`str` Required. The name of the DlpJob resource.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

get_inspect_template

get_inspect_template(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_inspect_template_path('[ORGANIZATION]', '[INSPECT_TEMPLATE]')

response = client.get_inspect_template(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

get_job_trigger

get_job_trigger(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.project_job_trigger_path('[PROJECT]', '[JOB_TRIGGER]')

response = client.get_job_trigger(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

get_stored_info_type

get_stored_info_type(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_stored_info_type_path('[ORGANIZATION]', '[STORED_INFO_TYPE]')

response = client.get_stored_info_type(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

hybrid_inspect_dlp_job

hybrid_inspect_dlp_job(name, hybrid_item=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Inspect hybrid content and store findings to a job. To review the findings inspect the job. Inspection will occur asynchronously. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

TODO: Initialize name:

name = ''

response = client.hybrid_inspect_dlp_job(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the job to execute a hybrid inspect on, for example `projects/dlp-test-project/dlpJob/53234423`.
`hybrid_item`	`Union[dict, HybridContentItem]` The item to inspect. If a dict is provided, it must be of the same form as the protobuf message HybridContentItem
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

hybrid_inspect_job_trigger

hybrid_inspect_job_trigger(name, hybrid_item=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.project_job_trigger_path('[PROJECT]', '[JOB_TRIGGER]')

response = client.hybrid_inspect_job_trigger(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the trigger to execute a hybrid inspect on, for example `projects/dlp-test-project/jobTriggers/53234423`.
`hybrid_item`	`Union[dict, HybridContentItem]` The item to inspect. If a dict is provided, it must be of the same form as the protobuf message HybridContentItem
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

inspect_content

inspect_content(parent=None, inspect_config=None, item=None, inspect_template_name=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size.

For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

response = client.inspect_content()

Parameters
Name	Description
`parent`	`str` The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}
`inspect_config`	`Union[dict, InspectConfig]` Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument. If a dict is provided, it must be of the same form as the protobuf message InspectConfig
`item`	`Union[dict, ContentItem]` The item to inspect. If a dict is provided, it must be of the same form as the protobuf message ContentItem
`inspect_template_name`	`str` Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

inspect_template_path

inspect_template_path(organization, inspect_template)

Return a fully-qualified inspect_template string.

job_trigger_path

job_trigger_path(project, job_trigger)

Return a fully-qualified job_trigger string.

list_deidentify_templates

list_deidentify_templates(parent, page_size=None, order_by=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.organization_location_path('[ORGANIZATION]', '[LOCATION]')

Iterate over all results

for element in client.list_deidentify_templates(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_deidentify_templates(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}.
`page_size`	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
`order_by`	`str` Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

list_dlp_jobs

list_dlp_jobs(parent, filter_=None, page_size=None, type_=None, order_by=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.project_path('[PROJECT]')

Iterate over all results

for element in client.list_dlp_jobs(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_dlp_jobs(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.
`filter_`	`str` Allows filtering. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. - A restriction has the form of `{field} {operator} {value}`. - Supported fields/values for inspect jobs: - `state` - PENDING\|RUNNING\|CANCELED\|FINISHED\|FAILED - `inspected_storage` - DATASTORE\|CLOUD_STORAGE\|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time<code> - Corresponds to time the job finished. - 'start_time</code> - Corresponds to time the job finished. - Supported fields for risk analysis jobs: - `state` - RUNNING\|CANCELED\|FINISHED\|FAILED - 'end_time<code> - Corresponds to time the job finished. - 'start_time</code> - Corresponds to time the job finished. - The operator must be `=` or `!=`. Examples: - inspected_storage = cloud_storage AND state = done - inspected_storage = cloud_storage OR inspected_storage = bigquery - inspected_storage = cloud_storage AND (state = done OR state = canceled) - end_time > "2017-12-12T00:00:00+00:00" The length of this field should be no more than 500 characters.
`page_size`	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
`type_`	`DlpJobType` The type of job. Defaults to `DlpJobType.INSPECT`
`order_by`	`str` Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state`
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

list_info_types

list_info_types(parent=None, language_code=None, filter_=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

response = client.list_info_types()

Parameters
Name	Description
`parent`	`str` The parent resource name, for example locations/{location_id}
`language_code`	`str` BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.
`filter_`	`str` filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

list_inspect_templates

list_inspect_templates(parent, page_size=None, order_by=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.organization_location_path('[ORGANIZATION]', '[LOCATION]')

Iterate over all results

for element in client.list_inspect_templates(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_inspect_templates(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}.
`page_size`	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
`order_by`	`str` Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

list_job_triggers

list_job_triggers(parent, page_size=None, order_by=None, filter_=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.project_path('[PROJECT]')

Iterate over all results

for element in client.list_job_triggers(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_job_triggers(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example `projects/my-project-id` or projects/my-project-id/locations/{location_id}.
`page_size`	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
`order_by`	`str` Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status.
`filter_`	`str` Allows filtering. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. - A restriction has the form of `{field} {operator} {value}`. - Supported fields/values for inspect jobs: - `status` - HEALTHY\|PAUSED\|CANCELLED - `inspected_storage` - DATASTORE\|CLOUD_STORAGE\|BIGQUERY - 'last_run_time<code> - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. - The operator must be = `or` !=` for status and inspected_storage. Examples: - inspected_storage = cloud_storage AND status = HEALTHY - inspected_storage = cloud_storage OR inspected_storage = bigquery - inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) - last_run_time > "2017-12-12T00:00:00+00:00" The length of this field should be no more than 500 characters.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

list_stored_info_types

list_stored_info_types(parent, page_size=None, order_by=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.organization_location_path('[ORGANIZATION]', '[LOCATION]')

Iterate over all results

for element in client.list_stored_info_types(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_stored_info_types(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
`parent`	`str` Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}.
`page_size`	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
`order_by`	`str` Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

location_path

location_path(project, location)

Return a fully-qualified location string.

organization_deidentify_template_path

organization_deidentify_template_path(organization, deidentify_template)

Return a fully-qualified organization_deidentify_template string.

organization_inspect_template_path

organization_inspect_template_path(organization, inspect_template)

Return a fully-qualified organization_inspect_template string.

organization_location_path

organization_location_path(organization, location)

Return a fully-qualified organization_location string.

organization_path

organization_path(organization)

Return a fully-qualified organization string.

organization_stored_info_type_path

organization_stored_info_type_path(organization, stored_info_type)

Return a fully-qualified organization_stored_info_type string.

project_deidentify_template_path

project_deidentify_template_path(project, deidentify_template)

Return a fully-qualified project_deidentify_template string.

project_inspect_template_path

project_inspect_template_path(project, inspect_template)

Return a fully-qualified project_inspect_template string.

project_job_trigger_path

project_job_trigger_path(project, job_trigger)

Return a fully-qualified project_job_trigger string.

project_path

project_path(project)

Return a fully-qualified project string.

project_stored_info_type_path

project_stored_info_type_path(project, stored_info_type)

Return a fully-qualified project_stored_info_type string.

redact_image

redact_image(parent=None, location_id=None, inspect_config=None, image_redaction_configs=None, include_findings=None, byte_item=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

response = client.redact_image()

Parameters
Name	Description
`parent`	`str` The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.
`location_id`	`str` Deprecated. This field has no effect.
`inspect_config`	`Union[dict, InspectConfig]` Configuration for the inspector. If a dict is provided, it must be of the same form as the protobuf message InspectConfig
`image_redaction_configs`	`list[Union[dict, ImageRedactionConfig]]` The configuration for specifying what content to redact from images. If a dict is provided, it must be of the same form as the protobuf message ImageRedactionConfig
`include_findings`	`bool` Whether the response should include findings along with the redacted image.
`byte_item`	`Union[dict, ByteContentItem]` The content must be PNG, JPEG, SVG or BMP. If a dict is provided, it must be of the same form as the protobuf message ByteContentItem
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

reidentify_content

reidentify_content(parent, reidentify_config=None, inspect_config=None, item=None, inspect_template_name=None, reidentify_template_name=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

parent = client.project_path('[PROJECT]')

response = client.reidentify_content(parent)

Parameters
Name	Description
`parent`	`str` Required. The parent resource name.
`reidentify_config`	`Union[dict, DeidentifyConfig]` Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` If a dict is provided, it must be of the same form as the protobuf message DeidentifyConfig
`inspect_config`	`Union[dict, InspectConfig]` Configuration for the inspector. If a dict is provided, it must be of the same form as the protobuf message InspectConfig
`item`	`Union[dict, ContentItem]` The item to re-identify. Will be treated as text. If a dict is provided, it must be of the same form as the protobuf message ContentItem
`inspect_template_name`	`str` Template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
`reidentify_template_name`	`str` Template to use. References an instance of `DeidentifyTemplate`. Any configuration directly specified in `reidentify_config` or `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
`location_id`	`str` Deprecated. This field has no effect.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

stored_info_type_path

stored_info_type_path(organization, stored_info_type)

Return a fully-qualified stored_info_type string.

update_deidentify_template

update_deidentify_template(name, deidentify_template=None, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_deidentify_template_path('[ORGANIZATION]', '[DEIDENTIFY_TEMPLATE]')

response = client.update_deidentify_template(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
`deidentify_template`	`Union[dict, DeidentifyTemplate]` New DeidentifyTemplate value. If a dict is provided, it must be of the same form as the protobuf message DeidentifyTemplate
`update_mask`	`Union[dict, FieldMask]` Mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

update_inspect_template

update_inspect_template(name, inspect_template=None, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_inspect_template_path('[ORGANIZATION]', '[INSPECT_TEMPLATE]')

response = client.update_inspect_template(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.
`inspect_template`	`Union[dict, InspectTemplate]` New InspectTemplate value. If a dict is provided, it must be of the same form as the protobuf message InspectTemplate
`update_mask`	`Union[dict, FieldMask]` Mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

update_job_trigger

update_job_trigger(name, job_trigger=None, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.project_job_trigger_path('[PROJECT]', '[JOB_TRIGGER]')

response = client.update_job_trigger(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.
`job_trigger`	`Union[dict, JobTrigger]` New JobTrigger value. If a dict is provided, it must be of the same form as the protobuf message JobTrigger
`update_mask`	`Union[dict, FieldMask]` Mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

update_stored_info_type

update_stored_info_type(name, config=None, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

.. rubric:: Example

from google.cloud import dlp_v2

client = dlp_v2.DlpServiceClient()

name = client.organization_stored_info_type_path('[ORGANIZATION]', '[STORED_INFO_TYPE]')

response = client.update_stored_info_type(name)

Parameters
Name	Description
`name`	`str` Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.
`config`	`Union[dict, StoredInfoTypeConfig]` Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. If a dict is provided, it must be of the same form as the protobuf message StoredInfoTypeConfig
`update_mask`	`Union[dict, FieldMask]` Mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` 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[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

Class DlpServiceClient (0.15.2)

Methods

DlpServiceClient

cancel_dlp_job

TODO: Initialize name:

create_deidentify_template

TODO: Initialize deidentify_template:

create_dlp_job

create_inspect_template

TODO: Initialize inspect_template:

create_job_trigger

TODO: Initialize job_trigger:

create_stored_info_type

TODO: Initialize config:

deidentify_content

deidentify_template_path

delete_deidentify_template

delete_dlp_job

TODO: Initialize name:

delete_inspect_template

delete_job_trigger

delete_stored_info_type

dlp_job_path

finish_dlp_job

TODO: Initialize name:

from_service_account_file

from_service_account_json

get_deidentify_template

get_dlp_job

TODO: Initialize name:

get_inspect_template

get_job_trigger

get_stored_info_type

hybrid_inspect_dlp_job

TODO: Initialize name:

hybrid_inspect_job_trigger

inspect_content

inspect_template_path

job_trigger_path

list_deidentify_templates

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_dlp_jobs

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_info_types

list_inspect_templates

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_job_triggers

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_stored_info_types

Iterate over all results

Alternatively:

Iterate over results one page at a time

location_path

organization_deidentify_template_path

organization_inspect_template_path

organization_location_path

organization_path

organization_stored_info_type_path

project_deidentify_template_path

project_inspect_template_path

project_job_trigger_path

project_path

project_stored_info_type_path

redact_image

reidentify_content

stored_info_type_path

update_deidentify_template

update_inspect_template

update_job_trigger

update_stored_info_type

TODO: Initialize `name`:

TODO: Initialize `deidentify_template`:

TODO: Initialize `inspect_template`:

TODO: Initialize `job_trigger`:

TODO: Initialize `config`:

TODO: Initialize `name`:

TODO: Initialize `name`:

TODO: Initialize `name`:

TODO: Initialize `name`: