com.google.cloud.dlp.v2beta1

Class DlpServiceClient

java.lang.Object

com.google.cloud.dlp.v2beta1.DlpServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class DlpServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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

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:

 
 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String type = "text/plain";
   String value = "My email is example @example.com.";
   ContentItem itemsElement = ContentItem.newBuilder()
     .setType(type)
     .setValue(value)
     .build();
   List<ContentItem> items = Arrays.asList(itemsElement);
   InspectContentResponse response = dlpServiceClient.inspectContent(inspectConfig, items);
 }
 
 

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().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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:

 
 DlpServiceSettings dlpServiceSettings =
     DlpServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DlpServiceClient dlpServiceClient =
     DlpServiceClient.create(dlpServiceSettings);
 
 

To customize the endpoint:

 
 DlpServiceSettings dlpServiceSettings =
     DlpServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DlpServiceClient dlpServiceClient =
     DlpServiceClient.create(dlpServiceSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DlpServiceClient(DlpServiceSettings settings) Constructs an instance of DlpServiceClient, using the given settings.
protected	DlpServiceClient(DlpServiceStub stub)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.longrunning.OperationFuture<com.google.privacy.dlp.v2beta1.RiskAnalysisOperationResult,com.google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata>	analyzeDataSourceRiskAsync(com.google.privacy.dlp.v2beta1.AnalyzeDataSourceRiskRequest request) Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.
com.google.api.gax.longrunning.OperationFuture<com.google.privacy.dlp.v2beta1.RiskAnalysisOperationResult,com.google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata>	analyzeDataSourceRiskAsync(com.google.privacy.dlp.v2beta1.PrivacyMetric privacyMetric, com.google.privacy.dlp.v2beta1.BigQueryTable sourceTable) Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.
com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.AnalyzeDataSourceRiskRequest,com.google.longrunning.Operation>	analyzeDataSourceRiskCallable() Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.
com.google.api.gax.rpc.OperationCallable<com.google.privacy.dlp.v2beta1.AnalyzeDataSourceRiskRequest,com.google.privacy.dlp.v2beta1.RiskAnalysisOperationResult,com.google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata>	analyzeDataSourceRiskOperationCallable() Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static DlpServiceClient	create() Constructs an instance of DlpServiceClient with default settings.
static DlpServiceClient	create(DlpServiceSettings settings) Constructs an instance of DlpServiceClient, using the given settings.
static DlpServiceClient	create(DlpServiceStub stub) Constructs an instance of DlpServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<com.google.privacy.dlp.v2beta1.InspectOperationResult,com.google.privacy.dlp.v2beta1.InspectOperationMetadata>	createInspectOperationAsync(com.google.privacy.dlp.v2beta1.CreateInspectOperationRequest request) Schedules a job scanning content in a Google Cloud Platform data repository.
com.google.api.gax.longrunning.OperationFuture<com.google.privacy.dlp.v2beta1.InspectOperationResult,com.google.privacy.dlp.v2beta1.InspectOperationMetadata>	createInspectOperationAsync(com.google.privacy.dlp.v2beta1.InspectConfig inspectConfig, com.google.privacy.dlp.v2beta1.StorageConfig storageConfig, com.google.privacy.dlp.v2beta1.OutputStorageConfig outputConfig) Schedules a job scanning content in a Google Cloud Platform data repository.
com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.CreateInspectOperationRequest,com.google.longrunning.Operation>	createInspectOperationCallable() Schedules a job scanning content in a Google Cloud Platform data repository.
com.google.api.gax.rpc.OperationCallable<com.google.privacy.dlp.v2beta1.CreateInspectOperationRequest,com.google.privacy.dlp.v2beta1.InspectOperationResult,com.google.privacy.dlp.v2beta1.InspectOperationMetadata>	createInspectOperationOperationCallable() Schedules a job scanning content in a Google Cloud Platform data repository.
com.google.privacy.dlp.v2beta1.DeidentifyContentResponse	deidentifyContent(com.google.privacy.dlp.v2beta1.DeidentifyConfig deidentifyConfig, com.google.privacy.dlp.v2beta1.InspectConfig inspectConfig, List<com.google.privacy.dlp.v2beta1.ContentItem> items) De-identifies potentially sensitive info from a list of strings.
com.google.privacy.dlp.v2beta1.DeidentifyContentResponse	deidentifyContent(com.google.privacy.dlp.v2beta1.DeidentifyContentRequest request) De-identifies potentially sensitive info from a list of strings.
com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.DeidentifyContentRequest,com.google.privacy.dlp.v2beta1.DeidentifyContentResponse>	deidentifyContentCallable() De-identifies potentially sensitive info from a list of strings.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
DlpServiceSettings	getSettings()
DlpServiceStub	getStub()
com.google.privacy.dlp.v2beta1.InspectContentResponse	inspectContent(com.google.privacy.dlp.v2beta1.InspectConfig inspectConfig, List<com.google.privacy.dlp.v2beta1.ContentItem> items) Finds potentially sensitive info in a list of strings.
com.google.privacy.dlp.v2beta1.InspectContentResponse	inspectContent(com.google.privacy.dlp.v2beta1.InspectContentRequest request) Finds potentially sensitive info in a list of strings.
com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.InspectContentRequest,com.google.privacy.dlp.v2beta1.InspectContentResponse>	inspectContentCallable() Finds potentially sensitive info in a list of strings.
boolean	isShutdown()
boolean	isTerminated()
com.google.privacy.dlp.v2beta1.ListInfoTypesResponse	listInfoTypes(com.google.privacy.dlp.v2beta1.ListInfoTypesRequest request) Returns sensitive information types for given category.
com.google.privacy.dlp.v2beta1.ListInfoTypesResponse	listInfoTypes(String category, String languageCode) Returns sensitive information types for given category.
com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.ListInfoTypesRequest,com.google.privacy.dlp.v2beta1.ListInfoTypesResponse>	listInfoTypesCallable() Returns sensitive information types for given category.
com.google.privacy.dlp.v2beta1.ListInspectFindingsResponse	listInspectFindings(com.google.privacy.dlp.v2beta1.ListInspectFindingsRequest request) Returns list of results for given inspect operation result set id.
com.google.privacy.dlp.v2beta1.ListInspectFindingsResponse	listInspectFindings(com.google.privacy.dlp.v2beta1.ResultName name) Returns list of results for given inspect operation result set id.
com.google.privacy.dlp.v2beta1.ListInspectFindingsResponse	listInspectFindings(String name) Returns list of results for given inspect operation result set id.
com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.ListInspectFindingsRequest,com.google.privacy.dlp.v2beta1.ListInspectFindingsResponse>	listInspectFindingsCallable() Returns list of results for given inspect operation result set id.
com.google.privacy.dlp.v2beta1.ListRootCategoriesResponse	listRootCategories(String languageCode) Returns the list of root categories of sensitive information.
com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.ListRootCategoriesRequest,com.google.privacy.dlp.v2beta1.ListRootCategoriesResponse>	listRootCategoriesCallable() Returns the list of root categories of sensitive information.
com.google.privacy.dlp.v2beta1.RedactContentResponse	redactContent(com.google.privacy.dlp.v2beta1.RedactContentRequest request) Redacts potentially sensitive info from a list of strings.
com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.RedactContentRequest,com.google.privacy.dlp.v2beta1.RedactContentResponse>	redactContentCallable() Redacts potentially sensitive info from a list of strings.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DlpServiceClient

protected DlpServiceClient(DlpServiceSettings settings)
                    throws IOException

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.

Throws:

IOException

DlpServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected DlpServiceClient(DlpServiceStub stub)

Method Detail

create

public static final DlpServiceClient create()
                                     throws IOException

Constructs an instance of DlpServiceClient with default settings.

Throws:

IOException

create

public static final DlpServiceClient create(DlpServiceSettings settings)
                                     throws IOException

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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use DlpServiceSettings}.

getSettings

public final DlpServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public DlpServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

inspectContent

public final com.google.privacy.dlp.v2beta1.InspectContentResponse inspectContent(com.google.privacy.dlp.v2beta1.InspectConfig inspectConfig,
                                                                                  List<com.google.privacy.dlp.v2beta1.ContentItem> items)

Finds potentially sensitive info in a list of strings. This method has limits on input size, processing time, and output size.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String type = "text/plain";
   String value = "My email is example @example.com.";
   ContentItem itemsElement = ContentItem.newBuilder()
     .setType(type)
     .setValue(value)
     .build();
   List<ContentItem> items = Arrays.asList(itemsElement);
   InspectContentResponse response = dlpServiceClient.inspectContent(inspectConfig, items);
 }
 

Parameters:

inspectConfig - Configuration for the inspector.

items - The list of items to inspect. Items in a single request are considered "related" unless inspect_config.independent_inputs is true. Up to 100 are allowed per request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

inspectContent

public final com.google.privacy.dlp.v2beta1.InspectContentResponse inspectContent(com.google.privacy.dlp.v2beta1.InspectContentRequest request)

Finds potentially sensitive info in a list of strings. This method has limits on input size, processing time, and output size.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String type = "text/plain";
   String value = "My email is example @example.com.";
   ContentItem itemsElement = ContentItem.newBuilder()
     .setType(type)
     .setValue(value)
     .build();
   List<ContentItem> items = Arrays.asList(itemsElement);
   InspectContentRequest request = InspectContentRequest.newBuilder()
     .setInspectConfig(inspectConfig)
     .addAllItems(items)
     .build();
   InspectContentResponse response = dlpServiceClient.inspectContent(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

inspectContentCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.InspectContentRequest,com.google.privacy.dlp.v2beta1.InspectContentResponse> inspectContentCallable()

Finds potentially sensitive info in a list of strings. This method has limits on input size, processing time, and output size.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String type = "text/plain";
   String value = "My email is example @example.com.";
   ContentItem itemsElement = ContentItem.newBuilder()
     .setType(type)
     .setValue(value)
     .build();
   List<ContentItem> items = Arrays.asList(itemsElement);
   InspectContentRequest request = InspectContentRequest.newBuilder()
     .setInspectConfig(inspectConfig)
     .addAllItems(items)
     .build();
   ApiFuture<InspectContentResponse> future = dlpServiceClient.inspectContentCallable().futureCall(request);
   // Do something
   InspectContentResponse response = future.get();
 }
 

redactContent

public final com.google.privacy.dlp.v2beta1.RedactContentResponse redactContent(com.google.privacy.dlp.v2beta1.RedactContentRequest request)

Redacts potentially sensitive info from a list of strings. This method has limits on input size, processing time, and output size.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String type = "text/plain";
   String value = "My email is example @example.com.";
   ContentItem itemsElement = ContentItem.newBuilder()
     .setType(type)
     .setValue(value)
     .build();
   List<ContentItem> items = Arrays.asList(itemsElement);
   String name2 = "EMAIL_ADDRESS";
   InfoType infoType = InfoType.newBuilder()
     .setName(name2)
     .build();
   String replaceWith = "REDACTED";
   RedactContentRequest.ReplaceConfig replaceConfigsElement = RedactContentRequest.ReplaceConfig.newBuilder()
     .setInfoType(infoType)
     .setReplaceWith(replaceWith)
     .build();
   List<RedactContentRequest.ReplaceConfig> replaceConfigs = Arrays.asList(replaceConfigsElement);
   RedactContentRequest request = RedactContentRequest.newBuilder()
     .setInspectConfig(inspectConfig)
     .addAllItems(items)
     .addAllReplaceConfigs(replaceConfigs)
     .build();
   RedactContentResponse response = dlpServiceClient.redactContent(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

redactContentCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.RedactContentRequest,com.google.privacy.dlp.v2beta1.RedactContentResponse> redactContentCallable()

Redacts potentially sensitive info from a list of strings. This method has limits on input size, processing time, and output size.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String type = "text/plain";
   String value = "My email is example @example.com.";
   ContentItem itemsElement = ContentItem.newBuilder()
     .setType(type)
     .setValue(value)
     .build();
   List<ContentItem> items = Arrays.asList(itemsElement);
   String name2 = "EMAIL_ADDRESS";
   InfoType infoType = InfoType.newBuilder()
     .setName(name2)
     .build();
   String replaceWith = "REDACTED";
   RedactContentRequest.ReplaceConfig replaceConfigsElement = RedactContentRequest.ReplaceConfig.newBuilder()
     .setInfoType(infoType)
     .setReplaceWith(replaceWith)
     .build();
   List<RedactContentRequest.ReplaceConfig> replaceConfigs = Arrays.asList(replaceConfigsElement);
   RedactContentRequest request = RedactContentRequest.newBuilder()
     .setInspectConfig(inspectConfig)
     .addAllItems(items)
     .addAllReplaceConfigs(replaceConfigs)
     .build();
   ApiFuture<RedactContentResponse> future = dlpServiceClient.redactContentCallable().futureCall(request);
   // Do something
   RedactContentResponse response = future.get();
 }
 

deidentifyContent

public final com.google.privacy.dlp.v2beta1.DeidentifyContentResponse deidentifyContent(com.google.privacy.dlp.v2beta1.DeidentifyConfig deidentifyConfig,
                                                                                        com.google.privacy.dlp.v2beta1.InspectConfig inspectConfig,
                                                                                        List<com.google.privacy.dlp.v2beta1.ContentItem> items)

De-identifies potentially sensitive info from a list of strings. This method has limits on input size and output size.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeidentifyConfig deidentifyConfig = DeidentifyConfig.newBuilder().build();
   InspectConfig inspectConfig = InspectConfig.newBuilder().build();
   List<ContentItem> items = new ArrayList<>();
   DeidentifyContentResponse response = dlpServiceClient.deidentifyContent(deidentifyConfig, inspectConfig, items);
 }
 

Parameters:

deidentifyConfig - Configuration for the de-identification of the list of content items.

inspectConfig - Configuration for the inspector.

items - The list of items to inspect. Up to 100 are allowed per request. All items will be treated as text/*.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deidentifyContent

public final com.google.privacy.dlp.v2beta1.DeidentifyContentResponse deidentifyContent(com.google.privacy.dlp.v2beta1.DeidentifyContentRequest request)

De-identifies potentially sensitive info from a list of strings. This method has limits on input size and output size.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeidentifyConfig deidentifyConfig = DeidentifyConfig.newBuilder().build();
   InspectConfig inspectConfig = InspectConfig.newBuilder().build();
   List<ContentItem> items = new ArrayList<>();
   DeidentifyContentRequest request = DeidentifyContentRequest.newBuilder()
     .setDeidentifyConfig(deidentifyConfig)
     .setInspectConfig(inspectConfig)
     .addAllItems(items)
     .build();
   DeidentifyContentResponse response = dlpServiceClient.deidentifyContent(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deidentifyContentCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.DeidentifyContentRequest,com.google.privacy.dlp.v2beta1.DeidentifyContentResponse> deidentifyContentCallable()

De-identifies potentially sensitive info from a list of strings. This method has limits on input size and output size.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   DeidentifyConfig deidentifyConfig = DeidentifyConfig.newBuilder().build();
   InspectConfig inspectConfig = InspectConfig.newBuilder().build();
   List<ContentItem> items = new ArrayList<>();
   DeidentifyContentRequest request = DeidentifyContentRequest.newBuilder()
     .setDeidentifyConfig(deidentifyConfig)
     .setInspectConfig(inspectConfig)
     .addAllItems(items)
     .build();
   ApiFuture<DeidentifyContentResponse> future = dlpServiceClient.deidentifyContentCallable().futureCall(request);
   // Do something
   DeidentifyContentResponse response = future.get();
 }
 

analyzeDataSourceRiskAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.privacy.dlp.v2beta1.RiskAnalysisOperationResult,com.google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata> analyzeDataSourceRiskAsync(com.google.privacy.dlp.v2beta1.PrivacyMetric privacyMetric,
                                                                                                                                                                                                                com.google.privacy.dlp.v2beta1.BigQueryTable sourceTable)

Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   PrivacyMetric privacyMetric = PrivacyMetric.newBuilder().build();
   BigQueryTable sourceTable = BigQueryTable.newBuilder().build();
   RiskAnalysisOperationResult response = dlpServiceClient.analyzeDataSourceRiskAsync(privacyMetric, sourceTable).get();
 }
 

Parameters:

privacyMetric - Privacy metric to compute.

sourceTable - Input dataset to compute metrics over.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeDataSourceRiskAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.privacy.dlp.v2beta1.RiskAnalysisOperationResult,com.google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata> analyzeDataSourceRiskAsync(com.google.privacy.dlp.v2beta1.AnalyzeDataSourceRiskRequest request)

Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   PrivacyMetric privacyMetric = PrivacyMetric.newBuilder().build();
   BigQueryTable sourceTable = BigQueryTable.newBuilder().build();
   AnalyzeDataSourceRiskRequest request = AnalyzeDataSourceRiskRequest.newBuilder()
     .setPrivacyMetric(privacyMetric)
     .setSourceTable(sourceTable)
     .build();
   RiskAnalysisOperationResult response = dlpServiceClient.analyzeDataSourceRiskAsync(request).get();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeDataSourceRiskOperationCallable

public final com.google.api.gax.rpc.OperationCallable<com.google.privacy.dlp.v2beta1.AnalyzeDataSourceRiskRequest,com.google.privacy.dlp.v2beta1.RiskAnalysisOperationResult,com.google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata> analyzeDataSourceRiskOperationCallable()

Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   PrivacyMetric privacyMetric = PrivacyMetric.newBuilder().build();
   BigQueryTable sourceTable = BigQueryTable.newBuilder().build();
   AnalyzeDataSourceRiskRequest request = AnalyzeDataSourceRiskRequest.newBuilder()
     .setPrivacyMetric(privacyMetric)
     .setSourceTable(sourceTable)
     .build();
   OperationFuture<Operation> future = dlpServiceClient.analyzeDataSourceRiskOperationCallable().futureCall(request);
   // Do something
   RiskAnalysisOperationResult response = future.get();
 }
 

analyzeDataSourceRiskCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.AnalyzeDataSourceRiskRequest,com.google.longrunning.Operation> analyzeDataSourceRiskCallable()

Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   PrivacyMetric privacyMetric = PrivacyMetric.newBuilder().build();
   BigQueryTable sourceTable = BigQueryTable.newBuilder().build();
   AnalyzeDataSourceRiskRequest request = AnalyzeDataSourceRiskRequest.newBuilder()
     .setPrivacyMetric(privacyMetric)
     .setSourceTable(sourceTable)
     .build();
   ApiFuture<Operation> future = dlpServiceClient.analyzeDataSourceRiskCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

createInspectOperationAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.privacy.dlp.v2beta1.InspectOperationResult,com.google.privacy.dlp.v2beta1.InspectOperationMetadata> createInspectOperationAsync(com.google.privacy.dlp.v2beta1.InspectConfig inspectConfig,
                                                                                                                                                                                                       com.google.privacy.dlp.v2beta1.StorageConfig storageConfig,
                                                                                                                                                                                                       com.google.privacy.dlp.v2beta1.OutputStorageConfig outputConfig)

Schedules a job scanning content in a Google Cloud Platform data repository.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String url = "gs://example_bucket/example_file.png";
   CloudStorageOptions.FileSet fileSet = CloudStorageOptions.FileSet.newBuilder()
     .setUrl(url)
     .build();
   CloudStorageOptions cloudStorageOptions = CloudStorageOptions.newBuilder()
     .setFileSet(fileSet)
     .build();
   StorageConfig storageConfig = StorageConfig.newBuilder()
     .setCloudStorageOptions(cloudStorageOptions)
     .build();
   OutputStorageConfig outputConfig = OutputStorageConfig.newBuilder().build();
   InspectOperationResult response = dlpServiceClient.createInspectOperationAsync(inspectConfig, storageConfig, outputConfig).get();
 }
 

Parameters:

inspectConfig - Configuration for the inspector.

storageConfig - Specification of the data set to process.

outputConfig - Optional location to store findings.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createInspectOperationAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.privacy.dlp.v2beta1.InspectOperationResult,com.google.privacy.dlp.v2beta1.InspectOperationMetadata> createInspectOperationAsync(com.google.privacy.dlp.v2beta1.CreateInspectOperationRequest request)

Schedules a job scanning content in a Google Cloud Platform data repository.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String url = "gs://example_bucket/example_file.png";
   CloudStorageOptions.FileSet fileSet = CloudStorageOptions.FileSet.newBuilder()
     .setUrl(url)
     .build();
   CloudStorageOptions cloudStorageOptions = CloudStorageOptions.newBuilder()
     .setFileSet(fileSet)
     .build();
   StorageConfig storageConfig = StorageConfig.newBuilder()
     .setCloudStorageOptions(cloudStorageOptions)
     .build();
   OutputStorageConfig outputConfig = OutputStorageConfig.newBuilder().build();
   CreateInspectOperationRequest request = CreateInspectOperationRequest.newBuilder()
     .setInspectConfig(inspectConfig)
     .setStorageConfig(storageConfig)
     .setOutputConfig(outputConfig)
     .build();
   InspectOperationResult response = dlpServiceClient.createInspectOperationAsync(request).get();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createInspectOperationOperationCallable

public final com.google.api.gax.rpc.OperationCallable<com.google.privacy.dlp.v2beta1.CreateInspectOperationRequest,com.google.privacy.dlp.v2beta1.InspectOperationResult,com.google.privacy.dlp.v2beta1.InspectOperationMetadata> createInspectOperationOperationCallable()

Schedules a job scanning content in a Google Cloud Platform data repository.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String url = "gs://example_bucket/example_file.png";
   CloudStorageOptions.FileSet fileSet = CloudStorageOptions.FileSet.newBuilder()
     .setUrl(url)
     .build();
   CloudStorageOptions cloudStorageOptions = CloudStorageOptions.newBuilder()
     .setFileSet(fileSet)
     .build();
   StorageConfig storageConfig = StorageConfig.newBuilder()
     .setCloudStorageOptions(cloudStorageOptions)
     .build();
   OutputStorageConfig outputConfig = OutputStorageConfig.newBuilder().build();
   CreateInspectOperationRequest request = CreateInspectOperationRequest.newBuilder()
     .setInspectConfig(inspectConfig)
     .setStorageConfig(storageConfig)
     .setOutputConfig(outputConfig)
     .build();
   OperationFuture<Operation> future = dlpServiceClient.createInspectOperationOperationCallable().futureCall(request);
   // Do something
   InspectOperationResult response = future.get();
 }
 

createInspectOperationCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.CreateInspectOperationRequest,com.google.longrunning.Operation> createInspectOperationCallable()

Schedules a job scanning content in a Google Cloud Platform data repository.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String name = "EMAIL_ADDRESS";
   InfoType infoTypesElement = InfoType.newBuilder()
     .setName(name)
     .build();
   List<InfoType> infoTypes = Arrays.asList(infoTypesElement);
   InspectConfig inspectConfig = InspectConfig.newBuilder()
     .addAllInfoTypes(infoTypes)
     .build();
   String url = "gs://example_bucket/example_file.png";
   CloudStorageOptions.FileSet fileSet = CloudStorageOptions.FileSet.newBuilder()
     .setUrl(url)
     .build();
   CloudStorageOptions cloudStorageOptions = CloudStorageOptions.newBuilder()
     .setFileSet(fileSet)
     .build();
   StorageConfig storageConfig = StorageConfig.newBuilder()
     .setCloudStorageOptions(cloudStorageOptions)
     .build();
   OutputStorageConfig outputConfig = OutputStorageConfig.newBuilder().build();
   CreateInspectOperationRequest request = CreateInspectOperationRequest.newBuilder()
     .setInspectConfig(inspectConfig)
     .setStorageConfig(storageConfig)
     .setOutputConfig(outputConfig)
     .build();
   ApiFuture<Operation> future = dlpServiceClient.createInspectOperationCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listInspectFindings

public final com.google.privacy.dlp.v2beta1.ListInspectFindingsResponse listInspectFindings(com.google.privacy.dlp.v2beta1.ResultName name)

Returns list of results for given inspect operation result set id.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ResultName name = ResultName.of("[RESULT]");
   ListInspectFindingsResponse response = dlpServiceClient.listInspectFindings(name);
 }
 

Parameters:

name - Identifier of the results set returned as metadata of the longrunning operation created by a call to InspectDataSource. Should be in the format of `inspect/results/{id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInspectFindings

public final com.google.privacy.dlp.v2beta1.ListInspectFindingsResponse listInspectFindings(String name)

Returns list of results for given inspect operation result set id.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ResultName name = ResultName.of("[RESULT]");
   ListInspectFindingsResponse response = dlpServiceClient.listInspectFindings(name.toString());
 }
 

Parameters:

name - Identifier of the results set returned as metadata of the longrunning operation created by a call to InspectDataSource. Should be in the format of `inspect/results/{id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInspectFindings

public final com.google.privacy.dlp.v2beta1.ListInspectFindingsResponse listInspectFindings(com.google.privacy.dlp.v2beta1.ListInspectFindingsRequest request)

Returns list of results for given inspect operation result set id.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ResultName name = ResultName.of("[RESULT]");
   ListInspectFindingsRequest request = ListInspectFindingsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ListInspectFindingsResponse response = dlpServiceClient.listInspectFindings(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInspectFindingsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.ListInspectFindingsRequest,com.google.privacy.dlp.v2beta1.ListInspectFindingsResponse> listInspectFindingsCallable()

Returns list of results for given inspect operation result set id.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   ResultName name = ResultName.of("[RESULT]");
   ListInspectFindingsRequest request = ListInspectFindingsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListInspectFindingsResponse> future = dlpServiceClient.listInspectFindingsCallable().futureCall(request);
   // Do something
   ListInspectFindingsResponse response = future.get();
 }
 

listInfoTypes

public final com.google.privacy.dlp.v2beta1.ListInfoTypesResponse listInfoTypes(String category,
                                                                                String languageCode)

Returns sensitive information types for given category.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String category = "PII";
   String languageCode = "en";
   ListInfoTypesResponse response = dlpServiceClient.listInfoTypes(category, languageCode);
 }
 

Parameters:

category - Category name as returned by ListRootCategories.

languageCode - Optional BCP-47 language code for localized info type friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInfoTypes

public final com.google.privacy.dlp.v2beta1.ListInfoTypesResponse listInfoTypes(com.google.privacy.dlp.v2beta1.ListInfoTypesRequest request)

Returns sensitive information types for given category.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String category = "PII";
   String languageCode = "en";
   ListInfoTypesRequest request = ListInfoTypesRequest.newBuilder()
     .setCategory(category)
     .setLanguageCode(languageCode)
     .build();
   ListInfoTypesResponse response = dlpServiceClient.listInfoTypes(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInfoTypesCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.ListInfoTypesRequest,com.google.privacy.dlp.v2beta1.ListInfoTypesResponse> listInfoTypesCallable()

Returns sensitive information types for given category.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String category = "PII";
   String languageCode = "en";
   ListInfoTypesRequest request = ListInfoTypesRequest.newBuilder()
     .setCategory(category)
     .setLanguageCode(languageCode)
     .build();
   ApiFuture<ListInfoTypesResponse> future = dlpServiceClient.listInfoTypesCallable().futureCall(request);
   // Do something
   ListInfoTypesResponse response = future.get();
 }
 

listRootCategories

public final com.google.privacy.dlp.v2beta1.ListRootCategoriesResponse listRootCategories(String languageCode)

Returns the list of root categories of sensitive information.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String languageCode = "en";
   ListRootCategoriesResponse response = dlpServiceClient.listRootCategories(languageCode);
 }
 

Parameters:

languageCode - Optional language code for localized friendly category names. If omitted or if localized strings are not available, en-US strings will be returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listRootCategoriesCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.privacy.dlp.v2beta1.ListRootCategoriesRequest,com.google.privacy.dlp.v2beta1.ListRootCategoriesResponse> listRootCategoriesCallable()

Returns the list of root categories of sensitive information.

Sample code:

 try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) {
   String languageCode = "en";
   ListRootCategoriesRequest request = ListRootCategoriesRequest.newBuilder()
     .setLanguageCode(languageCode)
     .build();
   ApiFuture<ListRootCategoriesResponse> future = dlpServiceClient.listRootCategoriesCallable().futureCall(request);
   // Do something
   ListRootCategoriesResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException