Class DlpServiceClient (3.46.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

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/sensitive-data-protection/docs/.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   InspectContentRequest request =
       InspectContentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInspectConfig(InspectConfig.newBuilder().build())
           .setItem(ContentItem.newBuilder().build())
           .setInspectTemplateName("inspectTemplateName1828857433")
           .setLocationId("locationId1541836720")
           .build();
   InspectContentResponse response = dlpServiceClient.inspectContent(request);
 }

Note: close() needs to be called on the DlpServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

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/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • inspectContent(InspectContentRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • inspectContentCallable()

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/sensitive-data-protection/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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • redactImage(RedactImageRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • redactImageCallable()

DeidentifyContent

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deidentifyContent(DeidentifyContentRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deidentifyContentCallable()

ReidentifyContent

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • reidentifyContent(ReidentifyContentRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • reidentifyContentCallable()

ListInfoTypes

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInfoTypes(ListInfoTypesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listInfoTypes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listInfoTypesCallable()

CreateInspectTemplate

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createInspectTemplate(CreateInspectTemplateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createInspectTemplate(LocationName parent, InspectTemplate inspectTemplate)

  • createInspectTemplate(OrganizationLocationName parent, InspectTemplate inspectTemplate)

  • createInspectTemplate(OrganizationName parent, InspectTemplate inspectTemplate)

  • createInspectTemplate(ProjectName parent, InspectTemplate inspectTemplate)

  • createInspectTemplate(String parent, InspectTemplate inspectTemplate)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createInspectTemplateCallable()

UpdateInspectTemplate

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateInspectTemplate(UpdateInspectTemplateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateInspectTemplate(InspectTemplateName name, InspectTemplate inspectTemplate, FieldMask updateMask)

  • updateInspectTemplate(String name, InspectTemplate inspectTemplate, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateInspectTemplateCallable()

GetInspectTemplate

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getInspectTemplate(GetInspectTemplateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getInspectTemplate(InspectTemplateName name)

  • getInspectTemplate(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getInspectTemplateCallable()

ListInspectTemplates

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInspectTemplates(ListInspectTemplatesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listInspectTemplates(LocationName parent)

  • listInspectTemplates(OrganizationLocationName parent)

  • listInspectTemplates(OrganizationName parent)

  • listInspectTemplates(ProjectName parent)

  • listInspectTemplates(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listInspectTemplatesPagedCallable()

  • listInspectTemplatesCallable()

DeleteInspectTemplate

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteInspectTemplate(DeleteInspectTemplateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteInspectTemplate(InspectTemplateName name)

  • deleteInspectTemplate(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteInspectTemplateCallable()

CreateDeidentifyTemplate

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDeidentifyTemplate(CreateDeidentifyTemplateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDeidentifyTemplate(LocationName parent, DeidentifyTemplate deidentifyTemplate)

  • createDeidentifyTemplate(OrganizationLocationName parent, DeidentifyTemplate deidentifyTemplate)

  • createDeidentifyTemplate(OrganizationName parent, DeidentifyTemplate deidentifyTemplate)

  • createDeidentifyTemplate(ProjectName parent, DeidentifyTemplate deidentifyTemplate)

  • createDeidentifyTemplate(String parent, DeidentifyTemplate deidentifyTemplate)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDeidentifyTemplateCallable()

UpdateDeidentifyTemplate

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDeidentifyTemplate(DeidentifyTemplateName name, DeidentifyTemplate deidentifyTemplate, FieldMask updateMask)

  • updateDeidentifyTemplate(String name, DeidentifyTemplate deidentifyTemplate, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDeidentifyTemplateCallable()

GetDeidentifyTemplate

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDeidentifyTemplate(GetDeidentifyTemplateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDeidentifyTemplate(DeidentifyTemplateName name)

  • getDeidentifyTemplate(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDeidentifyTemplateCallable()

ListDeidentifyTemplates

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDeidentifyTemplates(ListDeidentifyTemplatesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDeidentifyTemplates(LocationName parent)

  • listDeidentifyTemplates(OrganizationLocationName parent)

  • listDeidentifyTemplates(OrganizationName parent)

  • listDeidentifyTemplates(ProjectName parent)

  • listDeidentifyTemplates(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDeidentifyTemplatesPagedCallable()

  • listDeidentifyTemplatesCallable()

DeleteDeidentifyTemplate

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDeidentifyTemplate(DeidentifyTemplateName name)

  • deleteDeidentifyTemplate(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDeidentifyTemplateCallable()

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/sensitive-data-protection/docs/creating-job-triggers to learn more.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createJobTrigger(CreateJobTriggerRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createJobTrigger(LocationName parent, JobTrigger jobTrigger)

  • createJobTrigger(ProjectName parent, JobTrigger jobTrigger)

  • createJobTrigger(String parent, JobTrigger jobTrigger)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createJobTriggerCallable()

UpdateJobTrigger

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateJobTrigger(UpdateJobTriggerRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateJobTrigger(JobTriggerName name, JobTrigger jobTrigger, FieldMask updateMask)

  • updateJobTrigger(String name, JobTrigger jobTrigger, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateJobTriggerCallable()

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • hybridInspectJobTrigger(HybridInspectJobTriggerRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • hybridInspectJobTrigger(JobTriggerName name)

  • hybridInspectJobTrigger(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • hybridInspectJobTriggerCallable()

GetJobTrigger

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getJobTrigger(GetJobTriggerRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getJobTrigger(JobTriggerName name)

  • getJobTrigger(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getJobTriggerCallable()

ListJobTriggers

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listJobTriggers(ListJobTriggersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listJobTriggers(LocationName parent)

  • listJobTriggers(ProjectName parent)

  • listJobTriggers(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listJobTriggersPagedCallable()

  • listJobTriggersCallable()

DeleteJobTrigger

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteJobTrigger(DeleteJobTriggerRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteJobTrigger(JobTriggerName name)

  • deleteJobTrigger(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteJobTriggerCallable()

ActivateJobTrigger

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • activateJobTrigger(ActivateJobTriggerRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • activateJobTriggerCallable()

CreateDiscoveryConfig

Creates a config for discovery to scan and profile storage.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDiscoveryConfig(CreateDiscoveryConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDiscoveryConfig(LocationName parent, DiscoveryConfig discoveryConfig)

  • createDiscoveryConfig(String parent, DiscoveryConfig discoveryConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDiscoveryConfigCallable()

UpdateDiscoveryConfig

Updates a discovery configuration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDiscoveryConfig(UpdateDiscoveryConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDiscoveryConfig(DiscoveryConfigName name, DiscoveryConfig discoveryConfig, FieldMask updateMask)

  • updateDiscoveryConfig(String name, DiscoveryConfig discoveryConfig, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDiscoveryConfigCallable()

GetDiscoveryConfig

Gets a discovery configuration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDiscoveryConfig(GetDiscoveryConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDiscoveryConfig(DiscoveryConfigName name)

  • getDiscoveryConfig(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDiscoveryConfigCallable()

ListDiscoveryConfigs

Lists discovery configurations.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDiscoveryConfigs(ListDiscoveryConfigsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDiscoveryConfigs(LocationName parent)

  • listDiscoveryConfigs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDiscoveryConfigsPagedCallable()

  • listDiscoveryConfigsCallable()

DeleteDiscoveryConfig

Deletes a discovery configuration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDiscoveryConfig(DeleteDiscoveryConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDiscoveryConfig(DiscoveryConfigName name)

  • deleteDiscoveryConfig(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDiscoveryConfigCallable()

CreateDlpJob

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDlpJob(CreateDlpJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDlpJob(LocationName parent, InspectJobConfig inspectJob)

  • createDlpJob(LocationName parent, RiskAnalysisJobConfig riskJob)

  • createDlpJob(ProjectName parent, InspectJobConfig inspectJob)

  • createDlpJob(ProjectName parent, RiskAnalysisJobConfig riskJob)

  • createDlpJob(String parent, InspectJobConfig inspectJob)

  • createDlpJob(String parent, RiskAnalysisJobConfig riskJob)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDlpJobCallable()

ListDlpJobs

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDlpJobs(ListDlpJobsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDlpJobs(LocationName parent)

  • listDlpJobs(ProjectName parent)

  • listDlpJobs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDlpJobsPagedCallable()

  • listDlpJobsCallable()

GetDlpJob

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDlpJob(GetDlpJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDlpJob(DlpJobName name)

  • getDlpJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDlpJobCallable()

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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDlpJob(DeleteDlpJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDlpJob(DlpJobName name)

  • deleteDlpJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDlpJobCallable()

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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • cancelDlpJob(CancelDlpJobRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • cancelDlpJobCallable()

CreateStoredInfoType

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createStoredInfoType(CreateStoredInfoTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createStoredInfoType(LocationName parent, StoredInfoTypeConfig config)

  • createStoredInfoType(OrganizationLocationName parent, StoredInfoTypeConfig config)

  • createStoredInfoType(OrganizationName parent, StoredInfoTypeConfig config)

  • createStoredInfoType(ProjectName parent, StoredInfoTypeConfig config)

  • createStoredInfoType(String parent, StoredInfoTypeConfig config)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createStoredInfoTypeCallable()

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/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateStoredInfoType(UpdateStoredInfoTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateStoredInfoType(StoredInfoTypeName name, StoredInfoTypeConfig config, FieldMask updateMask)

  • updateStoredInfoType(String name, StoredInfoTypeConfig config, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateStoredInfoTypeCallable()

GetStoredInfoType

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getStoredInfoType(GetStoredInfoTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getStoredInfoType(StoredInfoTypeName name)

  • getStoredInfoType(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getStoredInfoTypeCallable()

ListStoredInfoTypes

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listStoredInfoTypes(ListStoredInfoTypesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listStoredInfoTypes(LocationName parent)

  • listStoredInfoTypes(OrganizationLocationName parent)

  • listStoredInfoTypes(OrganizationName parent)

  • listStoredInfoTypes(ProjectName parent)

  • listStoredInfoTypes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listStoredInfoTypesPagedCallable()

  • listStoredInfoTypesCallable()

DeleteStoredInfoType

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteStoredInfoType(DeleteStoredInfoTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteStoredInfoType(StoredInfoTypeName name)

  • deleteStoredInfoType(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteStoredInfoTypeCallable()

ListProjectDataProfiles

Lists data profiles for an organization.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listProjectDataProfiles(ListProjectDataProfilesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listProjectDataProfiles(LocationName parent)

  • listProjectDataProfiles(OrganizationLocationName parent)

  • listProjectDataProfiles(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listProjectDataProfilesPagedCallable()

  • listProjectDataProfilesCallable()

ListTableDataProfiles

Lists data profiles for an organization.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listTableDataProfiles(ListTableDataProfilesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listTableDataProfiles(LocationName parent)

  • listTableDataProfiles(OrganizationLocationName parent)

  • listTableDataProfiles(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listTableDataProfilesPagedCallable()

  • listTableDataProfilesCallable()

ListColumnDataProfiles

Lists data profiles for an organization.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listColumnDataProfiles(ListColumnDataProfilesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listColumnDataProfiles(LocationName parent)

  • listColumnDataProfiles(OrganizationLocationName parent)

  • listColumnDataProfiles(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listColumnDataProfilesPagedCallable()

  • listColumnDataProfilesCallable()

GetProjectDataProfile

Gets a project data profile.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getProjectDataProfile(GetProjectDataProfileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getProjectDataProfile(ProjectDataProfileName name)

  • getProjectDataProfile(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getProjectDataProfileCallable()

GetTableDataProfile

Gets a table data profile.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getTableDataProfile(GetTableDataProfileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getTableDataProfile(TableDataProfileName name)

  • getTableDataProfile(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getTableDataProfileCallable()

GetColumnDataProfile

Gets a column data profile.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getColumnDataProfile(GetColumnDataProfileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getColumnDataProfile(ColumnDataProfileName name)

  • getColumnDataProfile(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getColumnDataProfileCallable()

HybridInspectDlpJob

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • hybridInspectDlpJob(HybridInspectDlpJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • hybridInspectDlpJob(DlpJobName name)

  • hybridInspectDlpJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • hybridInspectDlpJobCallable()

FinishDlpJob

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • finishDlpJob(FinishDlpJobRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • finishDlpJobCallable()

See the individual methods for example code.

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 parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DlpServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DlpServiceSettings dlpServiceSettings =
     DlpServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DlpServiceClient dlpServiceClient = DlpServiceClient.create(dlpServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DlpServiceSettings dlpServiceSettings =
     DlpServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DlpServiceClient dlpServiceClient = DlpServiceClient.create(dlpServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DlpServiceSettings dlpServiceSettings = DlpServiceSettings.newHttpJsonBuilder().build();
 DlpServiceClient dlpServiceClient = DlpServiceClient.create(dlpServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DlpServiceClient

Static Methods

create()

public static final DlpServiceClient create()

Constructs an instance of DlpServiceClient with default settings.

Returns
Type Description
DlpServiceClient
Exceptions
Type Description
IOException

create(DlpServiceSettings settings)

public static final DlpServiceClient create(DlpServiceSettings settings)

Constructs an instance of DlpServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings DlpServiceSettings
Returns
Type Description
DlpServiceClient
Exceptions
Type Description
IOException

create(DlpServiceStub stub)

public static final DlpServiceClient create(DlpServiceStub stub)

Constructs an instance of DlpServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DlpServiceSettings).

Parameter
Name Description
stub DlpServiceStub
Returns
Type Description
DlpServiceClient

Constructors

DlpServiceClient(DlpServiceSettings settings)

protected DlpServiceClient(DlpServiceSettings settings)

Constructs an instance of DlpServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings DlpServiceSettings

DlpServiceClient(DlpServiceStub stub)

protected DlpServiceClient(DlpServiceStub stub)
Parameter
Name Description
stub DlpServiceStub

Methods

activateJobTrigger(ActivateJobTriggerRequest request)

public final DlpJob activateJobTrigger(ActivateJobTriggerRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ActivateJobTriggerRequest request =
       ActivateJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString())
           .build();
   DlpJob response = dlpServiceClient.activateJobTrigger(request);
 }
Parameter
Name Description
request ActivateJobTriggerRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpJob

activateJobTriggerCallable()

public final UnaryCallable<ActivateJobTriggerRequest,DlpJob> activateJobTriggerCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ActivateJobTriggerRequest request =
       ActivateJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString())
           .build();
   ApiFuture<DlpJob> future = dlpServiceClient.activateJobTriggerCallable().futureCall(request);
   // Do something.
   DlpJob response = future.get();
 }
Returns
Type Description
UnaryCallable<ActivateJobTriggerRequest,DlpJob>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

cancelDlpJob(CancelDlpJobRequest request)

public final void cancelDlpJob(CancelDlpJobRequest request)

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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CancelDlpJobRequest request =
       CancelDlpJobRequest.newBuilder()
           .setName(DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString())
           .build();
   dlpServiceClient.cancelDlpJob(request);
 }
Parameter
Name Description
request CancelDlpJobRequest

The request object containing all of the parameters for the API call.

cancelDlpJobCallable()

public final UnaryCallable<CancelDlpJobRequest,Empty> cancelDlpJobCallable()

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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CancelDlpJobRequest request =
       CancelDlpJobRequest.newBuilder()
           .setName(DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString())
           .build();
   ApiFuture<Empty> future = dlpServiceClient.cancelDlpJobCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<CancelDlpJobRequest,Empty>

close()

public final void close()

createDeidentifyTemplate(CreateDeidentifyTemplateRequest request)

public final DeidentifyTemplate createDeidentifyTemplate(CreateDeidentifyTemplateRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateDeidentifyTemplateRequest request =
       CreateDeidentifyTemplateRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setDeidentifyTemplate(DeidentifyTemplate.newBuilder().build())
           .setTemplateId("templateId1304010549")
           .setLocationId("locationId1541836720")
           .build();
   DeidentifyTemplate response = dlpServiceClient.createDeidentifyTemplate(request);
 }
Parameter
Name Description
request CreateDeidentifyTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DeidentifyTemplate

createDeidentifyTemplate(LocationName parent, DeidentifyTemplate deidentifyTemplate)

public final DeidentifyTemplate createDeidentifyTemplate(LocationName parent, DeidentifyTemplate deidentifyTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeidentifyTemplate deidentifyTemplate = DeidentifyTemplate.newBuilder().build();
   DeidentifyTemplate response =
       dlpServiceClient.createDeidentifyTemplate(parent, deidentifyTemplate);
 }
Parameters
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
deidentifyTemplate DeidentifyTemplate

Required. The DeidentifyTemplate to create.
Returns
Type Description
DeidentifyTemplate

createDeidentifyTemplate(OrganizationLocationName parent, DeidentifyTemplate deidentifyTemplate)

public final DeidentifyTemplate createDeidentifyTemplate(OrganizationLocationName parent, DeidentifyTemplate deidentifyTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   DeidentifyTemplate deidentifyTemplate = DeidentifyTemplate.newBuilder().build();
   DeidentifyTemplate response =
       dlpServiceClient.createDeidentifyTemplate(parent, deidentifyTemplate);
 }
Parameters
Name Description
parent OrganizationLocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
deidentifyTemplate DeidentifyTemplate

Required. The DeidentifyTemplate to create.
Returns
Type Description
DeidentifyTemplate

createDeidentifyTemplate(OrganizationName parent, DeidentifyTemplate deidentifyTemplate)

public final DeidentifyTemplate createDeidentifyTemplate(OrganizationName parent, DeidentifyTemplate deidentifyTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   DeidentifyTemplate deidentifyTemplate = DeidentifyTemplate.newBuilder().build();
   DeidentifyTemplate response =
       dlpServiceClient.createDeidentifyTemplate(parent, deidentifyTemplate);
 }
Parameters
Name Description
parent OrganizationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
deidentifyTemplate DeidentifyTemplate

Required. The DeidentifyTemplate to create.
Returns
Type Description
DeidentifyTemplate

createDeidentifyTemplate(ProjectName parent, DeidentifyTemplate deidentifyTemplate)

public final DeidentifyTemplate createDeidentifyTemplate(ProjectName parent, DeidentifyTemplate deidentifyTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   DeidentifyTemplate deidentifyTemplate = DeidentifyTemplate.newBuilder().build();
   DeidentifyTemplate response =
       dlpServiceClient.createDeidentifyTemplate(parent, deidentifyTemplate);
 }
Parameters
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
deidentifyTemplate DeidentifyTemplate

Required. The DeidentifyTemplate to create.
Returns
Type Description
DeidentifyTemplate

createDeidentifyTemplate(String parent, DeidentifyTemplate deidentifyTemplate)

public final DeidentifyTemplate createDeidentifyTemplate(String parent, DeidentifyTemplate deidentifyTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   DeidentifyTemplate deidentifyTemplate = DeidentifyTemplate.newBuilder().build();
   DeidentifyTemplate response =
       dlpServiceClient.createDeidentifyTemplate(parent, deidentifyTemplate);
 }
Parameters
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
deidentifyTemplate DeidentifyTemplate

Required. The DeidentifyTemplate to create.
Returns
Type Description
DeidentifyTemplate

createDeidentifyTemplateCallable()

public final UnaryCallable<CreateDeidentifyTemplateRequest,DeidentifyTemplate> createDeidentifyTemplateCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateDeidentifyTemplateRequest request =
       CreateDeidentifyTemplateRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setDeidentifyTemplate(DeidentifyTemplate.newBuilder().build())
           .setTemplateId("templateId1304010549")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<DeidentifyTemplate> future =
       dlpServiceClient.createDeidentifyTemplateCallable().futureCall(request);
   // Do something.
   DeidentifyTemplate response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateDeidentifyTemplateRequest,DeidentifyTemplate>

createDiscoveryConfig(CreateDiscoveryConfigRequest request)

public final DiscoveryConfig createDiscoveryConfig(CreateDiscoveryConfigRequest request)

Creates a config for discovery to scan and profile storage.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateDiscoveryConfigRequest request =
       CreateDiscoveryConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDiscoveryConfig(DiscoveryConfig.newBuilder().build())
           .setConfigId("configId-580140035")
           .build();
   DiscoveryConfig response = dlpServiceClient.createDiscoveryConfig(request);
 }
Parameter
Name Description
request CreateDiscoveryConfigRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DiscoveryConfig

createDiscoveryConfig(LocationName parent, DiscoveryConfig discoveryConfig)

public final DiscoveryConfig createDiscoveryConfig(LocationName parent, DiscoveryConfig discoveryConfig)

Creates a config for discovery to scan and profile storage.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DiscoveryConfig discoveryConfig = DiscoveryConfig.newBuilder().build();
   DiscoveryConfig response = dlpServiceClient.createDiscoveryConfig(parent, discoveryConfig);
 }
Parameters
Name Description
parent LocationName

Required. Parent resource name.

The format of this value is as follows: projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

parent=projects/example-project/locations/europe-west3
discoveryConfig DiscoveryConfig

Required. The DiscoveryConfig to create.
Returns
Type Description
DiscoveryConfig

createDiscoveryConfig(String parent, DiscoveryConfig discoveryConfig)

public final DiscoveryConfig createDiscoveryConfig(String parent, DiscoveryConfig discoveryConfig)

Creates a config for discovery to scan and profile storage.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   DiscoveryConfig discoveryConfig = DiscoveryConfig.newBuilder().build();
   DiscoveryConfig response = dlpServiceClient.createDiscoveryConfig(parent, discoveryConfig);
 }
Parameters
Name Description
parent String

Required. Parent resource name.

The format of this value is as follows: projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

parent=projects/example-project/locations/europe-west3
discoveryConfig DiscoveryConfig

Required. The DiscoveryConfig to create.
Returns
Type Description
DiscoveryConfig

createDiscoveryConfigCallable()

public final UnaryCallable<CreateDiscoveryConfigRequest,DiscoveryConfig> createDiscoveryConfigCallable()

Creates a config for discovery to scan and profile storage.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateDiscoveryConfigRequest request =
       CreateDiscoveryConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDiscoveryConfig(DiscoveryConfig.newBuilder().build())
           .setConfigId("configId-580140035")
           .build();
   ApiFuture<DiscoveryConfig> future =
       dlpServiceClient.createDiscoveryConfigCallable().futureCall(request);
   // Do something.
   DiscoveryConfig response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateDiscoveryConfigRequest,DiscoveryConfig>

createDlpJob(CreateDlpJobRequest request)

public final DlpJob createDlpJob(CreateDlpJobRequest request)

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateDlpJobRequest request =
       CreateDlpJobRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setJobId("jobId101296568")
           .setLocationId("locationId1541836720")
           .build();
   DlpJob response = dlpServiceClient.createDlpJob(request);
 }
Parameter
Name Description
request CreateDlpJobRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpJob

createDlpJob(LocationName parent, InspectJobConfig inspectJob)

public final DlpJob createDlpJob(LocationName parent, InspectJobConfig inspectJob)

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   InspectJobConfig inspectJob = InspectJobConfig.newBuilder().build();
   DlpJob response = dlpServiceClient.createDlpJob(parent, inspectJob);
 }
Parameters
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
inspectJob InspectJobConfig

An inspection job scans a storage repository for InfoTypes.
Returns
Type Description
DlpJob

createDlpJob(LocationName parent, RiskAnalysisJobConfig riskJob)

public final DlpJob createDlpJob(LocationName parent, RiskAnalysisJobConfig riskJob)

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RiskAnalysisJobConfig riskJob = RiskAnalysisJobConfig.newBuilder().build();
   DlpJob response = dlpServiceClient.createDlpJob(parent, riskJob);
 }
Parameters
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
riskJob RiskAnalysisJobConfig

A risk analysis job calculates re-identification risk metrics for a BigQuery table.
Returns
Type Description
DlpJob

createDlpJob(ProjectName parent, InspectJobConfig inspectJob)

public final DlpJob createDlpJob(ProjectName parent, InspectJobConfig inspectJob)

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   InspectJobConfig inspectJob = InspectJobConfig.newBuilder().build();
   DlpJob response = dlpServiceClient.createDlpJob(parent, inspectJob);
 }
Parameters
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
inspectJob InspectJobConfig

An inspection job scans a storage repository for InfoTypes.
Returns
Type Description
DlpJob

createDlpJob(ProjectName parent, RiskAnalysisJobConfig riskJob)

public final DlpJob createDlpJob(ProjectName parent, RiskAnalysisJobConfig riskJob)

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   RiskAnalysisJobConfig riskJob = RiskAnalysisJobConfig.newBuilder().build();
   DlpJob response = dlpServiceClient.createDlpJob(parent, riskJob);
 }
Parameters
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
riskJob RiskAnalysisJobConfig

A risk analysis job calculates re-identification risk metrics for a BigQuery table.
Returns
Type Description
DlpJob

createDlpJob(String parent, InspectJobConfig inspectJob)

public final DlpJob createDlpJob(String parent, InspectJobConfig inspectJob)

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   InspectJobConfig inspectJob = InspectJobConfig.newBuilder().build();
   DlpJob response = dlpServiceClient.createDlpJob(parent, inspectJob);
 }
Parameters
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
inspectJob InspectJobConfig

An inspection job scans a storage repository for InfoTypes.
Returns
Type Description
DlpJob

createDlpJob(String parent, RiskAnalysisJobConfig riskJob)

public final DlpJob createDlpJob(String parent, RiskAnalysisJobConfig riskJob)

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   RiskAnalysisJobConfig riskJob = RiskAnalysisJobConfig.newBuilder().build();
   DlpJob response = dlpServiceClient.createDlpJob(parent, riskJob);
 }
Parameters
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
riskJob RiskAnalysisJobConfig

A risk analysis job calculates re-identification risk metrics for a BigQuery table.
Returns
Type Description
DlpJob

createDlpJobCallable()

public final UnaryCallable<CreateDlpJobRequest,DlpJob> createDlpJobCallable()

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateDlpJobRequest request =
       CreateDlpJobRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setJobId("jobId101296568")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<DlpJob> future = dlpServiceClient.createDlpJobCallable().futureCall(request);
   // Do something.
   DlpJob response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateDlpJobRequest,DlpJob>

createInspectTemplate(CreateInspectTemplateRequest request)

public final InspectTemplate createInspectTemplate(CreateInspectTemplateRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateInspectTemplateRequest request =
       CreateInspectTemplateRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setInspectTemplate(InspectTemplate.newBuilder().build())
           .setTemplateId("templateId1304010549")
           .setLocationId("locationId1541836720")
           .build();
   InspectTemplate response = dlpServiceClient.createInspectTemplate(request);
 }
Parameter
Name Description
request CreateInspectTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
InspectTemplate

createInspectTemplate(LocationName parent, InspectTemplate inspectTemplate)

public final InspectTemplate createInspectTemplate(LocationName parent, InspectTemplate inspectTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   InspectTemplate inspectTemplate = InspectTemplate.newBuilder().build();
   InspectTemplate response = dlpServiceClient.createInspectTemplate(parent, inspectTemplate);
 }
Parameters
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
inspectTemplate InspectTemplate

Required. The InspectTemplate to create.
Returns
Type Description
InspectTemplate

createInspectTemplate(OrganizationLocationName parent, InspectTemplate inspectTemplate)

public final InspectTemplate createInspectTemplate(OrganizationLocationName parent, InspectTemplate inspectTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   InspectTemplate inspectTemplate = InspectTemplate.newBuilder().build();
   InspectTemplate response = dlpServiceClient.createInspectTemplate(parent, inspectTemplate);
 }
Parameters
Name Description
parent OrganizationLocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
inspectTemplate InspectTemplate

Required. The InspectTemplate to create.
Returns
Type Description
InspectTemplate

createInspectTemplate(OrganizationName parent, InspectTemplate inspectTemplate)

public final InspectTemplate createInspectTemplate(OrganizationName parent, InspectTemplate inspectTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   InspectTemplate inspectTemplate = InspectTemplate.newBuilder().build();
   InspectTemplate response = dlpServiceClient.createInspectTemplate(parent, inspectTemplate);
 }
Parameters
Name Description
parent OrganizationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
inspectTemplate InspectTemplate

Required. The InspectTemplate to create.
Returns
Type Description
InspectTemplate

createInspectTemplate(ProjectName parent, InspectTemplate inspectTemplate)

public final InspectTemplate createInspectTemplate(ProjectName parent, InspectTemplate inspectTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   InspectTemplate inspectTemplate = InspectTemplate.newBuilder().build();
   InspectTemplate response = dlpServiceClient.createInspectTemplate(parent, inspectTemplate);
 }
Parameters
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
inspectTemplate InspectTemplate

Required. The InspectTemplate to create.
Returns
Type Description
InspectTemplate

createInspectTemplate(String parent, InspectTemplate inspectTemplate)

public final InspectTemplate createInspectTemplate(String parent, InspectTemplate inspectTemplate)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   InspectTemplate inspectTemplate = InspectTemplate.newBuilder().build();
   InspectTemplate response = dlpServiceClient.createInspectTemplate(parent, inspectTemplate);
 }
Parameters
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
inspectTemplate InspectTemplate

Required. The InspectTemplate to create.
Returns
Type Description
InspectTemplate

createInspectTemplateCallable()

public final UnaryCallable<CreateInspectTemplateRequest,InspectTemplate> createInspectTemplateCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateInspectTemplateRequest request =
       CreateInspectTemplateRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setInspectTemplate(InspectTemplate.newBuilder().build())
           .setTemplateId("templateId1304010549")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<InspectTemplate> future =
       dlpServiceClient.createInspectTemplateCallable().futureCall(request);
   // Do something.
   InspectTemplate response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateInspectTemplateRequest,InspectTemplate>

createJobTrigger(CreateJobTriggerRequest request)

public final JobTrigger createJobTrigger(CreateJobTriggerRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateJobTriggerRequest request =
       CreateJobTriggerRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setJobTrigger(JobTrigger.newBuilder().build())
           .setTriggerId("triggerId-648752909")
           .setLocationId("locationId1541836720")
           .build();
   JobTrigger response = dlpServiceClient.createJobTrigger(request);
 }
Parameter
Name Description
request CreateJobTriggerRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
JobTrigger

createJobTrigger(LocationName parent, JobTrigger jobTrigger)

public final JobTrigger createJobTrigger(LocationName parent, JobTrigger jobTrigger)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   JobTrigger jobTrigger = JobTrigger.newBuilder().build();
   JobTrigger response = dlpServiceClient.createJobTrigger(parent, jobTrigger);
 }
Parameters
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
jobTrigger JobTrigger

Required. The JobTrigger to create.
Returns
Type Description
JobTrigger

createJobTrigger(ProjectName parent, JobTrigger jobTrigger)

public final JobTrigger createJobTrigger(ProjectName parent, JobTrigger jobTrigger)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   JobTrigger jobTrigger = JobTrigger.newBuilder().build();
   JobTrigger response = dlpServiceClient.createJobTrigger(parent, jobTrigger);
 }
Parameters
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
jobTrigger JobTrigger

Required. The JobTrigger to create.
Returns
Type Description
JobTrigger

createJobTrigger(String parent, JobTrigger jobTrigger)

public final JobTrigger createJobTrigger(String parent, JobTrigger jobTrigger)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   JobTrigger jobTrigger = JobTrigger.newBuilder().build();
   JobTrigger response = dlpServiceClient.createJobTrigger(parent, jobTrigger);
 }
Parameters
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
jobTrigger JobTrigger

Required. The JobTrigger to create.
Returns
Type Description
JobTrigger

createJobTriggerCallable()

public final UnaryCallable<CreateJobTriggerRequest,JobTrigger> createJobTriggerCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateJobTriggerRequest request =
       CreateJobTriggerRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setJobTrigger(JobTrigger.newBuilder().build())
           .setTriggerId("triggerId-648752909")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<JobTrigger> future =
       dlpServiceClient.createJobTriggerCallable().futureCall(request);
   // Do something.
   JobTrigger response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateJobTriggerRequest,JobTrigger>

createStoredInfoType(CreateStoredInfoTypeRequest request)

public final StoredInfoType createStoredInfoType(CreateStoredInfoTypeRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateStoredInfoTypeRequest request =
       CreateStoredInfoTypeRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setConfig(StoredInfoTypeConfig.newBuilder().build())
           .setStoredInfoTypeId("storedInfoTypeId-1409591226")
           .setLocationId("locationId1541836720")
           .build();
   StoredInfoType response = dlpServiceClient.createStoredInfoType(request);
 }
Parameter
Name Description
request CreateStoredInfoTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
StoredInfoType

createStoredInfoType(LocationName parent, StoredInfoTypeConfig config)

public final StoredInfoType createStoredInfoType(LocationName parent, StoredInfoTypeConfig config)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   StoredInfoTypeConfig config = StoredInfoTypeConfig.newBuilder().build();
   StoredInfoType response = dlpServiceClient.createStoredInfoType(parent, config);
 }
Parameters
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
config StoredInfoTypeConfig

Required. Configuration of the storedInfoType to create.
Returns
Type Description
StoredInfoType

createStoredInfoType(OrganizationLocationName parent, StoredInfoTypeConfig config)

public final StoredInfoType createStoredInfoType(OrganizationLocationName parent, StoredInfoTypeConfig config)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   StoredInfoTypeConfig config = StoredInfoTypeConfig.newBuilder().build();
   StoredInfoType response = dlpServiceClient.createStoredInfoType(parent, config);
 }
Parameters
Name Description
parent OrganizationLocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
config StoredInfoTypeConfig

Required. Configuration of the storedInfoType to create.
Returns
Type Description
StoredInfoType

createStoredInfoType(OrganizationName parent, StoredInfoTypeConfig config)

public final StoredInfoType createStoredInfoType(OrganizationName parent, StoredInfoTypeConfig config)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   StoredInfoTypeConfig config = StoredInfoTypeConfig.newBuilder().build();
   StoredInfoType response = dlpServiceClient.createStoredInfoType(parent, config);
 }
Parameters
Name Description
parent OrganizationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
config StoredInfoTypeConfig

Required. Configuration of the storedInfoType to create.
Returns
Type Description
StoredInfoType

createStoredInfoType(ProjectName parent, StoredInfoTypeConfig config)

public final StoredInfoType createStoredInfoType(ProjectName parent, StoredInfoTypeConfig config)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   StoredInfoTypeConfig config = StoredInfoTypeConfig.newBuilder().build();
   StoredInfoType response = dlpServiceClient.createStoredInfoType(parent, config);
 }
Parameters
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
config StoredInfoTypeConfig

Required. Configuration of the storedInfoType to create.
Returns
Type Description
StoredInfoType

createStoredInfoType(String parent, StoredInfoTypeConfig config)

public final StoredInfoType createStoredInfoType(String parent, StoredInfoTypeConfig config)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   StoredInfoTypeConfig config = StoredInfoTypeConfig.newBuilder().build();
   StoredInfoType response = dlpServiceClient.createStoredInfoType(parent, config);
 }
Parameters
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
config StoredInfoTypeConfig

Required. Configuration of the storedInfoType to create.
Returns
Type Description
StoredInfoType

createStoredInfoTypeCallable()

public final UnaryCallable<CreateStoredInfoTypeRequest,StoredInfoType> createStoredInfoTypeCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   CreateStoredInfoTypeRequest request =
       CreateStoredInfoTypeRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setConfig(StoredInfoTypeConfig.newBuilder().build())
           .setStoredInfoTypeId("storedInfoTypeId-1409591226")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<StoredInfoType> future =
       dlpServiceClient.createStoredInfoTypeCallable().futureCall(request);
   // Do something.
   StoredInfoType response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateStoredInfoTypeRequest,StoredInfoType>

deidentifyContent(DeidentifyContentRequest request)

public final DeidentifyContentResponse deidentifyContent(DeidentifyContentRequest request)

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeidentifyContentRequest request =
       DeidentifyContentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setDeidentifyConfig(DeidentifyConfig.newBuilder().build())
           .setInspectConfig(InspectConfig.newBuilder().build())
           .setItem(ContentItem.newBuilder().build())
           .setInspectTemplateName("inspectTemplateName1828857433")
           .setDeidentifyTemplateName("deidentifyTemplateName-1374666414")
           .setLocationId("locationId1541836720")
           .build();
   DeidentifyContentResponse response = dlpServiceClient.deidentifyContent(request);
 }
Parameter
Name Description
request DeidentifyContentRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DeidentifyContentResponse

deidentifyContentCallable()

public final UnaryCallable<DeidentifyContentRequest,DeidentifyContentResponse> deidentifyContentCallable()

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeidentifyContentRequest request =
       DeidentifyContentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setDeidentifyConfig(DeidentifyConfig.newBuilder().build())
           .setInspectConfig(InspectConfig.newBuilder().build())
           .setItem(ContentItem.newBuilder().build())
           .setInspectTemplateName("inspectTemplateName1828857433")
           .setDeidentifyTemplateName("deidentifyTemplateName-1374666414")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<DeidentifyContentResponse> future =
       dlpServiceClient.deidentifyContentCallable().futureCall(request);
   // Do something.
   DeidentifyContentResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<DeidentifyContentRequest,DeidentifyContentResponse>

deleteDeidentifyTemplate(DeidentifyTemplateName name)

public final void deleteDeidentifyTemplate(DeidentifyTemplateName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeidentifyTemplateName name =
       DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
           "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]");
   dlpServiceClient.deleteDeidentifyTemplate(name);
 }
Parameter
Name Description
name DeidentifyTemplateName

Required. Resource name of the organization and deidentify template to be deleted, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request)

public final void deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteDeidentifyTemplateRequest request =
       DeleteDeidentifyTemplateRequest.newBuilder()
           .setName(
               DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
                       "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
                   .toString())
           .build();
   dlpServiceClient.deleteDeidentifyTemplate(request);
 }
Parameter
Name Description
request DeleteDeidentifyTemplateRequest

The request object containing all of the parameters for the API call.

deleteDeidentifyTemplate(String name)

public final void deleteDeidentifyTemplate(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
               "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
           .toString();
   dlpServiceClient.deleteDeidentifyTemplate(name);
 }
Parameter
Name Description
name String

Required. Resource name of the organization and deidentify template to be deleted, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

deleteDeidentifyTemplateCallable()

public final UnaryCallable<DeleteDeidentifyTemplateRequest,Empty> deleteDeidentifyTemplateCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteDeidentifyTemplateRequest request =
       DeleteDeidentifyTemplateRequest.newBuilder()
           .setName(
               DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
                       "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       dlpServiceClient.deleteDeidentifyTemplateCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteDeidentifyTemplateRequest,Empty>

deleteDiscoveryConfig(DeleteDiscoveryConfigRequest request)

public final void deleteDiscoveryConfig(DeleteDiscoveryConfigRequest request)

Deletes a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteDiscoveryConfigRequest request =
       DeleteDiscoveryConfigRequest.newBuilder()
           .setName(
               DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]")
                   .toString())
           .build();
   dlpServiceClient.deleteDiscoveryConfig(request);
 }
Parameter
Name Description
request DeleteDiscoveryConfigRequest

The request object containing all of the parameters for the API call.

deleteDiscoveryConfig(DiscoveryConfigName name)

public final void deleteDiscoveryConfig(DiscoveryConfigName name)

Deletes a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DiscoveryConfigName name =
       DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]");
   dlpServiceClient.deleteDiscoveryConfig(name);
 }
Parameter
Name Description
name DiscoveryConfigName

Required. Resource name of the project and the config, for example projects/dlp-test-project/discoveryConfigs/53234423.

deleteDiscoveryConfig(String name)

public final void deleteDiscoveryConfig(String name)

Deletes a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]").toString();
   dlpServiceClient.deleteDiscoveryConfig(name);
 }
Parameter
Name Description
name String

Required. Resource name of the project and the config, for example projects/dlp-test-project/discoveryConfigs/53234423.

deleteDiscoveryConfigCallable()

public final UnaryCallable<DeleteDiscoveryConfigRequest,Empty> deleteDiscoveryConfigCallable()

Deletes a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteDiscoveryConfigRequest request =
       DeleteDiscoveryConfigRequest.newBuilder()
           .setName(
               DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       dlpServiceClient.deleteDiscoveryConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteDiscoveryConfigRequest,Empty>

deleteDlpJob(DeleteDlpJobRequest request)

public final void deleteDlpJob(DeleteDlpJobRequest request)

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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteDlpJobRequest request =
       DeleteDlpJobRequest.newBuilder()
           .setName(DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString())
           .build();
   dlpServiceClient.deleteDlpJob(request);
 }
Parameter
Name Description
request DeleteDlpJobRequest

The request object containing all of the parameters for the API call.

deleteDlpJob(DlpJobName name)

public final void deleteDlpJob(DlpJobName name)

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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DlpJobName name = DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]");
   dlpServiceClient.deleteDlpJob(name);
 }
Parameter
Name Description
name DlpJobName

Required. The name of the DlpJob resource to be deleted.

deleteDlpJob(String name)

public final void deleteDlpJob(String name)

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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString();
   dlpServiceClient.deleteDlpJob(name);
 }
Parameter
Name Description
name String

Required. The name of the DlpJob resource to be deleted.

deleteDlpJobCallable()

public final UnaryCallable<DeleteDlpJobRequest,Empty> deleteDlpJobCallable()

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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteDlpJobRequest request =
       DeleteDlpJobRequest.newBuilder()
           .setName(DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString())
           .build();
   ApiFuture<Empty> future = dlpServiceClient.deleteDlpJobCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteDlpJobRequest,Empty>

deleteInspectTemplate(DeleteInspectTemplateRequest request)

public final void deleteInspectTemplate(DeleteInspectTemplateRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteInspectTemplateRequest request =
       DeleteInspectTemplateRequest.newBuilder()
           .setName(
               InspectTemplateName.ofOrganizationInspectTemplateName(
                       "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
                   .toString())
           .build();
   dlpServiceClient.deleteInspectTemplate(request);
 }
Parameter
Name Description
request DeleteInspectTemplateRequest

The request object containing all of the parameters for the API call.

deleteInspectTemplate(InspectTemplateName name)

public final void deleteInspectTemplate(InspectTemplateName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   InspectTemplateName name =
       InspectTemplateName.ofOrganizationInspectTemplateName(
           "[ORGANIZATION]", "[INSPECT_TEMPLATE]");
   dlpServiceClient.deleteInspectTemplate(name);
 }
Parameter
Name Description
name InspectTemplateName

Required. Resource name of the organization and inspectTemplate to be deleted, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

deleteInspectTemplate(String name)

public final void deleteInspectTemplate(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       InspectTemplateName.ofOrganizationInspectTemplateName(
               "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
           .toString();
   dlpServiceClient.deleteInspectTemplate(name);
 }
Parameter
Name Description
name String

Required. Resource name of the organization and inspectTemplate to be deleted, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

deleteInspectTemplateCallable()

public final UnaryCallable<DeleteInspectTemplateRequest,Empty> deleteInspectTemplateCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteInspectTemplateRequest request =
       DeleteInspectTemplateRequest.newBuilder()
           .setName(
               InspectTemplateName.ofOrganizationInspectTemplateName(
                       "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       dlpServiceClient.deleteInspectTemplateCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteInspectTemplateRequest,Empty>

deleteJobTrigger(DeleteJobTriggerRequest request)

public final void deleteJobTrigger(DeleteJobTriggerRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteJobTriggerRequest request =
       DeleteJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString())
           .build();
   dlpServiceClient.deleteJobTrigger(request);
 }
Parameter
Name Description
request DeleteJobTriggerRequest

The request object containing all of the parameters for the API call.

deleteJobTrigger(JobTriggerName name)

public final void deleteJobTrigger(JobTriggerName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   JobTriggerName name = JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]");
   dlpServiceClient.deleteJobTrigger(name);
 }
Parameter
Name Description
name JobTriggerName

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

deleteJobTrigger(String name)

public final void deleteJobTrigger(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString();
   dlpServiceClient.deleteJobTrigger(name);
 }
Parameter
Name Description
name String

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

deleteJobTriggerCallable()

public final UnaryCallable<DeleteJobTriggerRequest,Empty> deleteJobTriggerCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteJobTriggerRequest request =
       DeleteJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString())
           .build();
   ApiFuture<Empty> future = dlpServiceClient.deleteJobTriggerCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteJobTriggerRequest,Empty>

deleteStoredInfoType(DeleteStoredInfoTypeRequest request)

public final void deleteStoredInfoType(DeleteStoredInfoTypeRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteStoredInfoTypeRequest request =
       DeleteStoredInfoTypeRequest.newBuilder()
           .setName(
               StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
                       "[ORGANIZATION]", "[STORED_INFO_TYPE]")
                   .toString())
           .build();
   dlpServiceClient.deleteStoredInfoType(request);
 }
Parameter
Name Description
request DeleteStoredInfoTypeRequest

The request object containing all of the parameters for the API call.

deleteStoredInfoType(StoredInfoTypeName name)

public final void deleteStoredInfoType(StoredInfoTypeName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   StoredInfoTypeName name =
       StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
           "[ORGANIZATION]", "[STORED_INFO_TYPE]");
   dlpServiceClient.deleteStoredInfoType(name);
 }
Parameter
Name Description
name StoredInfoTypeName

Required. Resource name of the organization and storedInfoType to be deleted, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

deleteStoredInfoType(String name)

public final void deleteStoredInfoType(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
               "[ORGANIZATION]", "[STORED_INFO_TYPE]")
           .toString();
   dlpServiceClient.deleteStoredInfoType(name);
 }
Parameter
Name Description
name String

Required. Resource name of the organization and storedInfoType to be deleted, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

deleteStoredInfoTypeCallable()

public final UnaryCallable<DeleteStoredInfoTypeRequest,Empty> deleteStoredInfoTypeCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeleteStoredInfoTypeRequest request =
       DeleteStoredInfoTypeRequest.newBuilder()
           .setName(
               StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
                       "[ORGANIZATION]", "[STORED_INFO_TYPE]")
                   .toString())
           .build();
   ApiFuture<Empty> future = dlpServiceClient.deleteStoredInfoTypeCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteStoredInfoTypeRequest,Empty>

finishDlpJob(FinishDlpJobRequest request)

public final void finishDlpJob(FinishDlpJobRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   FinishDlpJobRequest request =
       FinishDlpJobRequest.newBuilder()
           .setName(
               DlpJobName.ofProjectLocationDlpJobName("[PROJECT]", "[LOCATION]", "[DLP_JOB]")
                   .toString())
           .build();
   dlpServiceClient.finishDlpJob(request);
 }
Parameter
Name Description
request FinishDlpJobRequest

The request object containing all of the parameters for the API call.

finishDlpJobCallable()

public final UnaryCallable<FinishDlpJobRequest,Empty> finishDlpJobCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   FinishDlpJobRequest request =
       FinishDlpJobRequest.newBuilder()
           .setName(
               DlpJobName.ofProjectLocationDlpJobName("[PROJECT]", "[LOCATION]", "[DLP_JOB]")
                   .toString())
           .build();
   ApiFuture<Empty> future = dlpServiceClient.finishDlpJobCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<FinishDlpJobRequest,Empty>

getColumnDataProfile(ColumnDataProfileName name)

public final ColumnDataProfile getColumnDataProfile(ColumnDataProfileName name)

Gets a column data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ColumnDataProfileName name =
       ColumnDataProfileName.ofOrganizationLocationColumnDataProfileName(
           "[ORGANIZATION]", "[LOCATION]", "[COLUMN_DATA_PROFILE]");
   ColumnDataProfile response = dlpServiceClient.getColumnDataProfile(name);
 }
Parameter
Name Description
name ColumnDataProfileName

Required. Resource name, for example organizations/12345/locations/us/columnDataProfiles/53234423.
Returns
Type Description
ColumnDataProfile

getColumnDataProfile(GetColumnDataProfileRequest request)

public final ColumnDataProfile getColumnDataProfile(GetColumnDataProfileRequest request)

Gets a column data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetColumnDataProfileRequest request =
       GetColumnDataProfileRequest.newBuilder()
           .setName(
               ColumnDataProfileName.ofOrganizationLocationColumnDataProfileName(
                       "[ORGANIZATION]", "[LOCATION]", "[COLUMN_DATA_PROFILE]")
                   .toString())
           .build();
   ColumnDataProfile response = dlpServiceClient.getColumnDataProfile(request);
 }
Parameter
Name Description
request GetColumnDataProfileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ColumnDataProfile

getColumnDataProfile(String name)

public final ColumnDataProfile getColumnDataProfile(String name)

Gets a column data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       ColumnDataProfileName.ofOrganizationLocationColumnDataProfileName(
               "[ORGANIZATION]", "[LOCATION]", "[COLUMN_DATA_PROFILE]")
           .toString();
   ColumnDataProfile response = dlpServiceClient.getColumnDataProfile(name);
 }
Parameter
Name Description
name String

Required. Resource name, for example organizations/12345/locations/us/columnDataProfiles/53234423.
Returns
Type Description
ColumnDataProfile

getColumnDataProfileCallable()

public final UnaryCallable<GetColumnDataProfileRequest,ColumnDataProfile> getColumnDataProfileCallable()

Gets a column data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetColumnDataProfileRequest request =
       GetColumnDataProfileRequest.newBuilder()
           .setName(
               ColumnDataProfileName.ofOrganizationLocationColumnDataProfileName(
                       "[ORGANIZATION]", "[LOCATION]", "[COLUMN_DATA_PROFILE]")
                   .toString())
           .build();
   ApiFuture<ColumnDataProfile> future =
       dlpServiceClient.getColumnDataProfileCallable().futureCall(request);
   // Do something.
   ColumnDataProfile response = future.get();
 }
Returns
Type Description
UnaryCallable<GetColumnDataProfileRequest,ColumnDataProfile>

getDeidentifyTemplate(DeidentifyTemplateName name)

public final DeidentifyTemplate getDeidentifyTemplate(DeidentifyTemplateName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeidentifyTemplateName name =
       DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
           "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]");
   DeidentifyTemplate response = dlpServiceClient.getDeidentifyTemplate(name);
 }
Parameter
Name Description
name DeidentifyTemplateName

Required. Resource name of the organization and deidentify template to be read, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.
Returns
Type Description
DeidentifyTemplate

getDeidentifyTemplate(GetDeidentifyTemplateRequest request)

public final DeidentifyTemplate getDeidentifyTemplate(GetDeidentifyTemplateRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetDeidentifyTemplateRequest request =
       GetDeidentifyTemplateRequest.newBuilder()
           .setName(
               DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
                       "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
                   .toString())
           .build();
   DeidentifyTemplate response = dlpServiceClient.getDeidentifyTemplate(request);
 }
Parameter
Name Description
request GetDeidentifyTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DeidentifyTemplate

getDeidentifyTemplate(String name)

public final DeidentifyTemplate getDeidentifyTemplate(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
               "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
           .toString();
   DeidentifyTemplate response = dlpServiceClient.getDeidentifyTemplate(name);
 }
Parameter
Name Description
name String

Required. Resource name of the organization and deidentify template to be read, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.
Returns
Type Description
DeidentifyTemplate

getDeidentifyTemplateCallable()

public final UnaryCallable<GetDeidentifyTemplateRequest,DeidentifyTemplate> getDeidentifyTemplateCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetDeidentifyTemplateRequest request =
       GetDeidentifyTemplateRequest.newBuilder()
           .setName(
               DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
                       "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
                   .toString())
           .build();
   ApiFuture<DeidentifyTemplate> future =
       dlpServiceClient.getDeidentifyTemplateCallable().futureCall(request);
   // Do something.
   DeidentifyTemplate response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDeidentifyTemplateRequest,DeidentifyTemplate>

getDiscoveryConfig(DiscoveryConfigName name)

public final DiscoveryConfig getDiscoveryConfig(DiscoveryConfigName name)

Gets a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DiscoveryConfigName name =
       DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]");
   DiscoveryConfig response = dlpServiceClient.getDiscoveryConfig(name);
 }
Parameter
Name Description
name DiscoveryConfigName

Required. Resource name of the project and the configuration, for example projects/dlp-test-project/discoveryConfigs/53234423.
Returns
Type Description
DiscoveryConfig

getDiscoveryConfig(GetDiscoveryConfigRequest request)

public final DiscoveryConfig getDiscoveryConfig(GetDiscoveryConfigRequest request)

Gets a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetDiscoveryConfigRequest request =
       GetDiscoveryConfigRequest.newBuilder()
           .setName(
               DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]")
                   .toString())
           .build();
   DiscoveryConfig response = dlpServiceClient.getDiscoveryConfig(request);
 }
Parameter
Name Description
request GetDiscoveryConfigRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DiscoveryConfig

getDiscoveryConfig(String name)

public final DiscoveryConfig getDiscoveryConfig(String name)

Gets a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]").toString();
   DiscoveryConfig response = dlpServiceClient.getDiscoveryConfig(name);
 }
Parameter
Name Description
name String

Required. Resource name of the project and the configuration, for example projects/dlp-test-project/discoveryConfigs/53234423.
Returns
Type Description
DiscoveryConfig

getDiscoveryConfigCallable()

public final UnaryCallable<GetDiscoveryConfigRequest,DiscoveryConfig> getDiscoveryConfigCallable()

Gets a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetDiscoveryConfigRequest request =
       GetDiscoveryConfigRequest.newBuilder()
           .setName(
               DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]")
                   .toString())
           .build();
   ApiFuture<DiscoveryConfig> future =
       dlpServiceClient.getDiscoveryConfigCallable().futureCall(request);
   // Do something.
   DiscoveryConfig response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDiscoveryConfigRequest,DiscoveryConfig>

getDlpJob(DlpJobName name)

public final DlpJob getDlpJob(DlpJobName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DlpJobName name = DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]");
   DlpJob response = dlpServiceClient.getDlpJob(name);
 }
Parameter
Name Description
name DlpJobName

Required. The name of the DlpJob resource.
Returns
Type Description
DlpJob

getDlpJob(GetDlpJobRequest request)

public final DlpJob getDlpJob(GetDlpJobRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetDlpJobRequest request =
       GetDlpJobRequest.newBuilder()
           .setName(DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString())
           .build();
   DlpJob response = dlpServiceClient.getDlpJob(request);
 }
Parameter
Name Description
request GetDlpJobRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpJob

getDlpJob(String name)

public final DlpJob getDlpJob(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString();
   DlpJob response = dlpServiceClient.getDlpJob(name);
 }
Parameter
Name Description
name String

Required. The name of the DlpJob resource.
Returns
Type Description
DlpJob

getDlpJobCallable()

public final UnaryCallable<GetDlpJobRequest,DlpJob> getDlpJobCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetDlpJobRequest request =
       GetDlpJobRequest.newBuilder()
           .setName(DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString())
           .build();
   ApiFuture<DlpJob> future = dlpServiceClient.getDlpJobCallable().futureCall(request);
   // Do something.
   DlpJob response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDlpJobRequest,DlpJob>

getInspectTemplate(GetInspectTemplateRequest request)

public final InspectTemplate getInspectTemplate(GetInspectTemplateRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetInspectTemplateRequest request =
       GetInspectTemplateRequest.newBuilder()
           .setName(
               InspectTemplateName.ofOrganizationInspectTemplateName(
                       "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
                   .toString())
           .build();
   InspectTemplate response = dlpServiceClient.getInspectTemplate(request);
 }
Parameter
Name Description
request GetInspectTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
InspectTemplate

getInspectTemplate(InspectTemplateName name)

public final InspectTemplate getInspectTemplate(InspectTemplateName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   InspectTemplateName name =
       InspectTemplateName.ofOrganizationInspectTemplateName(
           "[ORGANIZATION]", "[INSPECT_TEMPLATE]");
   InspectTemplate response = dlpServiceClient.getInspectTemplate(name);
 }
Parameter
Name Description
name InspectTemplateName

Required. Resource name of the organization and inspectTemplate to be read, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.
Returns
Type Description
InspectTemplate

getInspectTemplate(String name)

public final InspectTemplate getInspectTemplate(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       InspectTemplateName.ofOrganizationInspectTemplateName(
               "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
           .toString();
   InspectTemplate response = dlpServiceClient.getInspectTemplate(name);
 }
Parameter
Name Description
name String

Required. Resource name of the organization and inspectTemplate to be read, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.
Returns
Type Description
InspectTemplate

getInspectTemplateCallable()

public final UnaryCallable<GetInspectTemplateRequest,InspectTemplate> getInspectTemplateCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetInspectTemplateRequest request =
       GetInspectTemplateRequest.newBuilder()
           .setName(
               InspectTemplateName.ofOrganizationInspectTemplateName(
                       "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
                   .toString())
           .build();
   ApiFuture<InspectTemplate> future =
       dlpServiceClient.getInspectTemplateCallable().futureCall(request);
   // Do something.
   InspectTemplate response = future.get();
 }
Returns
Type Description
UnaryCallable<GetInspectTemplateRequest,InspectTemplate>

getJobTrigger(GetJobTriggerRequest request)

public final JobTrigger getJobTrigger(GetJobTriggerRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetJobTriggerRequest request =
       GetJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString())
           .build();
   JobTrigger response = dlpServiceClient.getJobTrigger(request);
 }
Parameter
Name Description
request GetJobTriggerRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
JobTrigger

getJobTrigger(JobTriggerName name)

public final JobTrigger getJobTrigger(JobTriggerName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   JobTriggerName name = JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]");
   JobTrigger response = dlpServiceClient.getJobTrigger(name);
 }
Parameter
Name Description
name JobTriggerName

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.
Returns
Type Description
JobTrigger

getJobTrigger(String name)

public final JobTrigger getJobTrigger(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString();
   JobTrigger response = dlpServiceClient.getJobTrigger(name);
 }
Parameter
Name Description
name String

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.
Returns
Type Description
JobTrigger

getJobTriggerCallable()

public final UnaryCallable<GetJobTriggerRequest,JobTrigger> getJobTriggerCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetJobTriggerRequest request =
       GetJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString())
           .build();
   ApiFuture<JobTrigger> future = dlpServiceClient.getJobTriggerCallable().futureCall(request);
   // Do something.
   JobTrigger response = future.get();
 }
Returns
Type Description
UnaryCallable<GetJobTriggerRequest,JobTrigger>

getProjectDataProfile(GetProjectDataProfileRequest request)

public final ProjectDataProfile getProjectDataProfile(GetProjectDataProfileRequest request)

Gets a project data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetProjectDataProfileRequest request =
       GetProjectDataProfileRequest.newBuilder()
           .setName(
               ProjectDataProfileName.ofOrganizationLocationProjectDataProfileName(
                       "[ORGANIZATION]", "[LOCATION]", "[PROJECT_DATA_PROFILE]")
                   .toString())
           .build();
   ProjectDataProfile response = dlpServiceClient.getProjectDataProfile(request);
 }
Parameter
Name Description
request GetProjectDataProfileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ProjectDataProfile

getProjectDataProfile(ProjectDataProfileName name)

public final ProjectDataProfile getProjectDataProfile(ProjectDataProfileName name)

Gets a project data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectDataProfileName name =
       ProjectDataProfileName.ofOrganizationLocationProjectDataProfileName(
           "[ORGANIZATION]", "[LOCATION]", "[PROJECT_DATA_PROFILE]");
   ProjectDataProfile response = dlpServiceClient.getProjectDataProfile(name);
 }
Parameter
Name Description
name ProjectDataProfileName

Required. Resource name, for example organizations/12345/locations/us/projectDataProfiles/53234423.
Returns
Type Description
ProjectDataProfile

getProjectDataProfile(String name)

public final ProjectDataProfile getProjectDataProfile(String name)

Gets a project data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       ProjectDataProfileName.ofOrganizationLocationProjectDataProfileName(
               "[ORGANIZATION]", "[LOCATION]", "[PROJECT_DATA_PROFILE]")
           .toString();
   ProjectDataProfile response = dlpServiceClient.getProjectDataProfile(name);
 }
Parameter
Name Description
name String

Required. Resource name, for example organizations/12345/locations/us/projectDataProfiles/53234423.
Returns
Type Description
ProjectDataProfile

getProjectDataProfileCallable()

public final UnaryCallable<GetProjectDataProfileRequest,ProjectDataProfile> getProjectDataProfileCallable()

Gets a project data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetProjectDataProfileRequest request =
       GetProjectDataProfileRequest.newBuilder()
           .setName(
               ProjectDataProfileName.ofOrganizationLocationProjectDataProfileName(
                       "[ORGANIZATION]", "[LOCATION]", "[PROJECT_DATA_PROFILE]")
                   .toString())
           .build();
   ApiFuture<ProjectDataProfile> future =
       dlpServiceClient.getProjectDataProfileCallable().futureCall(request);
   // Do something.
   ProjectDataProfile response = future.get();
 }
Returns
Type Description
UnaryCallable<GetProjectDataProfileRequest,ProjectDataProfile>

getSettings()

public final DlpServiceSettings getSettings()
Returns
Type Description
DlpServiceSettings

getStoredInfoType(GetStoredInfoTypeRequest request)

public final StoredInfoType getStoredInfoType(GetStoredInfoTypeRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetStoredInfoTypeRequest request =
       GetStoredInfoTypeRequest.newBuilder()
           .setName(
               StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
                       "[ORGANIZATION]", "[STORED_INFO_TYPE]")
                   .toString())
           .build();
   StoredInfoType response = dlpServiceClient.getStoredInfoType(request);
 }
Parameter
Name Description
request GetStoredInfoTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
StoredInfoType

getStoredInfoType(StoredInfoTypeName name)

public final StoredInfoType getStoredInfoType(StoredInfoTypeName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   StoredInfoTypeName name =
       StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
           "[ORGANIZATION]", "[STORED_INFO_TYPE]");
   StoredInfoType response = dlpServiceClient.getStoredInfoType(name);
 }
Parameter
Name Description
name StoredInfoTypeName

Required. Resource name of the organization and storedInfoType to be read, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.
Returns
Type Description
StoredInfoType

getStoredInfoType(String name)

public final StoredInfoType getStoredInfoType(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
               "[ORGANIZATION]", "[STORED_INFO_TYPE]")
           .toString();
   StoredInfoType response = dlpServiceClient.getStoredInfoType(name);
 }
Parameter
Name Description
name String

Required. Resource name of the organization and storedInfoType to be read, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.
Returns
Type Description
StoredInfoType

getStoredInfoTypeCallable()

public final UnaryCallable<GetStoredInfoTypeRequest,StoredInfoType> getStoredInfoTypeCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetStoredInfoTypeRequest request =
       GetStoredInfoTypeRequest.newBuilder()
           .setName(
               StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
                       "[ORGANIZATION]", "[STORED_INFO_TYPE]")
                   .toString())
           .build();
   ApiFuture<StoredInfoType> future =
       dlpServiceClient.getStoredInfoTypeCallable().futureCall(request);
   // Do something.
   StoredInfoType response = future.get();
 }
Returns
Type Description
UnaryCallable<GetStoredInfoTypeRequest,StoredInfoType>

getStub()

public DlpServiceStub getStub()
Returns
Type Description
DlpServiceStub

getTableDataProfile(GetTableDataProfileRequest request)

public final TableDataProfile getTableDataProfile(GetTableDataProfileRequest request)

Gets a table data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetTableDataProfileRequest request =
       GetTableDataProfileRequest.newBuilder()
           .setName(
               TableDataProfileName.ofOrganizationLocationTableDataProfileName(
                       "[ORGANIZATION]", "[LOCATION]", "[TABLE_DATA_PROFILE]")
                   .toString())
           .build();
   TableDataProfile response = dlpServiceClient.getTableDataProfile(request);
 }
Parameter
Name Description
request GetTableDataProfileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TableDataProfile

getTableDataProfile(TableDataProfileName name)

public final TableDataProfile getTableDataProfile(TableDataProfileName name)

Gets a table data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   TableDataProfileName name =
       TableDataProfileName.ofOrganizationLocationTableDataProfileName(
           "[ORGANIZATION]", "[LOCATION]", "[TABLE_DATA_PROFILE]");
   TableDataProfile response = dlpServiceClient.getTableDataProfile(name);
 }
Parameter
Name Description
name TableDataProfileName

Required. Resource name, for example organizations/12345/locations/us/tableDataProfiles/53234423.
Returns
Type Description
TableDataProfile

getTableDataProfile(String name)

public final TableDataProfile getTableDataProfile(String name)

Gets a table data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       TableDataProfileName.ofOrganizationLocationTableDataProfileName(
               "[ORGANIZATION]", "[LOCATION]", "[TABLE_DATA_PROFILE]")
           .toString();
   TableDataProfile response = dlpServiceClient.getTableDataProfile(name);
 }
Parameter
Name Description
name String

Required. Resource name, for example organizations/12345/locations/us/tableDataProfiles/53234423.
Returns
Type Description
TableDataProfile

getTableDataProfileCallable()

public final UnaryCallable<GetTableDataProfileRequest,TableDataProfile> getTableDataProfileCallable()

Gets a table data profile.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   GetTableDataProfileRequest request =
       GetTableDataProfileRequest.newBuilder()
           .setName(
               TableDataProfileName.ofOrganizationLocationTableDataProfileName(
                       "[ORGANIZATION]", "[LOCATION]", "[TABLE_DATA_PROFILE]")
                   .toString())
           .build();
   ApiFuture<TableDataProfile> future =
       dlpServiceClient.getTableDataProfileCallable().futureCall(request);
   // Do something.
   TableDataProfile response = future.get();
 }
Returns
Type Description
UnaryCallable<GetTableDataProfileRequest,TableDataProfile>

hybridInspectDlpJob(DlpJobName name)

public final HybridInspectResponse hybridInspectDlpJob(DlpJobName name)

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DlpJobName name =
       DlpJobName.ofProjectLocationDlpJobName("[PROJECT]", "[LOCATION]", "[DLP_JOB]");
   HybridInspectResponse response = dlpServiceClient.hybridInspectDlpJob(name);
 }
Parameter
Name Description
name DlpJobName

Required. Resource name of the job to execute a hybrid inspect on, for example projects/dlp-test-project/dlpJob/53234423.
Returns
Type Description
HybridInspectResponse

hybridInspectDlpJob(HybridInspectDlpJobRequest request)

public final HybridInspectResponse hybridInspectDlpJob(HybridInspectDlpJobRequest request)

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   HybridInspectDlpJobRequest request =
       HybridInspectDlpJobRequest.newBuilder()
           .setName(
               DlpJobName.ofProjectLocationDlpJobName("[PROJECT]", "[LOCATION]", "[DLP_JOB]")
                   .toString())
           .setHybridItem(HybridContentItem.newBuilder().build())
           .build();
   HybridInspectResponse response = dlpServiceClient.hybridInspectDlpJob(request);
 }
Parameter
Name Description
request HybridInspectDlpJobRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
HybridInspectResponse

hybridInspectDlpJob(String name)

public final HybridInspectResponse hybridInspectDlpJob(String name)

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = DlpJobName.ofProjectDlpJobName("[PROJECT]", "[DLP_JOB]").toString();
   HybridInspectResponse response = dlpServiceClient.hybridInspectDlpJob(name);
 }
Parameter
Name Description
name String

Required. Resource name of the job to execute a hybrid inspect on, for example projects/dlp-test-project/dlpJob/53234423.
Returns
Type Description
HybridInspectResponse

hybridInspectDlpJobCallable()

public final UnaryCallable<HybridInspectDlpJobRequest,HybridInspectResponse> hybridInspectDlpJobCallable()

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   HybridInspectDlpJobRequest request =
       HybridInspectDlpJobRequest.newBuilder()
           .setName(
               DlpJobName.ofProjectLocationDlpJobName("[PROJECT]", "[LOCATION]", "[DLP_JOB]")
                   .toString())
           .setHybridItem(HybridContentItem.newBuilder().build())
           .build();
   ApiFuture<HybridInspectResponse> future =
       dlpServiceClient.hybridInspectDlpJobCallable().futureCall(request);
   // Do something.
   HybridInspectResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<HybridInspectDlpJobRequest,HybridInspectResponse>

hybridInspectJobTrigger(HybridInspectJobTriggerRequest request)

public final HybridInspectResponse hybridInspectJobTrigger(HybridInspectJobTriggerRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   HybridInspectJobTriggerRequest request =
       HybridInspectJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectLocationJobTriggerName(
                       "[PROJECT]", "[LOCATION]", "[JOB_TRIGGER]")
                   .toString())
           .setHybridItem(HybridContentItem.newBuilder().build())
           .build();
   HybridInspectResponse response = dlpServiceClient.hybridInspectJobTrigger(request);
 }
Parameter
Name Description
request HybridInspectJobTriggerRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
HybridInspectResponse

hybridInspectJobTrigger(JobTriggerName name)

public final HybridInspectResponse hybridInspectJobTrigger(JobTriggerName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   JobTriggerName name =
       JobTriggerName.ofProjectLocationJobTriggerName(
           "[PROJECT]", "[LOCATION]", "[JOB_TRIGGER]");
   HybridInspectResponse response = dlpServiceClient.hybridInspectJobTrigger(name);
 }
Parameter
Name Description
name JobTriggerName

Required. Resource name of the trigger to execute a hybrid inspect on, for example projects/dlp-test-project/jobTriggers/53234423.
Returns
Type Description
HybridInspectResponse

hybridInspectJobTrigger(String name)

public final HybridInspectResponse hybridInspectJobTrigger(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString();
   HybridInspectResponse response = dlpServiceClient.hybridInspectJobTrigger(name);
 }
Parameter
Name Description
name String

Required. Resource name of the trigger to execute a hybrid inspect on, for example projects/dlp-test-project/jobTriggers/53234423.
Returns
Type Description
HybridInspectResponse

hybridInspectJobTriggerCallable()

public final UnaryCallable<HybridInspectJobTriggerRequest,HybridInspectResponse> hybridInspectJobTriggerCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   HybridInspectJobTriggerRequest request =
       HybridInspectJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectLocationJobTriggerName(
                       "[PROJECT]", "[LOCATION]", "[JOB_TRIGGER]")
                   .toString())
           .setHybridItem(HybridContentItem.newBuilder().build())
           .build();
   ApiFuture<HybridInspectResponse> future =
       dlpServiceClient.hybridInspectJobTriggerCallable().futureCall(request);
   // Do something.
   HybridInspectResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<HybridInspectJobTriggerRequest,HybridInspectResponse>

inspectContent(InspectContentRequest request)

public final InspectContentResponse inspectContent(InspectContentRequest request)

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/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   InspectContentRequest request =
       InspectContentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInspectConfig(InspectConfig.newBuilder().build())
           .setItem(ContentItem.newBuilder().build())
           .setInspectTemplateName("inspectTemplateName1828857433")
           .setLocationId("locationId1541836720")
           .build();
   InspectContentResponse response = dlpServiceClient.inspectContent(request);
 }
Parameter
Name Description
request InspectContentRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
InspectContentResponse

inspectContentCallable()

public final UnaryCallable<InspectContentRequest,InspectContentResponse> inspectContentCallable()

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/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   InspectContentRequest request =
       InspectContentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInspectConfig(InspectConfig.newBuilder().build())
           .setItem(ContentItem.newBuilder().build())
           .setInspectTemplateName("inspectTemplateName1828857433")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<InspectContentResponse> future =
       dlpServiceClient.inspectContentCallable().futureCall(request);
   // Do something.
   InspectContentResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<InspectContentRequest,InspectContentResponse>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listColumnDataProfiles(ListColumnDataProfilesRequest request)

public final DlpServiceClient.ListColumnDataProfilesPagedResponse listColumnDataProfiles(ListColumnDataProfilesRequest request)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListColumnDataProfilesRequest request =
       ListColumnDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (ColumnDataProfile element :
       dlpServiceClient.listColumnDataProfiles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListColumnDataProfilesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListColumnDataProfilesPagedResponse

listColumnDataProfiles(LocationName parent)

public final DlpServiceClient.ListColumnDataProfilesPagedResponse listColumnDataProfiles(LocationName parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ColumnDataProfile element :
       dlpServiceClient.listColumnDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
Returns
Type Description
DlpServiceClient.ListColumnDataProfilesPagedResponse

listColumnDataProfiles(OrganizationLocationName parent)

public final DlpServiceClient.ListColumnDataProfilesPagedResponse listColumnDataProfiles(OrganizationLocationName parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (ColumnDataProfile element :
       dlpServiceClient.listColumnDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationLocationName

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
Returns
Type Description
DlpServiceClient.ListColumnDataProfilesPagedResponse

listColumnDataProfiles(String parent)

public final DlpServiceClient.ListColumnDataProfilesPagedResponse listColumnDataProfiles(String parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (ColumnDataProfile element :
       dlpServiceClient.listColumnDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
Returns
Type Description
DlpServiceClient.ListColumnDataProfilesPagedResponse

listColumnDataProfilesCallable()

public final UnaryCallable<ListColumnDataProfilesRequest,ListColumnDataProfilesResponse> listColumnDataProfilesCallable()

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListColumnDataProfilesRequest request =
       ListColumnDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListColumnDataProfilesResponse response =
         dlpServiceClient.listColumnDataProfilesCallable().call(request);
     for (ColumnDataProfile element : response.getColumnDataProfilesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListColumnDataProfilesRequest,ListColumnDataProfilesResponse>

listColumnDataProfilesPagedCallable()

public final UnaryCallable<ListColumnDataProfilesRequest,DlpServiceClient.ListColumnDataProfilesPagedResponse> listColumnDataProfilesPagedCallable()

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListColumnDataProfilesRequest request =
       ListColumnDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<ColumnDataProfile> future =
       dlpServiceClient.listColumnDataProfilesPagedCallable().futureCall(request);
   // Do something.
   for (ColumnDataProfile element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListColumnDataProfilesRequest,ListColumnDataProfilesPagedResponse>

listDeidentifyTemplates(ListDeidentifyTemplatesRequest request)

public final DlpServiceClient.ListDeidentifyTemplatesPagedResponse listDeidentifyTemplates(ListDeidentifyTemplatesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDeidentifyTemplatesRequest request =
       ListDeidentifyTemplatesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   for (DeidentifyTemplate element :
       dlpServiceClient.listDeidentifyTemplates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDeidentifyTemplatesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListDeidentifyTemplatesPagedResponse

listDeidentifyTemplates(LocationName parent)

public final DlpServiceClient.ListDeidentifyTemplatesPagedResponse listDeidentifyTemplates(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DeidentifyTemplate element :
       dlpServiceClient.listDeidentifyTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDeidentifyTemplatesPagedResponse

listDeidentifyTemplates(OrganizationLocationName parent)

public final DlpServiceClient.ListDeidentifyTemplatesPagedResponse listDeidentifyTemplates(OrganizationLocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (DeidentifyTemplate element :
       dlpServiceClient.listDeidentifyTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationLocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDeidentifyTemplatesPagedResponse

listDeidentifyTemplates(OrganizationName parent)

public final DlpServiceClient.ListDeidentifyTemplatesPagedResponse listDeidentifyTemplates(OrganizationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (DeidentifyTemplate element :
       dlpServiceClient.listDeidentifyTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDeidentifyTemplatesPagedResponse

listDeidentifyTemplates(ProjectName parent)

public final DlpServiceClient.ListDeidentifyTemplatesPagedResponse listDeidentifyTemplates(ProjectName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (DeidentifyTemplate element :
       dlpServiceClient.listDeidentifyTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDeidentifyTemplatesPagedResponse

listDeidentifyTemplates(String parent)

public final DlpServiceClient.ListDeidentifyTemplatesPagedResponse listDeidentifyTemplates(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   for (DeidentifyTemplate element :
       dlpServiceClient.listDeidentifyTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDeidentifyTemplatesPagedResponse

listDeidentifyTemplatesCallable()

public final UnaryCallable<ListDeidentifyTemplatesRequest,ListDeidentifyTemplatesResponse> listDeidentifyTemplatesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDeidentifyTemplatesRequest request =
       ListDeidentifyTemplatesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   while (true) {
     ListDeidentifyTemplatesResponse response =
         dlpServiceClient.listDeidentifyTemplatesCallable().call(request);
     for (DeidentifyTemplate element : response.getDeidentifyTemplatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDeidentifyTemplatesRequest,ListDeidentifyTemplatesResponse>

listDeidentifyTemplatesPagedCallable()

public final UnaryCallable<ListDeidentifyTemplatesRequest,DlpServiceClient.ListDeidentifyTemplatesPagedResponse> listDeidentifyTemplatesPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDeidentifyTemplatesRequest request =
       ListDeidentifyTemplatesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<DeidentifyTemplate> future =
       dlpServiceClient.listDeidentifyTemplatesPagedCallable().futureCall(request);
   // Do something.
   for (DeidentifyTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDeidentifyTemplatesRequest,ListDeidentifyTemplatesPagedResponse>

listDiscoveryConfigs(ListDiscoveryConfigsRequest request)

public final DlpServiceClient.ListDiscoveryConfigsPagedResponse listDiscoveryConfigs(ListDiscoveryConfigsRequest request)

Lists discovery configurations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDiscoveryConfigsRequest request =
       ListDiscoveryConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .build();
   for (DiscoveryConfig element : dlpServiceClient.listDiscoveryConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDiscoveryConfigsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListDiscoveryConfigsPagedResponse

listDiscoveryConfigs(LocationName parent)

public final DlpServiceClient.ListDiscoveryConfigsPagedResponse listDiscoveryConfigs(LocationName parent)

Lists discovery configurations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DiscoveryConfig element : dlpServiceClient.listDiscoveryConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Parent resource name.

The format of this value is as follows: projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDiscoveryConfigsPagedResponse

listDiscoveryConfigs(String parent)

public final DlpServiceClient.ListDiscoveryConfigsPagedResponse listDiscoveryConfigs(String parent)

Lists discovery configurations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (DiscoveryConfig element : dlpServiceClient.listDiscoveryConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Parent resource name.

The format of this value is as follows: projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDiscoveryConfigsPagedResponse

listDiscoveryConfigsCallable()

public final UnaryCallable<ListDiscoveryConfigsRequest,ListDiscoveryConfigsResponse> listDiscoveryConfigsCallable()

Lists discovery configurations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDiscoveryConfigsRequest request =
       ListDiscoveryConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDiscoveryConfigsResponse response =
         dlpServiceClient.listDiscoveryConfigsCallable().call(request);
     for (DiscoveryConfig element : response.getDiscoveryConfigsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDiscoveryConfigsRequest,ListDiscoveryConfigsResponse>

listDiscoveryConfigsPagedCallable()

public final UnaryCallable<ListDiscoveryConfigsRequest,DlpServiceClient.ListDiscoveryConfigsPagedResponse> listDiscoveryConfigsPagedCallable()

Lists discovery configurations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDiscoveryConfigsRequest request =
       ListDiscoveryConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<DiscoveryConfig> future =
       dlpServiceClient.listDiscoveryConfigsPagedCallable().futureCall(request);
   // Do something.
   for (DiscoveryConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDiscoveryConfigsRequest,ListDiscoveryConfigsPagedResponse>

listDlpJobs(ListDlpJobsRequest request)

public final DlpServiceClient.ListDlpJobsPagedResponse listDlpJobs(ListDlpJobsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDlpJobsRequest request =
       ListDlpJobsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setType(DlpJobType.forNumber(0))
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   for (DlpJob element : dlpServiceClient.listDlpJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDlpJobsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListDlpJobsPagedResponse

listDlpJobs(LocationName parent)

public final DlpServiceClient.ListDlpJobsPagedResponse listDlpJobs(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DlpJob element : dlpServiceClient.listDlpJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDlpJobsPagedResponse

listDlpJobs(ProjectName parent)

public final DlpServiceClient.ListDlpJobsPagedResponse listDlpJobs(ProjectName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (DlpJob element : dlpServiceClient.listDlpJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDlpJobsPagedResponse

listDlpJobs(String parent)

public final DlpServiceClient.ListDlpJobsPagedResponse listDlpJobs(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (DlpJob element : dlpServiceClient.listDlpJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListDlpJobsPagedResponse

listDlpJobsCallable()

public final UnaryCallable<ListDlpJobsRequest,ListDlpJobsResponse> listDlpJobsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDlpJobsRequest request =
       ListDlpJobsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setType(DlpJobType.forNumber(0))
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   while (true) {
     ListDlpJobsResponse response = dlpServiceClient.listDlpJobsCallable().call(request);
     for (DlpJob element : response.getJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDlpJobsRequest,ListDlpJobsResponse>

listDlpJobsPagedCallable()

public final UnaryCallable<ListDlpJobsRequest,DlpServiceClient.ListDlpJobsPagedResponse> listDlpJobsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListDlpJobsRequest request =
       ListDlpJobsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setType(DlpJobType.forNumber(0))
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<DlpJob> future = dlpServiceClient.listDlpJobsPagedCallable().futureCall(request);
   // Do something.
   for (DlpJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDlpJobsRequest,ListDlpJobsPagedResponse>

listInfoTypes(ListInfoTypesRequest request)

public final ListInfoTypesResponse listInfoTypes(ListInfoTypesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListInfoTypesRequest request =
       ListInfoTypesRequest.newBuilder()
           .setParent("parent-995424086")
           .setLanguageCode("languageCode-2092349083")
           .setFilter("filter-1274492040")
           .setLocationId("locationId1541836720")
           .build();
   ListInfoTypesResponse response = dlpServiceClient.listInfoTypes(request);
 }
Parameter
Name Description
request ListInfoTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ListInfoTypesResponse

listInfoTypes(String parent)

public final ListInfoTypesResponse listInfoTypes(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = "parent-995424086";
   ListInfoTypesResponse response = dlpServiceClient.listInfoTypes(parent);
 }
Parameter
Name Description
parent String

The parent resource name.

The format of this value is as follows:

locations/<var>LOCATION_ID</var>
Returns
Type Description
ListInfoTypesResponse

listInfoTypesCallable()

public final UnaryCallable<ListInfoTypesRequest,ListInfoTypesResponse> listInfoTypesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListInfoTypesRequest request =
       ListInfoTypesRequest.newBuilder()
           .setParent("parent-995424086")
           .setLanguageCode("languageCode-2092349083")
           .setFilter("filter-1274492040")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<ListInfoTypesResponse> future =
       dlpServiceClient.listInfoTypesCallable().futureCall(request);
   // Do something.
   ListInfoTypesResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<ListInfoTypesRequest,ListInfoTypesResponse>

listInspectTemplates(ListInspectTemplatesRequest request)

public final DlpServiceClient.ListInspectTemplatesPagedResponse listInspectTemplates(ListInspectTemplatesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListInspectTemplatesRequest request =
       ListInspectTemplatesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   for (InspectTemplate element : dlpServiceClient.listInspectTemplates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListInspectTemplatesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListInspectTemplatesPagedResponse

listInspectTemplates(LocationName parent)

public final DlpServiceClient.ListInspectTemplatesPagedResponse listInspectTemplates(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (InspectTemplate element : dlpServiceClient.listInspectTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListInspectTemplatesPagedResponse

listInspectTemplates(OrganizationLocationName parent)

public final DlpServiceClient.ListInspectTemplatesPagedResponse listInspectTemplates(OrganizationLocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (InspectTemplate element : dlpServiceClient.listInspectTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationLocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListInspectTemplatesPagedResponse

listInspectTemplates(OrganizationName parent)

public final DlpServiceClient.ListInspectTemplatesPagedResponse listInspectTemplates(OrganizationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (InspectTemplate element : dlpServiceClient.listInspectTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListInspectTemplatesPagedResponse

listInspectTemplates(ProjectName parent)

public final DlpServiceClient.ListInspectTemplatesPagedResponse listInspectTemplates(ProjectName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (InspectTemplate element : dlpServiceClient.listInspectTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListInspectTemplatesPagedResponse

listInspectTemplates(String parent)

public final DlpServiceClient.ListInspectTemplatesPagedResponse listInspectTemplates(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   for (InspectTemplate element : dlpServiceClient.listInspectTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> + Organizations scope, location specified:<br/> organizations/<var>ORG_ID</var>/locations/<var>LOCATION_ID</var>
  • Organizations scope, no location specified (defaults to global):<br/> organizations/<var>ORG_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListInspectTemplatesPagedResponse

listInspectTemplatesCallable()

public final UnaryCallable<ListInspectTemplatesRequest,ListInspectTemplatesResponse> listInspectTemplatesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListInspectTemplatesRequest request =
       ListInspectTemplatesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   while (true) {
     ListInspectTemplatesResponse response =
         dlpServiceClient.listInspectTemplatesCallable().call(request);
     for (InspectTemplate element : response.getInspectTemplatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListInspectTemplatesRequest,ListInspectTemplatesResponse>

listInspectTemplatesPagedCallable()

public final UnaryCallable<ListInspectTemplatesRequest,DlpServiceClient.ListInspectTemplatesPagedResponse> listInspectTemplatesPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListInspectTemplatesRequest request =
       ListInspectTemplatesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<InspectTemplate> future =
       dlpServiceClient.listInspectTemplatesPagedCallable().futureCall(request);
   // Do something.
   for (InspectTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListInspectTemplatesRequest,ListInspectTemplatesPagedResponse>

listJobTriggers(ListJobTriggersRequest request)

public final DlpServiceClient.ListJobTriggersPagedResponse listJobTriggers(ListJobTriggersRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListJobTriggersRequest request =
       ListJobTriggersRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .setType(DlpJobType.forNumber(0))
           .setLocationId("locationId1541836720")
           .build();
   for (JobTrigger element : dlpServiceClient.listJobTriggers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListJobTriggersRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListJobTriggersPagedResponse

listJobTriggers(LocationName parent)

public final DlpServiceClient.ListJobTriggersPagedResponse listJobTriggers(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (JobTrigger element : dlpServiceClient.listJobTriggers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListJobTriggersPagedResponse

listJobTriggers(ProjectName parent)

public final DlpServiceClient.ListJobTriggersPagedResponse listJobTriggers(ProjectName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (JobTrigger element : dlpServiceClient.listJobTriggers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListJobTriggersPagedResponse

listJobTriggers(String parent)

public final DlpServiceClient.ListJobTriggersPagedResponse listJobTriggers(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (JobTrigger element : dlpServiceClient.listJobTriggers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListJobTriggersPagedResponse

listJobTriggersCallable()

public final UnaryCallable<ListJobTriggersRequest,ListJobTriggersResponse> listJobTriggersCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListJobTriggersRequest request =
       ListJobTriggersRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .setType(DlpJobType.forNumber(0))
           .setLocationId("locationId1541836720")
           .build();
   while (true) {
     ListJobTriggersResponse response = dlpServiceClient.listJobTriggersCallable().call(request);
     for (JobTrigger element : response.getJobTriggersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListJobTriggersRequest,ListJobTriggersResponse>

listJobTriggersPagedCallable()

public final UnaryCallable<ListJobTriggersRequest,DlpServiceClient.ListJobTriggersPagedResponse> listJobTriggersPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListJobTriggersRequest request =
       ListJobTriggersRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .setType(DlpJobType.forNumber(0))
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<JobTrigger> future =
       dlpServiceClient.listJobTriggersPagedCallable().futureCall(request);
   // Do something.
   for (JobTrigger element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListJobTriggersRequest,ListJobTriggersPagedResponse>

listProjectDataProfiles(ListProjectDataProfilesRequest request)

public final DlpServiceClient.ListProjectDataProfilesPagedResponse listProjectDataProfiles(ListProjectDataProfilesRequest request)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListProjectDataProfilesRequest request =
       ListProjectDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (ProjectDataProfile element :
       dlpServiceClient.listProjectDataProfiles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListProjectDataProfilesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListProjectDataProfilesPagedResponse

listProjectDataProfiles(LocationName parent)

public final DlpServiceClient.ListProjectDataProfilesPagedResponse listProjectDataProfiles(LocationName parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ProjectDataProfile element :
       dlpServiceClient.listProjectDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. organizations/{org_id}/locations/{loc_id}
Returns
Type Description
DlpServiceClient.ListProjectDataProfilesPagedResponse

listProjectDataProfiles(OrganizationLocationName parent)

public final DlpServiceClient.ListProjectDataProfilesPagedResponse listProjectDataProfiles(OrganizationLocationName parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (ProjectDataProfile element :
       dlpServiceClient.listProjectDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationLocationName

Required. organizations/{org_id}/locations/{loc_id}
Returns
Type Description
DlpServiceClient.ListProjectDataProfilesPagedResponse

listProjectDataProfiles(String parent)

public final DlpServiceClient.ListProjectDataProfilesPagedResponse listProjectDataProfiles(String parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (ProjectDataProfile element :
       dlpServiceClient.listProjectDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. organizations/{org_id}/locations/{loc_id}
Returns
Type Description
DlpServiceClient.ListProjectDataProfilesPagedResponse

listProjectDataProfilesCallable()

public final UnaryCallable<ListProjectDataProfilesRequest,ListProjectDataProfilesResponse> listProjectDataProfilesCallable()

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListProjectDataProfilesRequest request =
       ListProjectDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListProjectDataProfilesResponse response =
         dlpServiceClient.listProjectDataProfilesCallable().call(request);
     for (ProjectDataProfile element : response.getProjectDataProfilesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListProjectDataProfilesRequest,ListProjectDataProfilesResponse>

listProjectDataProfilesPagedCallable()

public final UnaryCallable<ListProjectDataProfilesRequest,DlpServiceClient.ListProjectDataProfilesPagedResponse> listProjectDataProfilesPagedCallable()

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListProjectDataProfilesRequest request =
       ListProjectDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<ProjectDataProfile> future =
       dlpServiceClient.listProjectDataProfilesPagedCallable().futureCall(request);
   // Do something.
   for (ProjectDataProfile element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListProjectDataProfilesRequest,ListProjectDataProfilesPagedResponse>

listStoredInfoTypes(ListStoredInfoTypesRequest request)

public final DlpServiceClient.ListStoredInfoTypesPagedResponse listStoredInfoTypes(ListStoredInfoTypesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListStoredInfoTypesRequest request =
       ListStoredInfoTypesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   for (StoredInfoType element : dlpServiceClient.listStoredInfoTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListStoredInfoTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListStoredInfoTypesPagedResponse

listStoredInfoTypes(LocationName parent)

public final DlpServiceClient.ListStoredInfoTypesPagedResponse listStoredInfoTypes(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (StoredInfoType element : dlpServiceClient.listStoredInfoTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListStoredInfoTypesPagedResponse

listStoredInfoTypes(OrganizationLocationName parent)

public final DlpServiceClient.ListStoredInfoTypesPagedResponse listStoredInfoTypes(OrganizationLocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (StoredInfoType element : dlpServiceClient.listStoredInfoTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationLocationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListStoredInfoTypesPagedResponse

listStoredInfoTypes(OrganizationName parent)

public final DlpServiceClient.ListStoredInfoTypesPagedResponse listStoredInfoTypes(OrganizationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (StoredInfoType element : dlpServiceClient.listStoredInfoTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListStoredInfoTypesPagedResponse

listStoredInfoTypes(ProjectName parent)

public final DlpServiceClient.ListStoredInfoTypesPagedResponse listStoredInfoTypes(ProjectName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (StoredInfoType element : dlpServiceClient.listStoredInfoTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ProjectName

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListStoredInfoTypesPagedResponse

listStoredInfoTypes(String parent)

public final DlpServiceClient.ListStoredInfoTypesPagedResponse listStoredInfoTypes(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   for (StoredInfoType element : dlpServiceClient.listStoredInfoTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Parent resource name.

The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

+ Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
Type Description
DlpServiceClient.ListStoredInfoTypesPagedResponse

listStoredInfoTypesCallable()

public final UnaryCallable<ListStoredInfoTypesRequest,ListStoredInfoTypesResponse> listStoredInfoTypesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListStoredInfoTypesRequest request =
       ListStoredInfoTypesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   while (true) {
     ListStoredInfoTypesResponse response =
         dlpServiceClient.listStoredInfoTypesCallable().call(request);
     for (StoredInfoType element : response.getStoredInfoTypesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListStoredInfoTypesRequest,ListStoredInfoTypesResponse>

listStoredInfoTypesPagedCallable()

public final UnaryCallable<ListStoredInfoTypesRequest,DlpServiceClient.ListStoredInfoTypesPagedResponse> listStoredInfoTypesPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListStoredInfoTypesRequest request =
       ListStoredInfoTypesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<StoredInfoType> future =
       dlpServiceClient.listStoredInfoTypesPagedCallable().futureCall(request);
   // Do something.
   for (StoredInfoType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListStoredInfoTypesRequest,ListStoredInfoTypesPagedResponse>

listTableDataProfiles(ListTableDataProfilesRequest request)

public final DlpServiceClient.ListTableDataProfilesPagedResponse listTableDataProfiles(ListTableDataProfilesRequest request)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListTableDataProfilesRequest request =
       ListTableDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (TableDataProfile element :
       dlpServiceClient.listTableDataProfiles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListTableDataProfilesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DlpServiceClient.ListTableDataProfilesPagedResponse

listTableDataProfiles(LocationName parent)

public final DlpServiceClient.ListTableDataProfilesPagedResponse listTableDataProfiles(LocationName parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (TableDataProfile element : dlpServiceClient.listTableDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
Returns
Type Description
DlpServiceClient.ListTableDataProfilesPagedResponse

listTableDataProfiles(OrganizationLocationName parent)

public final DlpServiceClient.ListTableDataProfilesPagedResponse listTableDataProfiles(OrganizationLocationName parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (TableDataProfile element : dlpServiceClient.listTableDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationLocationName

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
Returns
Type Description
DlpServiceClient.ListTableDataProfilesPagedResponse

listTableDataProfiles(String parent)

public final DlpServiceClient.ListTableDataProfilesPagedResponse listTableDataProfiles(String parent)

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (TableDataProfile element : dlpServiceClient.listTableDataProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
Returns
Type Description
DlpServiceClient.ListTableDataProfilesPagedResponse

listTableDataProfilesCallable()

public final UnaryCallable<ListTableDataProfilesRequest,ListTableDataProfilesResponse> listTableDataProfilesCallable()

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListTableDataProfilesRequest request =
       ListTableDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListTableDataProfilesResponse response =
         dlpServiceClient.listTableDataProfilesCallable().call(request);
     for (TableDataProfile element : response.getTableDataProfilesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListTableDataProfilesRequest,ListTableDataProfilesResponse>

listTableDataProfilesPagedCallable()

public final UnaryCallable<ListTableDataProfilesRequest,DlpServiceClient.ListTableDataProfilesPagedResponse> listTableDataProfilesPagedCallable()

Lists data profiles for an organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ListTableDataProfilesRequest request =
       ListTableDataProfilesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<TableDataProfile> future =
       dlpServiceClient.listTableDataProfilesPagedCallable().futureCall(request);
   // Do something.
   for (TableDataProfile element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListTableDataProfilesRequest,ListTableDataProfilesPagedResponse>

redactImage(RedactImageRequest request)

public final RedactImageResponse redactImage(RedactImageRequest request)

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   RedactImageRequest request =
       RedactImageRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setLocationId("locationId1541836720")
           .setInspectConfig(InspectConfig.newBuilder().build())
           .addAllImageRedactionConfigs(new ArrayList<RedactImageRequest.ImageRedactionConfig>())
           .setIncludeFindings(true)
           .setByteItem(ByteContentItem.newBuilder().build())
           .build();
   RedactImageResponse response = dlpServiceClient.redactImage(request);
 }
Parameter
Name Description
request RedactImageRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RedactImageResponse

redactImageCallable()

public final UnaryCallable<RedactImageRequest,RedactImageResponse> redactImageCallable()

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   RedactImageRequest request =
       RedactImageRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setLocationId("locationId1541836720")
           .setInspectConfig(InspectConfig.newBuilder().build())
           .addAllImageRedactionConfigs(new ArrayList<RedactImageRequest.ImageRedactionConfig>())
           .setIncludeFindings(true)
           .setByteItem(ByteContentItem.newBuilder().build())
           .build();
   ApiFuture<RedactImageResponse> future =
       dlpServiceClient.redactImageCallable().futureCall(request);
   // Do something.
   RedactImageResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<RedactImageRequest,RedactImageResponse>

reidentifyContent(ReidentifyContentRequest request)

public final ReidentifyContentResponse reidentifyContent(ReidentifyContentRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ReidentifyContentRequest request =
       ReidentifyContentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setReidentifyConfig(DeidentifyConfig.newBuilder().build())
           .setInspectConfig(InspectConfig.newBuilder().build())
           .setItem(ContentItem.newBuilder().build())
           .setInspectTemplateName("inspectTemplateName1828857433")
           .setReidentifyTemplateName("reidentifyTemplateName157316612")
           .setLocationId("locationId1541836720")
           .build();
   ReidentifyContentResponse response = dlpServiceClient.reidentifyContent(request);
 }
Parameter
Name Description
request ReidentifyContentRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ReidentifyContentResponse

reidentifyContentCallable()

public final UnaryCallable<ReidentifyContentRequest,ReidentifyContentResponse> reidentifyContentCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ReidentifyContentRequest request =
       ReidentifyContentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setReidentifyConfig(DeidentifyConfig.newBuilder().build())
           .setInspectConfig(InspectConfig.newBuilder().build())
           .setItem(ContentItem.newBuilder().build())
           .setInspectTemplateName("inspectTemplateName1828857433")
           .setReidentifyTemplateName("reidentifyTemplateName157316612")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<ReidentifyContentResponse> future =
       dlpServiceClient.reidentifyContentCallable().futureCall(request);
   // Do something.
   ReidentifyContentResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<ReidentifyContentRequest,ReidentifyContentResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDeidentifyTemplate(DeidentifyTemplateName name, DeidentifyTemplate deidentifyTemplate, FieldMask updateMask)

public final DeidentifyTemplate updateDeidentifyTemplate(DeidentifyTemplateName name, DeidentifyTemplate deidentifyTemplate, FieldMask updateMask)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeidentifyTemplateName name =
       DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
           "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]");
   DeidentifyTemplate deidentifyTemplate = DeidentifyTemplate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DeidentifyTemplate response =
       dlpServiceClient.updateDeidentifyTemplate(name, deidentifyTemplate, updateMask);
 }
Parameters
Name Description
name DeidentifyTemplateName

Required. Resource name of organization and deidentify template to be updated, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.
deidentifyTemplate DeidentifyTemplate

New DeidentifyTemplate value.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
DeidentifyTemplate

updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request)

public final DeidentifyTemplate updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateDeidentifyTemplateRequest request =
       UpdateDeidentifyTemplateRequest.newBuilder()
           .setName(
               DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
                       "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
                   .toString())
           .setDeidentifyTemplate(DeidentifyTemplate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DeidentifyTemplate response = dlpServiceClient.updateDeidentifyTemplate(request);
 }
Parameter
Name Description
request UpdateDeidentifyTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DeidentifyTemplate

updateDeidentifyTemplate(String name, DeidentifyTemplate deidentifyTemplate, FieldMask updateMask)

public final DeidentifyTemplate updateDeidentifyTemplate(String name, DeidentifyTemplate deidentifyTemplate, FieldMask updateMask)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
               "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
           .toString();
   DeidentifyTemplate deidentifyTemplate = DeidentifyTemplate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DeidentifyTemplate response =
       dlpServiceClient.updateDeidentifyTemplate(name, deidentifyTemplate, updateMask);
 }
Parameters
Name Description
name String

Required. Resource name of organization and deidentify template to be updated, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.
deidentifyTemplate DeidentifyTemplate

New DeidentifyTemplate value.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
DeidentifyTemplate

updateDeidentifyTemplateCallable()

public final UnaryCallable<UpdateDeidentifyTemplateRequest,DeidentifyTemplate> updateDeidentifyTemplateCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateDeidentifyTemplateRequest request =
       UpdateDeidentifyTemplateRequest.newBuilder()
           .setName(
               DeidentifyTemplateName.ofOrganizationDeidentifyTemplateName(
                       "[ORGANIZATION]", "[DEIDENTIFY_TEMPLATE]")
                   .toString())
           .setDeidentifyTemplate(DeidentifyTemplate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<DeidentifyTemplate> future =
       dlpServiceClient.updateDeidentifyTemplateCallable().futureCall(request);
   // Do something.
   DeidentifyTemplate response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateDeidentifyTemplateRequest,DeidentifyTemplate>

updateDiscoveryConfig(DiscoveryConfigName name, DiscoveryConfig discoveryConfig, FieldMask updateMask)

public final DiscoveryConfig updateDiscoveryConfig(DiscoveryConfigName name, DiscoveryConfig discoveryConfig, FieldMask updateMask)

Updates a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DiscoveryConfigName name =
       DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]");
   DiscoveryConfig discoveryConfig = DiscoveryConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DiscoveryConfig response =
       dlpServiceClient.updateDiscoveryConfig(name, discoveryConfig, updateMask);
 }
Parameters
Name Description
name DiscoveryConfigName

Required. Resource name of the project and the configuration, for example projects/dlp-test-project/discoveryConfigs/53234423.
discoveryConfig DiscoveryConfig

Required. New DiscoveryConfig value.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
DiscoveryConfig

updateDiscoveryConfig(UpdateDiscoveryConfigRequest request)

public final DiscoveryConfig updateDiscoveryConfig(UpdateDiscoveryConfigRequest request)

Updates a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateDiscoveryConfigRequest request =
       UpdateDiscoveryConfigRequest.newBuilder()
           .setName(
               DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]")
                   .toString())
           .setDiscoveryConfig(DiscoveryConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DiscoveryConfig response = dlpServiceClient.updateDiscoveryConfig(request);
 }
Parameter
Name Description
request UpdateDiscoveryConfigRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DiscoveryConfig

updateDiscoveryConfig(String name, DiscoveryConfig discoveryConfig, FieldMask updateMask)

public final DiscoveryConfig updateDiscoveryConfig(String name, DiscoveryConfig discoveryConfig, FieldMask updateMask)

Updates a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]").toString();
   DiscoveryConfig discoveryConfig = DiscoveryConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DiscoveryConfig response =
       dlpServiceClient.updateDiscoveryConfig(name, discoveryConfig, updateMask);
 }
Parameters
Name Description
name String

Required. Resource name of the project and the configuration, for example projects/dlp-test-project/discoveryConfigs/53234423.
discoveryConfig DiscoveryConfig

Required. New DiscoveryConfig value.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
DiscoveryConfig

updateDiscoveryConfigCallable()

public final UnaryCallable<UpdateDiscoveryConfigRequest,DiscoveryConfig> updateDiscoveryConfigCallable()

Updates a discovery configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateDiscoveryConfigRequest request =
       UpdateDiscoveryConfigRequest.newBuilder()
           .setName(
               DiscoveryConfigName.of("[PROJECT]", "[LOCATION]", "[DISCOVERY_CONFIG]")
                   .toString())
           .setDiscoveryConfig(DiscoveryConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<DiscoveryConfig> future =
       dlpServiceClient.updateDiscoveryConfigCallable().futureCall(request);
   // Do something.
   DiscoveryConfig response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateDiscoveryConfigRequest,DiscoveryConfig>

updateInspectTemplate(InspectTemplateName name, InspectTemplate inspectTemplate, FieldMask updateMask)

public final InspectTemplate updateInspectTemplate(InspectTemplateName name, InspectTemplate inspectTemplate, FieldMask updateMask)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   InspectTemplateName name =
       InspectTemplateName.ofOrganizationInspectTemplateName(
           "[ORGANIZATION]", "[INSPECT_TEMPLATE]");
   InspectTemplate inspectTemplate = InspectTemplate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   InspectTemplate response =
       dlpServiceClient.updateInspectTemplate(name, inspectTemplate, updateMask);
 }
Parameters
Name Description
name InspectTemplateName

Required. Resource name of organization and inspectTemplate to be updated, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.
inspectTemplate InspectTemplate

New InspectTemplate value.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
InspectTemplate

updateInspectTemplate(UpdateInspectTemplateRequest request)

public final InspectTemplate updateInspectTemplate(UpdateInspectTemplateRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateInspectTemplateRequest request =
       UpdateInspectTemplateRequest.newBuilder()
           .setName(
               InspectTemplateName.ofOrganizationInspectTemplateName(
                       "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
                   .toString())
           .setInspectTemplate(InspectTemplate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   InspectTemplate response = dlpServiceClient.updateInspectTemplate(request);
 }
Parameter
Name Description
request UpdateInspectTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
InspectTemplate

updateInspectTemplate(String name, InspectTemplate inspectTemplate, FieldMask updateMask)

public final InspectTemplate updateInspectTemplate(String name, InspectTemplate inspectTemplate, FieldMask updateMask)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       InspectTemplateName.ofOrganizationInspectTemplateName(
               "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
           .toString();
   InspectTemplate inspectTemplate = InspectTemplate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   InspectTemplate response =
       dlpServiceClient.updateInspectTemplate(name, inspectTemplate, updateMask);
 }
Parameters
Name Description
name String

Required. Resource name of organization and inspectTemplate to be updated, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.
inspectTemplate InspectTemplate

New InspectTemplate value.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
InspectTemplate

updateInspectTemplateCallable()

public final UnaryCallable<UpdateInspectTemplateRequest,InspectTemplate> updateInspectTemplateCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateInspectTemplateRequest request =
       UpdateInspectTemplateRequest.newBuilder()
           .setName(
               InspectTemplateName.ofOrganizationInspectTemplateName(
                       "[ORGANIZATION]", "[INSPECT_TEMPLATE]")
                   .toString())
           .setInspectTemplate(InspectTemplate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<InspectTemplate> future =
       dlpServiceClient.updateInspectTemplateCallable().futureCall(request);
   // Do something.
   InspectTemplate response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateInspectTemplateRequest,InspectTemplate>

updateJobTrigger(JobTriggerName name, JobTrigger jobTrigger, FieldMask updateMask)

public final JobTrigger updateJobTrigger(JobTriggerName name, JobTrigger jobTrigger, FieldMask updateMask)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   JobTriggerName name = JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]");
   JobTrigger jobTrigger = JobTrigger.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   JobTrigger response = dlpServiceClient.updateJobTrigger(name, jobTrigger, updateMask);
 }
Parameters
Name Description
name JobTriggerName

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.
jobTrigger JobTrigger

New JobTrigger value.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
JobTrigger

updateJobTrigger(UpdateJobTriggerRequest request)

public final JobTrigger updateJobTrigger(UpdateJobTriggerRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateJobTriggerRequest request =
       UpdateJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString())
           .setJobTrigger(JobTrigger.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   JobTrigger response = dlpServiceClient.updateJobTrigger(request);
 }
Parameter
Name Description
request UpdateJobTriggerRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
JobTrigger

updateJobTrigger(String name, JobTrigger jobTrigger, FieldMask updateMask)

public final JobTrigger updateJobTrigger(String name, JobTrigger jobTrigger, FieldMask updateMask)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString();
   JobTrigger jobTrigger = JobTrigger.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   JobTrigger response = dlpServiceClient.updateJobTrigger(name, jobTrigger, updateMask);
 }
Parameters
Name Description
name String

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.
jobTrigger JobTrigger

New JobTrigger value.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
JobTrigger

updateJobTriggerCallable()

public final UnaryCallable<UpdateJobTriggerRequest,JobTrigger> updateJobTriggerCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateJobTriggerRequest request =
       UpdateJobTriggerRequest.newBuilder()
           .setName(
               JobTriggerName.ofProjectJobTriggerName("[PROJECT]", "[JOB_TRIGGER]").toString())
           .setJobTrigger(JobTrigger.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<JobTrigger> future =
       dlpServiceClient.updateJobTriggerCallable().futureCall(request);
   // Do something.
   JobTrigger response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateJobTriggerRequest,JobTrigger>

updateStoredInfoType(StoredInfoTypeName name, StoredInfoTypeConfig config, FieldMask updateMask)

public final StoredInfoType updateStoredInfoType(StoredInfoTypeName name, StoredInfoTypeConfig config, FieldMask updateMask)

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/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   StoredInfoTypeName name =
       StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
           "[ORGANIZATION]", "[STORED_INFO_TYPE]");
   StoredInfoTypeConfig config = StoredInfoTypeConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   StoredInfoType response = dlpServiceClient.updateStoredInfoType(name, config, updateMask);
 }
Parameters
Name Description
name StoredInfoTypeName

Required. Resource name of organization and storedInfoType to be updated, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.
config StoredInfoTypeConfig

Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
StoredInfoType

updateStoredInfoType(UpdateStoredInfoTypeRequest request)

public final StoredInfoType updateStoredInfoType(UpdateStoredInfoTypeRequest request)

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/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateStoredInfoTypeRequest request =
       UpdateStoredInfoTypeRequest.newBuilder()
           .setName(
               StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
                       "[ORGANIZATION]", "[STORED_INFO_TYPE]")
                   .toString())
           .setConfig(StoredInfoTypeConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   StoredInfoType response = dlpServiceClient.updateStoredInfoType(request);
 }
Parameter
Name Description
request UpdateStoredInfoTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
StoredInfoType

updateStoredInfoType(String name, StoredInfoTypeConfig config, FieldMask updateMask)

public final StoredInfoType updateStoredInfoType(String name, StoredInfoTypeConfig config, FieldMask updateMask)

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/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name =
       StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
               "[ORGANIZATION]", "[STORED_INFO_TYPE]")
           .toString();
   StoredInfoTypeConfig config = StoredInfoTypeConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   StoredInfoType response = dlpServiceClient.updateStoredInfoType(name, config, updateMask);
 }
Parameters
Name Description
name String

Required. Resource name of organization and storedInfoType to be updated, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.
config StoredInfoTypeConfig

Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration.
updateMask FieldMask

Mask to control which fields get updated.
Returns
Type Description
StoredInfoType

updateStoredInfoTypeCallable()

public final UnaryCallable<UpdateStoredInfoTypeRequest,StoredInfoType> updateStoredInfoTypeCallable()

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/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   UpdateStoredInfoTypeRequest request =
       UpdateStoredInfoTypeRequest.newBuilder()
           .setName(
               StoredInfoTypeName.ofOrganizationStoredInfoTypeName(
                       "[ORGANIZATION]", "[STORED_INFO_TYPE]")
                   .toString())
           .setConfig(StoredInfoTypeConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<StoredInfoType> future =
       dlpServiceClient.updateStoredInfoTypeCallable().futureCall(request);
   // Do something.
   StoredInfoType response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateStoredInfoTypeRequest,StoredInfoType>