Data Loss Prevention V2 Client - Class DlpServiceClient (1.10.2)

Reference documentation and code samples for the Data Loss Prevention V2 Client class DlpServiceClient.

Service Description: 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/.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Dlp\V2\DlpServiceClient for the stable implementation

Namespace

Google \ Cloud \ Dlp \ V2 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

activateJobTrigger

Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::activateJobTriggerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ActivateJobTriggerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\DlpJob`

cancelDlpJob

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::cancelDlpJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CancelDlpJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

createDeidentifyTemplate

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::createDeidentifyTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateDeidentifyTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\DeidentifyTemplate`

createDlpJob

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::createDlpJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateDlpJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\DlpJob`

createInspectTemplate

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::createInspectTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateInspectTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\InspectTemplate`

createJobTrigger

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::createJobTriggerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateJobTriggerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\JobTrigger`

createStoredInfoType

Creates a pre-built stored infoType to be used for inspection.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::createStoredInfoTypeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateStoredInfoTypeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\StoredInfoType`

deidentifyContent

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::deidentifyContentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeidentifyContentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\DeidentifyContentResponse`

deleteDeidentifyTemplate

Deletes a DeidentifyTemplate.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::deleteDeidentifyTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteDeidentifyTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteDlpJob

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible.

See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::deleteDlpJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteDlpJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteInspectTemplate

Deletes an InspectTemplate.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::deleteInspectTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteInspectTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteJobTrigger

Deletes a job trigger.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::deleteJobTriggerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteJobTriggerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteStoredInfoType

Deletes a stored infoType.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::deleteStoredInfoTypeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteStoredInfoTypeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

finishDlpJob

Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::finishDlpJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\FinishDlpJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getDeidentifyTemplate

Gets a DeidentifyTemplate.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::getDeidentifyTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetDeidentifyTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\DeidentifyTemplate`

getDlpJob

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::getDlpJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetDlpJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\DlpJob`

getInspectTemplate

Gets an InspectTemplate.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::getInspectTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetInspectTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\InspectTemplate`

getJobTrigger

Gets a job trigger.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::getJobTriggerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetJobTriggerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\JobTrigger`

getStoredInfoType

Gets a stored infoType.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::getStoredInfoTypeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetStoredInfoTypeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\StoredInfoType`

hybridInspectDlpJob

Inspect hybrid content and store findings to a job.

To review the findings, inspect the job. Inspection will occur asynchronously.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::hybridInspectDlpJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\HybridInspectDlpJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\HybridInspectResponse`

hybridInspectJobTrigger

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::hybridInspectJobTriggerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\HybridInspectJobTriggerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\HybridInspectResponse`

inspectContent

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,

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::inspectContentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\InspectContentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\InspectContentResponse`

listDeidentifyTemplates

Lists DeidentifyTemplates.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::listDeidentifyTemplatesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListDeidentifyTemplatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listDlpJobs

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::listDlpJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListDlpJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listInfoTypes

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::listInfoTypesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListInfoTypesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\ListInfoTypesResponse`

listInspectTemplates

Lists InspectTemplates.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::listInspectTemplatesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListInspectTemplatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listJobTriggers

Lists job triggers.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::listJobTriggersAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListJobTriggersRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listStoredInfoTypes

Lists stored infoTypes.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::listStoredInfoTypesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListStoredInfoTypesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

redactImage

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::redactImageAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\RedactImageRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\RedactImageResponse`

reidentifyContent

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::reidentifyContentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ReidentifyContentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\ReidentifyContentResponse`

updateDeidentifyTemplate

Updates the DeidentifyTemplate.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::updateDeidentifyTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\UpdateDeidentifyTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\DeidentifyTemplate`

updateInspectTemplate

Updates the InspectTemplate.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::updateInspectTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\UpdateInspectTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\InspectTemplate`

updateJobTrigger

Updates a job trigger.

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

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::updateJobTriggerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\UpdateJobTriggerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\JobTrigger`

updateStoredInfoType

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.

The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::updateStoredInfoTypeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\UpdateStoredInfoTypeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Dlp\V2\StoredInfoType`

activateJobTriggerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ActivateJobTriggerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

cancelDlpJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CancelDlpJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createDeidentifyTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateDeidentifyTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createDlpJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateDlpJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createInspectTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateInspectTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createJobTriggerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateJobTriggerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createStoredInfoTypeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\CreateStoredInfoTypeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deidentifyContentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeidentifyContentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDeidentifyTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteDeidentifyTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDlpJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteDlpJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteInspectTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteInspectTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteJobTriggerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteJobTriggerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteStoredInfoTypeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\DeleteStoredInfoTypeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

finishDlpJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\FinishDlpJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDeidentifyTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetDeidentifyTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDlpJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetDlpJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getInspectTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetInspectTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getJobTriggerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetJobTriggerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getStoredInfoTypeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\GetStoredInfoTypeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

hybridInspectDlpJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\HybridInspectDlpJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

hybridInspectJobTriggerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\HybridInspectJobTriggerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

inspectContentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\InspectContentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDeidentifyTemplatesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListDeidentifyTemplatesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDlpJobsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListDlpJobsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listInfoTypesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListInfoTypesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listInspectTemplatesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListInspectTemplatesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listJobTriggersAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListJobTriggersRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listStoredInfoTypesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ListStoredInfoTypesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

redactImageAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\RedactImageRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

reidentifyContentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\ReidentifyContentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateDeidentifyTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\UpdateDeidentifyTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateInspectTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\UpdateInspectTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateJobTriggerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\UpdateJobTriggerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateStoredInfoTypeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dlp\V2\UpdateStoredInfoTypeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::deidentifyTemplateName

Formats a string containing the fully-qualified path to represent a deidentify_template resource.

Parameters
Name	Description
`organization`	`string`
`deidentifyTemplate`	`string`

Returns
Type	Description
`string`	The formatted deidentify_template resource.

static::dlpJobName

Formats a string containing the fully-qualified path to represent a dlp_job resource.

Parameters
Name	Description
`project`	`string`
`dlpJob`	`string`

Returns
Type	Description
`string`	The formatted dlp_job resource.

static::inspectTemplateName

Formats a string containing the fully-qualified path to represent a inspect_template resource.

Parameters
Name	Description
`organization`	`string`
`inspectTemplate`	`string`

Returns
Type	Description
`string`	The formatted inspect_template resource.

static::jobTriggerName

Formats a string containing the fully-qualified path to represent a job_trigger resource.

Parameters
Name	Description
`project`	`string`
`jobTrigger`	`string`

Returns
Type	Description
`string`	The formatted job_trigger resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::organizationName

Formats a string containing the fully-qualified path to represent a organization resource.

Parameter
Name	Description
`organization`	`string`

Returns
Type	Description
`string`	The formatted organization resource.

static::organizationDeidentifyTemplateName

Formats a string containing the fully-qualified path to represent a organization_deidentify_template resource.

Parameters
Name	Description
`organization`	`string`
`deidentifyTemplate`	`string`

Returns
Type	Description
`string`	The formatted organization_deidentify_template resource.

static::organizationInspectTemplateName

Formats a string containing the fully-qualified path to represent a organization_inspect_template resource.

Parameters
Name	Description
`organization`	`string`
`inspectTemplate`	`string`

Returns
Type	Description
`string`	The formatted organization_inspect_template resource.

static::organizationLocationName

Formats a string containing the fully-qualified path to represent a organization_location resource.

Parameters
Name	Description
`organization`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted organization_location resource.

static::organizationLocationDeidentifyTemplateName

Formats a string containing the fully-qualified path to represent a organization_location_deidentify_template resource.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`deidentifyTemplate`	`string`

Returns
Type	Description
`string`	The formatted organization_location_deidentify_template resource.

static::organizationLocationInspectTemplateName

Formats a string containing the fully-qualified path to represent a organization_location_inspect_template resource.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`inspectTemplate`	`string`

Returns
Type	Description
`string`	The formatted organization_location_inspect_template resource.

static::organizationLocationStoredInfoTypeName

Formats a string containing the fully-qualified path to represent a organization_location_stored_info_type resource.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`storedInfoType`	`string`

Returns
Type	Description
`string`	The formatted organization_location_stored_info_type resource.

static::organizationStoredInfoTypeName

Formats a string containing the fully-qualified path to represent a organization_stored_info_type resource.

Parameters
Name	Description
`organization`	`string`
`storedInfoType`	`string`

Returns
Type	Description
`string`	The formatted organization_stored_info_type resource.

static::projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::projectDeidentifyTemplateName

Formats a string containing the fully-qualified path to represent a project_deidentify_template resource.

Parameters
Name	Description
`project`	`string`
`deidentifyTemplate`	`string`

Returns
Type	Description
`string`	The formatted project_deidentify_template resource.

static::projectDlpJobName

Formats a string containing the fully-qualified path to represent a project_dlp_job resource.

Parameters
Name	Description
`project`	`string`
`dlpJob`	`string`

Returns
Type	Description
`string`	The formatted project_dlp_job resource.

static::projectInspectTemplateName

Formats a string containing the fully-qualified path to represent a project_inspect_template resource.

Parameters
Name	Description
`project`	`string`
`inspectTemplate`	`string`

Returns
Type	Description
`string`	The formatted project_inspect_template resource.

static::projectJobTriggerName

Formats a string containing the fully-qualified path to represent a project_job_trigger resource.

Parameters
Name	Description
`project`	`string`
`jobTrigger`	`string`

Returns
Type	Description
`string`	The formatted project_job_trigger resource.

static::projectLocationDeidentifyTemplateName

Formats a string containing the fully-qualified path to represent a project_location_deidentify_template resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`deidentifyTemplate`	`string`

Returns
Type	Description
`string`	The formatted project_location_deidentify_template resource.

static::projectLocationDlpJobName

Formats a string containing the fully-qualified path to represent a project_location_dlp_job resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dlpJob`	`string`

Returns
Type	Description
`string`	The formatted project_location_dlp_job resource.

static::projectLocationInspectTemplateName

Formats a string containing the fully-qualified path to represent a project_location_inspect_template resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`inspectTemplate`	`string`

Returns
Type	Description
`string`	The formatted project_location_inspect_template resource.

static::projectLocationJobTriggerName

Formats a string containing the fully-qualified path to represent a project_location_job_trigger resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`jobTrigger`	`string`

Returns
Type	Description
`string`	The formatted project_location_job_trigger resource.

static::projectLocationStoredInfoTypeName

Formats a string containing the fully-qualified path to represent a project_location_stored_info_type resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`storedInfoType`	`string`

Returns
Type	Description
`string`	The formatted project_location_stored_info_type resource.

static::projectStoredInfoTypeName

Formats a string containing the fully-qualified path to represent a project_stored_info_type resource.

Parameters
Name	Description
`project`	`string`
`storedInfoType`	`string`

Returns
Type	Description
`string`	The formatted project_stored_info_type resource.

static::storedInfoTypeName

Formats a string containing the fully-qualified path to represent a stored_info_type resource.

Parameters
Name	Description
`organization`	`string`
`storedInfoType`	`string`

Returns
Type	Description
`string`	The formatted stored_info_type resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

deidentifyTemplate: organizations/{organization}/deidentifyTemplates/{deidentify_template}
dlpJob: projects/{project}/dlpJobs/{dlp_job}
inspectTemplate: organizations/{organization}/inspectTemplates/{inspect_template}
jobTrigger: projects/{project}/jobTriggers/{job_trigger}
location: projects/{project}/locations/{location}
organization: organizations/{organization}
organizationDeidentifyTemplate: organizations/{organization}/deidentifyTemplates/{deidentify_template}
organizationInspectTemplate: organizations/{organization}/inspectTemplates/{inspect_template}
organizationLocation: organizations/{organization}/locations/{location}
organizationLocationDeidentifyTemplate: organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}
organizationLocationInspectTemplate: organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}
organizationLocationStoredInfoType: organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
organizationStoredInfoType: organizations/{organization}/storedInfoTypes/{stored_info_type}
project: projects/{project}
projectDeidentifyTemplate: projects/{project}/deidentifyTemplates/{deidentify_template}
projectDlpJob: projects/{project}/dlpJobs/{dlp_job}
projectInspectTemplate: projects/{project}/inspectTemplates/{inspect_template}
projectJobTrigger: projects/{project}/jobTriggers/{job_trigger}
projectLocationDeidentifyTemplate: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}
projectLocationDlpJob: projects/{project}/locations/{location}/dlpJobs/{dlp_job}
projectLocationInspectTemplate: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
projectLocationJobTrigger: projects/{project}/locations/{location}/jobTriggers/{job_trigger}
projectLocationStoredInfoType: projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}
projectStoredInfoType: projects/{project}/storedInfoTypes/{stored_info_type}
storedInfoType: organizations/{organization}/storedInfoTypes/{stored_info_type}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.