Interface DlpServiceGrpc.AsyncService (3.49.0)

public static interface DlpServiceGrpc.AsyncService

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/.

Methods

activateJobTrigger(ActivateJobTriggerRequest request, StreamObserver<DlpJob> responseObserver)

public default void activateJobTrigger(ActivateJobTriggerRequest request, StreamObserver<DlpJob> responseObserver)

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

Parameters
Name Description
request ActivateJobTriggerRequest
responseObserver io.grpc.stub.StreamObserver<DlpJob>

cancelDlpJob(CancelDlpJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelDlpJob(CancelDlpJobRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name Description
request CancelDlpJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

createConnection(CreateConnectionRequest request, StreamObserver<Connection> responseObserver)

public default void createConnection(CreateConnectionRequest request, StreamObserver<Connection> responseObserver)

Create a Connection to an external data source.

Parameters
Name Description
request CreateConnectionRequest
responseObserver io.grpc.stub.StreamObserver<Connection>

createDeidentifyTemplate(CreateDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)

public default void createDeidentifyTemplate(CreateDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)

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.

Parameters
Name Description
request CreateDeidentifyTemplateRequest
responseObserver io.grpc.stub.StreamObserver<DeidentifyTemplate>

createDiscoveryConfig(CreateDiscoveryConfigRequest request, StreamObserver<DiscoveryConfig> responseObserver)

public default void createDiscoveryConfig(CreateDiscoveryConfigRequest request, StreamObserver<DiscoveryConfig> responseObserver)

Creates a config for discovery to scan and profile storage.

Parameters
Name Description
request CreateDiscoveryConfigRequest
responseObserver io.grpc.stub.StreamObserver<DiscoveryConfig>

createDlpJob(CreateDlpJobRequest request, StreamObserver<DlpJob> responseObserver)

public default void createDlpJob(CreateDlpJobRequest request, StreamObserver<DlpJob> responseObserver)

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.

Parameters
Name Description
request CreateDlpJobRequest
responseObserver io.grpc.stub.StreamObserver<DlpJob>

createInspectTemplate(CreateInspectTemplateRequest request, StreamObserver<InspectTemplate> responseObserver)

public default void createInspectTemplate(CreateInspectTemplateRequest request, StreamObserver<InspectTemplate> responseObserver)

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.

Parameters
Name Description
request CreateInspectTemplateRequest
responseObserver io.grpc.stub.StreamObserver<InspectTemplate>

createJobTrigger(CreateJobTriggerRequest request, StreamObserver<JobTrigger> responseObserver)

public default void createJobTrigger(CreateJobTriggerRequest request, StreamObserver<JobTrigger> responseObserver)

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.

Parameters
Name Description
request CreateJobTriggerRequest
responseObserver io.grpc.stub.StreamObserver<JobTrigger>

createStoredInfoType(CreateStoredInfoTypeRequest request, StreamObserver<StoredInfoType> responseObserver)

public default void createStoredInfoType(CreateStoredInfoTypeRequest request, StreamObserver<StoredInfoType> responseObserver)

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.

Parameters
Name Description
request CreateStoredInfoTypeRequest
responseObserver io.grpc.stub.StreamObserver<StoredInfoType>

deidentifyContent(DeidentifyContentRequest request, StreamObserver<DeidentifyContentResponse> responseObserver)

public default void deidentifyContent(DeidentifyContentRequest request, StreamObserver<DeidentifyContentResponse> responseObserver)

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.

Parameters
Name Description
request DeidentifyContentRequest
responseObserver io.grpc.stub.StreamObserver<DeidentifyContentResponse>

deleteConnection(DeleteConnectionRequest request, StreamObserver<Empty> responseObserver)

public default void deleteConnection(DeleteConnectionRequest request, StreamObserver<Empty> responseObserver)

Delete a Connection.

Parameters
Name Description
request DeleteConnectionRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request, StreamObserver<Empty> responseObserver)
Parameters
Name Description
request DeleteDeidentifyTemplateRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteDiscoveryConfig(DeleteDiscoveryConfigRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDiscoveryConfig(DeleteDiscoveryConfigRequest request, StreamObserver<Empty> responseObserver)

Deletes a discovery configuration.

Parameters
Name Description
request DeleteDiscoveryConfigRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteDlpJob(DeleteDlpJobRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDlpJob(DeleteDlpJobRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name Description
request DeleteDlpJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteInspectTemplate(DeleteInspectTemplateRequest request, StreamObserver<Empty> responseObserver)

public default void deleteInspectTemplate(DeleteInspectTemplateRequest request, StreamObserver<Empty> responseObserver)
Parameters
Name Description
request DeleteInspectTemplateRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteJobTrigger(DeleteJobTriggerRequest request, StreamObserver<Empty> responseObserver)

public default void deleteJobTrigger(DeleteJobTriggerRequest request, StreamObserver<Empty> responseObserver)
Parameters
Name Description
request DeleteJobTriggerRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteStoredInfoType(DeleteStoredInfoTypeRequest request, StreamObserver<Empty> responseObserver)

public default void deleteStoredInfoType(DeleteStoredInfoTypeRequest request, StreamObserver<Empty> responseObserver)
Parameters
Name Description
request DeleteStoredInfoTypeRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteTableDataProfile(DeleteTableDataProfileRequest request, StreamObserver<Empty> responseObserver)

public default void deleteTableDataProfile(DeleteTableDataProfileRequest request, StreamObserver<Empty> responseObserver)

Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.

Parameters
Name Description
request DeleteTableDataProfileRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

finishDlpJob(FinishDlpJobRequest request, StreamObserver<Empty> responseObserver)

public default void finishDlpJob(FinishDlpJobRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name Description
request FinishDlpJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getColumnDataProfile(GetColumnDataProfileRequest request, StreamObserver<ColumnDataProfile> responseObserver)

public default void getColumnDataProfile(GetColumnDataProfileRequest request, StreamObserver<ColumnDataProfile> responseObserver)

Gets a column data profile.

Parameters
Name Description
request GetColumnDataProfileRequest
responseObserver io.grpc.stub.StreamObserver<ColumnDataProfile>

getConnection(GetConnectionRequest request, StreamObserver<Connection> responseObserver)

public default void getConnection(GetConnectionRequest request, StreamObserver<Connection> responseObserver)

Get a Connection by name.

Parameters
Name Description
request GetConnectionRequest
responseObserver io.grpc.stub.StreamObserver<Connection>

getDeidentifyTemplate(GetDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)

public default void getDeidentifyTemplate(GetDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)
Parameters
Name Description
request GetDeidentifyTemplateRequest
responseObserver io.grpc.stub.StreamObserver<DeidentifyTemplate>

getDiscoveryConfig(GetDiscoveryConfigRequest request, StreamObserver<DiscoveryConfig> responseObserver)

public default void getDiscoveryConfig(GetDiscoveryConfigRequest request, StreamObserver<DiscoveryConfig> responseObserver)

Gets a discovery configuration.

Parameters
Name Description
request GetDiscoveryConfigRequest
responseObserver io.grpc.stub.StreamObserver<DiscoveryConfig>

getDlpJob(GetDlpJobRequest request, StreamObserver<DlpJob> responseObserver)

public default void getDlpJob(GetDlpJobRequest request, StreamObserver<DlpJob> responseObserver)
Parameters
Name Description
request GetDlpJobRequest
responseObserver io.grpc.stub.StreamObserver<DlpJob>

getInspectTemplate(GetInspectTemplateRequest request, StreamObserver<InspectTemplate> responseObserver)

public default void getInspectTemplate(GetInspectTemplateRequest request, StreamObserver<InspectTemplate> responseObserver)
Parameters
Name Description
request GetInspectTemplateRequest
responseObserver io.grpc.stub.StreamObserver<InspectTemplate>

getJobTrigger(GetJobTriggerRequest request, StreamObserver<JobTrigger> responseObserver)

public default void getJobTrigger(GetJobTriggerRequest request, StreamObserver<JobTrigger> responseObserver)
Parameters
Name Description
request GetJobTriggerRequest
responseObserver io.grpc.stub.StreamObserver<JobTrigger>

getProjectDataProfile(GetProjectDataProfileRequest request, StreamObserver<ProjectDataProfile> responseObserver)

public default void getProjectDataProfile(GetProjectDataProfileRequest request, StreamObserver<ProjectDataProfile> responseObserver)

Gets a project data profile.

Parameters
Name Description
request GetProjectDataProfileRequest
responseObserver io.grpc.stub.StreamObserver<ProjectDataProfile>

getStoredInfoType(GetStoredInfoTypeRequest request, StreamObserver<StoredInfoType> responseObserver)

public default void getStoredInfoType(GetStoredInfoTypeRequest request, StreamObserver<StoredInfoType> responseObserver)
Parameters
Name Description
request GetStoredInfoTypeRequest
responseObserver io.grpc.stub.StreamObserver<StoredInfoType>

getTableDataProfile(GetTableDataProfileRequest request, StreamObserver<TableDataProfile> responseObserver)

public default void getTableDataProfile(GetTableDataProfileRequest request, StreamObserver<TableDataProfile> responseObserver)

Gets a table data profile.

Parameters
Name Description
request GetTableDataProfileRequest
responseObserver io.grpc.stub.StreamObserver<TableDataProfile>

hybridInspectDlpJob(HybridInspectDlpJobRequest request, StreamObserver<HybridInspectResponse> responseObserver)

public default void hybridInspectDlpJob(HybridInspectDlpJobRequest request, StreamObserver<HybridInspectResponse> responseObserver)

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

Parameters
Name Description
request HybridInspectDlpJobRequest
responseObserver io.grpc.stub.StreamObserver<HybridInspectResponse>

hybridInspectJobTrigger(HybridInspectJobTriggerRequest request, StreamObserver<HybridInspectResponse> responseObserver)

public default void hybridInspectJobTrigger(HybridInspectJobTriggerRequest request, StreamObserver<HybridInspectResponse> responseObserver)

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.

Parameters
Name Description
request HybridInspectJobTriggerRequest
responseObserver io.grpc.stub.StreamObserver<HybridInspectResponse>

inspectContent(InspectContentRequest request, StreamObserver<InspectContentResponse> responseObserver)

public default void inspectContent(InspectContentRequest request, StreamObserver<InspectContentResponse> responseObserver)

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,

Parameters
Name Description
request InspectContentRequest
responseObserver io.grpc.stub.StreamObserver<InspectContentResponse>

listColumnDataProfiles(ListColumnDataProfilesRequest request, StreamObserver<ListColumnDataProfilesResponse> responseObserver)

public default void listColumnDataProfiles(ListColumnDataProfilesRequest request, StreamObserver<ListColumnDataProfilesResponse> responseObserver)

Lists column data profiles for an organization.

Parameters
Name Description
request ListColumnDataProfilesRequest
responseObserver io.grpc.stub.StreamObserver<ListColumnDataProfilesResponse>

listConnections(ListConnectionsRequest request, StreamObserver<ListConnectionsResponse> responseObserver)

public default void listConnections(ListConnectionsRequest request, StreamObserver<ListConnectionsResponse> responseObserver)

Lists Connections in a parent.

Parameters
Name Description
request ListConnectionsRequest
responseObserver io.grpc.stub.StreamObserver<ListConnectionsResponse>

listDeidentifyTemplates(ListDeidentifyTemplatesRequest request, StreamObserver<ListDeidentifyTemplatesResponse> responseObserver)

public default void listDeidentifyTemplates(ListDeidentifyTemplatesRequest request, StreamObserver<ListDeidentifyTemplatesResponse> responseObserver)
Parameters
Name Description
request ListDeidentifyTemplatesRequest
responseObserver io.grpc.stub.StreamObserver<ListDeidentifyTemplatesResponse>

listDiscoveryConfigs(ListDiscoveryConfigsRequest request, StreamObserver<ListDiscoveryConfigsResponse> responseObserver)

public default void listDiscoveryConfigs(ListDiscoveryConfigsRequest request, StreamObserver<ListDiscoveryConfigsResponse> responseObserver)

Lists discovery configurations.

Parameters
Name Description
request ListDiscoveryConfigsRequest
responseObserver io.grpc.stub.StreamObserver<ListDiscoveryConfigsResponse>

listDlpJobs(ListDlpJobsRequest request, StreamObserver<ListDlpJobsResponse> responseObserver)

public default void listDlpJobs(ListDlpJobsRequest request, StreamObserver<ListDlpJobsResponse> responseObserver)
Parameters
Name Description
request ListDlpJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListDlpJobsResponse>

listInfoTypes(ListInfoTypesRequest request, StreamObserver<ListInfoTypesResponse> responseObserver)

public default void listInfoTypes(ListInfoTypesRequest request, StreamObserver<ListInfoTypesResponse> responseObserver)

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.

Parameters
Name Description
request ListInfoTypesRequest
responseObserver io.grpc.stub.StreamObserver<ListInfoTypesResponse>

listInspectTemplates(ListInspectTemplatesRequest request, StreamObserver<ListInspectTemplatesResponse> responseObserver)

public default void listInspectTemplates(ListInspectTemplatesRequest request, StreamObserver<ListInspectTemplatesResponse> responseObserver)
Parameters
Name Description
request ListInspectTemplatesRequest
responseObserver io.grpc.stub.StreamObserver<ListInspectTemplatesResponse>

listJobTriggers(ListJobTriggersRequest request, StreamObserver<ListJobTriggersResponse> responseObserver)

public default void listJobTriggers(ListJobTriggersRequest request, StreamObserver<ListJobTriggersResponse> responseObserver)
Parameters
Name Description
request ListJobTriggersRequest
responseObserver io.grpc.stub.StreamObserver<ListJobTriggersResponse>

listProjectDataProfiles(ListProjectDataProfilesRequest request, StreamObserver<ListProjectDataProfilesResponse> responseObserver)

public default void listProjectDataProfiles(ListProjectDataProfilesRequest request, StreamObserver<ListProjectDataProfilesResponse> responseObserver)

Lists project data profiles for an organization.

Parameters
Name Description
request ListProjectDataProfilesRequest
responseObserver io.grpc.stub.StreamObserver<ListProjectDataProfilesResponse>

listStoredInfoTypes(ListStoredInfoTypesRequest request, StreamObserver<ListStoredInfoTypesResponse> responseObserver)

public default void listStoredInfoTypes(ListStoredInfoTypesRequest request, StreamObserver<ListStoredInfoTypesResponse> responseObserver)
Parameters
Name Description
request ListStoredInfoTypesRequest
responseObserver io.grpc.stub.StreamObserver<ListStoredInfoTypesResponse>

listTableDataProfiles(ListTableDataProfilesRequest request, StreamObserver<ListTableDataProfilesResponse> responseObserver)

public default void listTableDataProfiles(ListTableDataProfilesRequest request, StreamObserver<ListTableDataProfilesResponse> responseObserver)

Lists table data profiles for an organization.

Parameters
Name Description
request ListTableDataProfilesRequest
responseObserver io.grpc.stub.StreamObserver<ListTableDataProfilesResponse>

redactImage(RedactImageRequest request, StreamObserver<RedactImageResponse> responseObserver)

public default void redactImage(RedactImageRequest request, StreamObserver<RedactImageResponse> responseObserver)

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.

Parameters
Name Description
request RedactImageRequest
responseObserver io.grpc.stub.StreamObserver<RedactImageResponse>

reidentifyContent(ReidentifyContentRequest request, StreamObserver<ReidentifyContentResponse> responseObserver)

public default void reidentifyContent(ReidentifyContentRequest request, StreamObserver<ReidentifyContentResponse> responseObserver)
Parameters
Name Description
request ReidentifyContentRequest
responseObserver io.grpc.stub.StreamObserver<ReidentifyContentResponse>

searchConnections(SearchConnectionsRequest request, StreamObserver<SearchConnectionsResponse> responseObserver)

public default void searchConnections(SearchConnectionsRequest request, StreamObserver<SearchConnectionsResponse> responseObserver)

Searches for Connections in a parent.

Parameters
Name Description
request SearchConnectionsRequest
responseObserver io.grpc.stub.StreamObserver<SearchConnectionsResponse>

updateConnection(UpdateConnectionRequest request, StreamObserver<Connection> responseObserver)

public default void updateConnection(UpdateConnectionRequest request, StreamObserver<Connection> responseObserver)

Update a Connection.

Parameters
Name Description
request UpdateConnectionRequest
responseObserver io.grpc.stub.StreamObserver<Connection>

updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)

public default void updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)

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

Parameters
Name Description
request UpdateDeidentifyTemplateRequest
responseObserver io.grpc.stub.StreamObserver<DeidentifyTemplate>

updateDiscoveryConfig(UpdateDiscoveryConfigRequest request, StreamObserver<DiscoveryConfig> responseObserver)

public default void updateDiscoveryConfig(UpdateDiscoveryConfigRequest request, StreamObserver<DiscoveryConfig> responseObserver)

Updates a discovery configuration.

Parameters
Name Description
request UpdateDiscoveryConfigRequest
responseObserver io.grpc.stub.StreamObserver<DiscoveryConfig>

updateInspectTemplate(UpdateInspectTemplateRequest request, StreamObserver<InspectTemplate> responseObserver)

public default void updateInspectTemplate(UpdateInspectTemplateRequest request, StreamObserver<InspectTemplate> responseObserver)

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

Parameters
Name Description
request UpdateInspectTemplateRequest
responseObserver io.grpc.stub.StreamObserver<InspectTemplate>

updateJobTrigger(UpdateJobTriggerRequest request, StreamObserver<JobTrigger> responseObserver)

public default void updateJobTrigger(UpdateJobTriggerRequest request, StreamObserver<JobTrigger> responseObserver)
Parameters
Name Description
request UpdateJobTriggerRequest
responseObserver io.grpc.stub.StreamObserver<JobTrigger>

updateStoredInfoType(UpdateStoredInfoTypeRequest request, StreamObserver<StoredInfoType> responseObserver)

public default void updateStoredInfoType(UpdateStoredInfoTypeRequest request, StreamObserver<StoredInfoType> responseObserver)

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.

Parameters
Name Description
request UpdateStoredInfoTypeRequest
responseObserver io.grpc.stub.StreamObserver<StoredInfoType>