DlpServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dlp_v2.services.dlp_service.transports.base.DlpServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)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/.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
DlpServiceTransport | The transport used by the client instance. |
Methods
DlpServiceAsyncClient
DlpServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dlp_v2.services.dlp_service.transports.base.DlpServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the dlp service client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
activate_job_trigger
activate_job_trigger(request: Optional[Union[google.cloud.dlp_v2.types.dlp.ActivateJobTriggerRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.
from google.cloud import dlp_v2
def sample_activate_job_trigger():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.ActivateJobTriggerRequest(
name="name_value",
)
# Make the request
response = client.activate_job_trigger(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.ActivateJobTriggerRequest, dict]
The request object. Request message for ActivateJobTrigger. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.DlpJob | Combines all of the information about a DLP job. |
cancel_dlp_job
cancel_dlp_job(request: Optional[Union[google.cloud.dlp_v2.types.dlp.CancelDlpJobRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_cancel_dlp_job():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.CancelDlpJobRequest(
name="name_value",
)
# Make the request
client.cancel_dlp_job(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.CancelDlpJobRequest, dict]
The request object. The request message for canceling a DLP job. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_deidentify_template
create_deidentify_template(request: Optional[Union[google.cloud.dlp_v2.types.dlp.CreateDeidentifyTemplateRequest, dict]] = None, *, parent: Optional[str] = None, deidentify_template: Optional[google.cloud.dlp_v2.types.dlp.DeidentifyTemplate] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_create_deidentify_template():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.CreateDeidentifyTemplateRequest(
parent="parent_value",
)
# Make the request
response = client.create_deidentify_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.CreateDeidentifyTemplateRequest, dict]
The request object. Request message for CreateDeidentifyTemplate. |
parent |
Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have |
deidentify_template |
DeidentifyTemplate
Required. The DeidentifyTemplate to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.DeidentifyTemplate | DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. |
create_dlp_job
create_dlp_job(request: Optional[Union[google.cloud.dlp_v2.types.dlp.CreateDlpJobRequest, dict]] = None, *, parent: Optional[str] = None, inspect_job: Optional[google.cloud.dlp_v2.types.dlp.InspectJobConfig] = None, risk_job: Optional[google.cloud.dlp_v2.types.dlp.RiskAnalysisJobConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_create_dlp_job():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.CreateDlpJobRequest(
parent="parent_value",
)
# Make the request
response = client.create_dlp_job(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.CreateDlpJobRequest, dict]
The request object. Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage. |
parent |
Required. Parent resource name. The format of this value varies depending on whether you have |
inspect_job |
InspectJobConfig
An inspection job scans a storage repository for InfoTypes. This corresponds to the |
risk_job |
RiskAnalysisJobConfig
A risk analysis job calculates re-identification risk metrics for a BigQuery table. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.DlpJob | Combines all of the information about a DLP job. |
create_inspect_template
create_inspect_template(request: Optional[Union[google.cloud.dlp_v2.types.dlp.CreateInspectTemplateRequest, dict]] = None, *, parent: Optional[str] = None, inspect_template: Optional[google.cloud.dlp_v2.types.dlp.InspectTemplate] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_create_inspect_template():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.CreateInspectTemplateRequest(
parent="parent_value",
)
# Make the request
response = client.create_inspect_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.CreateInspectTemplateRequest, dict]
The request object. Request message for CreateInspectTemplate. |
parent |
Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have |
inspect_template |
InspectTemplate
Required. The InspectTemplate to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.InspectTemplate | The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. |
create_job_trigger
create_job_trigger(request: Optional[Union[google.cloud.dlp_v2.types.dlp.CreateJobTriggerRequest, dict]] = None, *, parent: Optional[str] = None, job_trigger: Optional[google.cloud.dlp_v2.types.dlp.JobTrigger] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_create_job_trigger():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
job_trigger = dlp_v2.JobTrigger()
job_trigger.status = "CANCELLED"
request = dlp_v2.CreateJobTriggerRequest(
parent="parent_value",
job_trigger=job_trigger,
)
# Make the request
response = client.create_job_trigger(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.CreateJobTriggerRequest, dict]
The request object. Request message for CreateJobTrigger. |
parent |
Required. Parent resource name. The format of this value varies depending on whether you have |
job_trigger |
JobTrigger
Required. The JobTrigger to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.JobTrigger | Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. |
create_stored_info_type
create_stored_info_type(request: Optional[Union[google.cloud.dlp_v2.types.dlp.CreateStoredInfoTypeRequest, dict]] = None, *, parent: Optional[str] = None, config: Optional[google.cloud.dlp_v2.types.dlp.StoredInfoTypeConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
from google.cloud import dlp_v2
def sample_create_stored_info_type():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.CreateStoredInfoTypeRequest(
parent="parent_value",
)
# Make the request
response = client.create_stored_info_type(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.CreateStoredInfoTypeRequest, dict]
The request object. Request message for CreateStoredInfoType. |
parent |
Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have |
config |
StoredInfoTypeConfig
Required. Configuration of the storedInfoType to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.StoredInfoType | StoredInfoType resource message that contains information about the current version and any pending updates. |
deidentify_content
deidentify_content(request: Optional[Union[google.cloud.dlp_v2.types.dlp.DeidentifyContentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_deidentify_content():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.DeidentifyContentRequest(
)
# Make the request
response = client.deidentify_content(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.DeidentifyContentRequest, dict]
The request object. Request to de-identify a list of items. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.DeidentifyContentResponse | Results of de-identifying a ContentItem. |
deidentify_template_path
deidentify_template_path(organization: str, deidentify_template: str)Returns a fully-qualified deidentify_template string.
delete_deidentify_template
delete_deidentify_template(request: Optional[Union[google.cloud.dlp_v2.types.dlp.DeleteDeidentifyTemplateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
from google.cloud import dlp_v2
def sample_delete_deidentify_template():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.DeleteDeidentifyTemplateRequest(
name="name_value",
)
# Make the request
client.delete_deidentify_template(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.DeleteDeidentifyTemplateRequest, dict]
The request object. Request message for DeleteDeidentifyTemplate. |
name |
Required. Resource name of the organization and deidentify template to be deleted, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
delete_dlp_job
delete_dlp_job(request: Optional[Union[google.cloud.dlp_v2.types.dlp.DeleteDlpJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_delete_dlp_job():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.DeleteDlpJobRequest(
name="name_value",
)
# Make the request
client.delete_dlp_job(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.DeleteDlpJobRequest, dict]
The request object. The request message for deleting a DLP job. |
name |
Required. The name of the DlpJob resource to be deleted. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
delete_inspect_template
delete_inspect_template(request: Optional[Union[google.cloud.dlp_v2.types.dlp.DeleteInspectTemplateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
from google.cloud import dlp_v2
def sample_delete_inspect_template():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.DeleteInspectTemplateRequest(
name="name_value",
)
# Make the request
client.delete_inspect_template(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.DeleteInspectTemplateRequest, dict]
The request object. Request message for DeleteInspectTemplate. |
name |
Required. Resource name of the organization and inspectTemplate to be deleted, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
delete_job_trigger
delete_job_trigger(request: Optional[Union[google.cloud.dlp_v2.types.dlp.DeleteJobTriggerRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
from google.cloud import dlp_v2
def sample_delete_job_trigger():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.DeleteJobTriggerRequest(
name="name_value",
)
# Make the request
client.delete_job_trigger(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.DeleteJobTriggerRequest, dict]
The request object. Request message for DeleteJobTrigger. |
name |
Required. Resource name of the project and the triggeredJob, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
delete_stored_info_type
delete_stored_info_type(request: Optional[Union[google.cloud.dlp_v2.types.dlp.DeleteStoredInfoTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
from google.cloud import dlp_v2
def sample_delete_stored_info_type():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.DeleteStoredInfoTypeRequest(
name="name_value",
)
# Make the request
client.delete_stored_info_type(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.DeleteStoredInfoTypeRequest, dict]
The request object. Request message for DeleteStoredInfoType. |
name |
Required. Resource name of the organization and storedInfoType to be deleted, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
dlp_content_path
dlp_content_path(project: str)Returns a fully-qualified dlp_content string.
dlp_job_path
dlp_job_path(project: str, dlp_job: str)Returns a fully-qualified dlp_job string.
finding_path
finding_path(project: str, location: str, finding: str)Returns a fully-qualified finding string.
finish_dlp_job
finish_dlp_job(request: Optional[Union[google.cloud.dlp_v2.types.dlp.FinishDlpJobRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run.
from google.cloud import dlp_v2
def sample_finish_dlp_job():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.FinishDlpJobRequest(
name="name_value",
)
# Make the request
client.finish_dlp_job(request=request)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.FinishDlpJobRequest, dict]
The request object. The request message for finishing a DLP hybrid job. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
from_service_account_file
from_service_account_file(filename: str, *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 |
DlpServiceAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
DlpServiceAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *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 |
DlpServiceAsyncClient | The constructed client. |
get_deidentify_template
get_deidentify_template(request: Optional[Union[google.cloud.dlp_v2.types.dlp.GetDeidentifyTemplateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
from google.cloud import dlp_v2
def sample_get_deidentify_template():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.GetDeidentifyTemplateRequest(
name="name_value",
)
# Make the request
response = client.get_deidentify_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.GetDeidentifyTemplateRequest, dict]
The request object. Request message for GetDeidentifyTemplate. |
name |
Required. Resource name of the organization and deidentify template to be read, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.DeidentifyTemplate | DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. |
get_dlp_job
get_dlp_job(request: Optional[Union[google.cloud.dlp_v2.types.dlp.GetDlpJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_get_dlp_job():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.GetDlpJobRequest(
name="name_value",
)
# Make the request
response = client.get_dlp_job(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.GetDlpJobRequest, dict]
The request object. The request message for [DlpJobs.GetDlpJob][]. |
name |
Required. The name of the DlpJob resource. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.DlpJob | Combines all of the information about a DLP job. |
get_inspect_template
get_inspect_template(request: Optional[Union[google.cloud.dlp_v2.types.dlp.GetInspectTemplateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
from google.cloud import dlp_v2
def sample_get_inspect_template():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.GetInspectTemplateRequest(
name="name_value",
)
# Make the request
response = client.get_inspect_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.GetInspectTemplateRequest, dict]
The request object. Request message for GetInspectTemplate. |
name |
Required. Resource name of the organization and inspectTemplate to be read, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.InspectTemplate | The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. |
get_job_trigger
get_job_trigger(request: Optional[Union[google.cloud.dlp_v2.types.dlp.GetJobTriggerRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
from google.cloud import dlp_v2
def sample_get_job_trigger():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.GetJobTriggerRequest(
name="name_value",
)
# Make the request
response = client.get_job_trigger(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.GetJobTriggerRequest, dict]
The request object. Request message for GetJobTrigger. |
name |
Required. Resource name of the project and the triggeredJob, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.JobTrigger | Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_stored_info_type
get_stored_info_type(request: Optional[Union[google.cloud.dlp_v2.types.dlp.GetStoredInfoTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
from google.cloud import dlp_v2
def sample_get_stored_info_type():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.GetStoredInfoTypeRequest(
name="name_value",
)
# Make the request
response = client.get_stored_info_type(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.GetStoredInfoTypeRequest, dict]
The request object. Request message for GetStoredInfoType. |
name |
Required. Resource name of the organization and storedInfoType to be read, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.StoredInfoType | StoredInfoType resource message that contains information about the current version and any pending updates. |
get_transport_class
get_transport_class()Returns an appropriate transport class.
hybrid_inspect_dlp_job
hybrid_inspect_dlp_job(request: Optional[Union[google.cloud.dlp_v2.types.dlp.HybridInspectDlpJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.
from google.cloud import dlp_v2
def sample_hybrid_inspect_dlp_job():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.HybridInspectDlpJobRequest(
name="name_value",
)
# Make the request
response = client.hybrid_inspect_dlp_job(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.HybridInspectDlpJobRequest, dict]
The request object. Request to search for potentially sensitive info in a custom location. |
name |
Required. Resource name of the job to execute a hybrid inspect on, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.HybridInspectResponse | Quota exceeded errors will be thrown once quota has been met. |
hybrid_inspect_job_trigger
hybrid_inspect_job_trigger(request: Optional[Union[google.cloud.dlp_v2.types.dlp.HybridInspectJobTriggerRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_hybrid_inspect_job_trigger():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.HybridInspectJobTriggerRequest(
name="name_value",
)
# Make the request
response = client.hybrid_inspect_job_trigger(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.HybridInspectJobTriggerRequest, dict]
The request object. Request to search for potentially sensitive info in a custom location. |
name |
Required. Resource name of the trigger to execute a hybrid inspect on, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.HybridInspectResponse | Quota exceeded errors will be thrown once quota has been met. |
inspect_content
inspect_content(request: Optional[Union[google.cloud.dlp_v2.types.dlp.InspectContentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. 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. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,
from google.cloud import dlp_v2
def sample_inspect_content():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.InspectContentRequest(
)
# Make the request
response = client.inspect_content(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.InspectContentRequest, dict]
The request object. Request to search for potentially sensitive info in a ContentItem. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.InspectContentResponse | Results of inspecting an item. |
inspect_template_path
inspect_template_path(organization: str, inspect_template: str)Returns a fully-qualified inspect_template string.
job_trigger_path
job_trigger_path(project: str, job_trigger: str)Returns a fully-qualified job_trigger string.
list_deidentify_templates
list_deidentify_templates(request: Optional[Union[google.cloud.dlp_v2.types.dlp.ListDeidentifyTemplatesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
from google.cloud import dlp_v2
def sample_list_deidentify_templates():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.ListDeidentifyTemplatesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_deidentify_templates(request=request)
# Handle the response
for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.ListDeidentifyTemplatesRequest, dict]
The request object. Request message for ListDeidentifyTemplates. |
parent |
Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.services.dlp_service.pagers.ListDeidentifyTemplatesAsyncPager | Response message for ListDeidentifyTemplates. Iterating over this object will yield results and resolve additional pages automatically. |
list_dlp_jobs
list_dlp_jobs(request: Optional[Union[google.cloud.dlp_v2.types.dlp.ListDlpJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_list_dlp_jobs():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.ListDlpJobsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_dlp_jobs(request=request)
# Handle the response
for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.ListDlpJobsRequest, dict]
The request object. The request message for listing DLP jobs. |
parent |
Required. Parent resource name. The format of this value varies depending on whether you have |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.services.dlp_service.pagers.ListDlpJobsAsyncPager | The response message for listing DLP jobs. Iterating over this object will yield results and resolve additional pages automatically. |
list_info_types
list_info_types(request: Optional[Union[google.cloud.dlp_v2.types.dlp.ListInfoTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_list_info_types():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.ListInfoTypesRequest(
)
# Make the request
response = client.list_info_types(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.ListInfoTypesRequest, dict]
The request object. Request for the list of infoTypes. |
parent |
The parent resource name. The format of this value is as follows: :: locations/LOCATION_ID This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.ListInfoTypesResponse | Response to the ListInfoTypes request. |
list_inspect_templates
list_inspect_templates(request: Optional[Union[google.cloud.dlp_v2.types.dlp.ListInspectTemplatesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
from google.cloud import dlp_v2
def sample_list_inspect_templates():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.ListInspectTemplatesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_inspect_templates(request=request)
# Handle the response
for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.ListInspectTemplatesRequest, dict]
The request object. Request message for ListInspectTemplates. |
parent |
Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.services.dlp_service.pagers.ListInspectTemplatesAsyncPager | Response message for ListInspectTemplates. Iterating over this object will yield results and resolve additional pages automatically. |
list_job_triggers
list_job_triggers(request: Optional[Union[google.cloud.dlp_v2.types.dlp.ListJobTriggersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
from google.cloud import dlp_v2
def sample_list_job_triggers():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.ListJobTriggersRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_job_triggers(request=request)
# Handle the response
for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.ListJobTriggersRequest, dict]
The request object. Request message for ListJobTriggers. |
parent |
Required. Parent resource name. The format of this value varies depending on whether you have |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.services.dlp_service.pagers.ListJobTriggersAsyncPager | Response message for ListJobTriggers. Iterating over this object will yield results and resolve additional pages automatically. |
list_stored_info_types
list_stored_info_types(request: Optional[Union[google.cloud.dlp_v2.types.dlp.ListStoredInfoTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
from google.cloud import dlp_v2
def sample_list_stored_info_types():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.ListStoredInfoTypesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_stored_info_types(request=request)
# Handle the response
for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.ListStoredInfoTypesRequest, dict]
The request object. Request message for ListStoredInfoTypes. |
parent |
Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.services.dlp_service.pagers.ListStoredInfoTypesAsyncPager | Response message for ListStoredInfoTypes. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_deidentify_template_path
parse_deidentify_template_path(path: str)Parses a deidentify_template path into its component segments.
parse_dlp_content_path
parse_dlp_content_path(path: str)Parses a dlp_content path into its component segments.
parse_dlp_job_path
parse_dlp_job_path(path: str)Parses a dlp_job path into its component segments.
parse_finding_path
parse_finding_path(path: str)Parses a finding path into its component segments.
parse_inspect_template_path
parse_inspect_template_path(path: str)Parses a inspect_template path into its component segments.
parse_job_trigger_path
parse_job_trigger_path(path: str)Parses a job_trigger path into its component segments.
parse_stored_info_type_path
parse_stored_info_type_path(path: str)Parses a stored_info_type path into its component segments.
redact_image
redact_image(request: Optional[Union[google.cloud.dlp_v2.types.dlp.RedactImageRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
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.
from google.cloud import dlp_v2
def sample_redact_image():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.RedactImageRequest(
)
# Make the request
response = client.redact_image(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.RedactImageRequest, dict]
The request object. Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.RedactImageResponse | Results of redacting an image. |
reidentify_content
reidentify_content(request: Optional[Union[google.cloud.dlp_v2.types.dlp.ReidentifyContentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_reidentify_content():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.ReidentifyContentRequest(
parent="parent_value",
)
# Make the request
response = client.reidentify_content(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.ReidentifyContentRequest, dict]
The request object. Request to re-identify an item. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.ReidentifyContentResponse | Results of re-identifying a item. |
stored_info_type_path
stored_info_type_path(organization: str, stored_info_type: str)Returns a fully-qualified stored_info_type string.
update_deidentify_template
update_deidentify_template(request: Optional[Union[google.cloud.dlp_v2.types.dlp.UpdateDeidentifyTemplateRequest, dict]] = None, *, name: Optional[str] = None, deidentify_template: Optional[google.cloud.dlp_v2.types.dlp.DeidentifyTemplate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
from google.cloud import dlp_v2
def sample_update_deidentify_template():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.UpdateDeidentifyTemplateRequest(
name="name_value",
)
# Make the request
response = client.update_deidentify_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.UpdateDeidentifyTemplateRequest, dict]
The request object. Request message for UpdateDeidentifyTemplate. |
name |
Required. Resource name of organization and deidentify template to be updated, for example |
deidentify_template |
DeidentifyTemplate
New DeidentifyTemplate value. This corresponds to the |
update_mask |
Mask to control which fields get updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.DeidentifyTemplate | DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. |
update_inspect_template
update_inspect_template(request: Optional[Union[google.cloud.dlp_v2.types.dlp.UpdateInspectTemplateRequest, dict]] = None, *, name: Optional[str] = None, inspect_template: Optional[google.cloud.dlp_v2.types.dlp.InspectTemplate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
from google.cloud import dlp_v2
def sample_update_inspect_template():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.UpdateInspectTemplateRequest(
name="name_value",
)
# Make the request
response = client.update_inspect_template(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.UpdateInspectTemplateRequest, dict]
The request object. Request message for UpdateInspectTemplate. |
name |
Required. Resource name of organization and inspectTemplate to be updated, for example |
inspect_template |
InspectTemplate
New InspectTemplate value. This corresponds to the |
update_mask |
Mask to control which fields get updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.InspectTemplate | The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. |
update_job_trigger
update_job_trigger(request: Optional[Union[google.cloud.dlp_v2.types.dlp.UpdateJobTriggerRequest, dict]] = None, *, name: Optional[str] = None, job_trigger: Optional[google.cloud.dlp_v2.types.dlp.JobTrigger] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
from google.cloud import dlp_v2
def sample_update_job_trigger():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.UpdateJobTriggerRequest(
name="name_value",
)
# Make the request
response = client.update_job_trigger(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.UpdateJobTriggerRequest, dict]
The request object. Request message for UpdateJobTrigger. |
name |
Required. Resource name of the project and the triggeredJob, for example |
job_trigger |
JobTrigger
New JobTrigger value. This corresponds to the |
update_mask |
Mask to control which fields get updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.JobTrigger | Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. |
update_stored_info_type
update_stored_info_type(request: Optional[Union[google.cloud.dlp_v2.types.dlp.UpdateStoredInfoTypeRequest, dict]] = None, *, name: Optional[str] = None, config: Optional[google.cloud.dlp_v2.types.dlp.StoredInfoTypeConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
from google.cloud import dlp_v2
def sample_update_stored_info_type():
# Create a client
client = dlp_v2.DlpServiceClient()
# Initialize request argument(s)
request = dlp_v2.UpdateStoredInfoTypeRequest(
name="name_value",
)
# Make the request
response = client.update_stored_info_type(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.dlp_v2.types.UpdateStoredInfoTypeRequest, dict]
The request object. Request message for UpdateStoredInfoType. |
name |
Required. Resource name of organization and storedInfoType to be updated, for example |
config |
StoredInfoTypeConfig
Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. This corresponds to the |
update_mask |
Mask to control which fields get updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dlp_v2.types.StoredInfoType | StoredInfoType resource message that contains information about the current version and any pending updates. |