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 \ ClientMethods
__construct
Constructor.
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() .
request
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.
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() .
request
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() .
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.
createDiscoveryConfig
Creates a config for discovery to scan and profile storage.
The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::createDiscoveryConfigAsync() .
request
Google\Cloud\Dlp\V2\CreateDiscoveryConfigRequest
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.
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() .
request
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.
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() .
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
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.
deleteDiscoveryConfig
Deletes a discovery configuration.
The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::deleteDiscoveryConfigAsync() .
request
Google\Cloud\Dlp\V2\DeleteDiscoveryConfigRequest
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() .
request
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() .
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() .
request
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() .
request
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() .
request
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() .
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.
getDiscoveryConfig
Gets a discovery configuration.
The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::getDiscoveryConfigAsync() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
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.
inspectContent
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 ,
The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::inspectContentAsync() .
request
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.
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() .
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.
listDiscoveryConfigs
Lists discovery configurations.
The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::listDiscoveryConfigsAsync() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
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.
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::redactImageAsync() .
request
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.
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() .
request
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.
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() .
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.
updateDiscoveryConfig
Updates a discovery configuration.
The async variant is Google\Cloud\Dlp\V2\Client\DlpServiceClient::updateDiscoveryConfigAsync() .
request
Google\Cloud\Dlp\V2\UpdateDiscoveryConfigRequest
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.
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() .
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.
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() .
request
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.
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() .
request
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.
activateJobTriggerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
cancelDlpJobAsync
GuzzleHttp\Promise\PromiseInterface
createDeidentifyTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createDiscoveryConfigAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createDlpJobAsync
GuzzleHttp\Promise\PromiseInterface
createInspectTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createJobTriggerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createStoredInfoTypeAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deidentifyContentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteDeidentifyTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteDiscoveryConfigAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteDlpJobAsync
GuzzleHttp\Promise\PromiseInterface
deleteInspectTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteJobTriggerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteStoredInfoTypeAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
finishDlpJobAsync
GuzzleHttp\Promise\PromiseInterface
getDeidentifyTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getDiscoveryConfigAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getDlpJobAsync
GuzzleHttp\Promise\PromiseInterface
getInspectTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getJobTriggerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getStoredInfoTypeAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
hybridInspectDlpJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
hybridInspectJobTriggerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
inspectContentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listDeidentifyTemplatesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listDiscoveryConfigsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listDlpJobsAsync
GuzzleHttp\Promise\PromiseInterface
listInfoTypesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listInspectTemplatesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listJobTriggersAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listStoredInfoTypesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
redactImageAsync
GuzzleHttp\Promise\PromiseInterface
reidentifyContentAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateDeidentifyTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateDiscoveryConfigAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateInspectTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateJobTriggerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateStoredInfoTypeAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::deidentifyTemplateName
Formats a string containing the fully-qualified path to represent a deidentify_template resource.
organization
string
deidentifyTemplate
string
string
static::discoveryConfigName
Formats a string containing the fully-qualified path to represent a discovery_config resource.
project
string
location
string
discoveryConfig
string
string
static::dlpJobName
Formats a string containing the fully-qualified path to represent a dlp_job resource.
project
string
dlpJob
string
string
static::inspectTemplateName
Formats a string containing the fully-qualified path to represent a inspect_template resource.
organization
string
inspectTemplate
string
string
static::jobTriggerName
Formats a string containing the fully-qualified path to represent a job_trigger resource.
project
string
jobTrigger
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::organizationName
Formats a string containing the fully-qualified path to represent a organization resource.
organization
string
string
static::organizationDeidentifyTemplateName
Formats a string containing the fully-qualified path to represent a organization_deidentify_template resource.
organization
string
deidentifyTemplate
string
string
static::organizationInspectTemplateName
Formats a string containing the fully-qualified path to represent a organization_inspect_template resource.
organization
string
inspectTemplate
string
string
static::organizationLocationName
Formats a string containing the fully-qualified path to represent a organization_location resource.
organization
string
location
string
string
static::organizationLocationDeidentifyTemplateName
Formats a string containing the fully-qualified path to represent a organization_location_deidentify_template resource.
organization
string
location
string
deidentifyTemplate
string
string
static::organizationLocationInspectTemplateName
Formats a string containing the fully-qualified path to represent a organization_location_inspect_template resource.
organization
string
location
string
inspectTemplate
string
string
static::organizationLocationStoredInfoTypeName
Formats a string containing the fully-qualified path to represent a organization_location_stored_info_type resource.
organization
string
location
string
storedInfoType
string
string
static::organizationStoredInfoTypeName
Formats a string containing the fully-qualified path to represent a organization_stored_info_type resource.
organization
string
storedInfoType
string
string
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
project
string
string
static::projectDeidentifyTemplateName
Formats a string containing the fully-qualified path to represent a project_deidentify_template resource.
project
string
deidentifyTemplate
string
string
static::projectDlpJobName
Formats a string containing the fully-qualified path to represent a project_dlp_job resource.
project
string
dlpJob
string
string
static::projectInspectTemplateName
Formats a string containing the fully-qualified path to represent a project_inspect_template resource.
project
string
inspectTemplate
string
string
static::projectJobTriggerName
Formats a string containing the fully-qualified path to represent a project_job_trigger resource.
project
string
jobTrigger
string
string
static::projectLocationDeidentifyTemplateName
Formats a string containing the fully-qualified path to represent a project_location_deidentify_template resource.
project
string
location
string
deidentifyTemplate
string
string
static::projectLocationDlpJobName
Formats a string containing the fully-qualified path to represent a project_location_dlp_job resource.
project
string
location
string
dlpJob
string
string
static::projectLocationInspectTemplateName
Formats a string containing the fully-qualified path to represent a project_location_inspect_template resource.
project
string
location
string
inspectTemplate
string
string
static::projectLocationJobTriggerName
Formats a string containing the fully-qualified path to represent a project_location_job_trigger resource.
project
string
location
string
jobTrigger
string
string
static::projectLocationStoredInfoTypeName
Formats a string containing the fully-qualified path to represent a project_location_stored_info_type resource.
project
string
location
string
storedInfoType
string
string
static::projectStoredInfoTypeName
Formats a string containing the fully-qualified path to represent a project_stored_info_type resource.
project
string
storedInfoType
string
string
static::storedInfoTypeName
Formats a string containing the fully-qualified path to represent a stored_info_type resource.
organization
string
storedInfoType
string
string
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}
- discoveryConfig: projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}
- 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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
