Interface DlpServiceGrpc.AsyncService (3.33.0)

Version 3.33.0

• 3.57.0 (latest)
• 3.56.0
• 3.55.0
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.6
• 3.6.7
• 3.5.0
• 3.4.0
• 3.3.2
• 3.2.1
• 3.1.4

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

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

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/dlp/docs/creating-templates-deid to learn more.

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

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/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

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/dlp/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/dlp/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/dlp/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/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

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

deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name	Description
request	DeleteDeidentifyTemplateRequest
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/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/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)

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

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)

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

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)

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

Parameters
Name	Description
request	DeleteStoredInfoTypeRequest
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>

getDeidentifyTemplate(GetDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)

public default void getDeidentifyTemplate(GetDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)

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

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

getDlpJob(GetDlpJobRequest request, StreamObserver<DlpJob> responseObserver)

public default void getDlpJob(GetDlpJobRequest request, StreamObserver<DlpJob> responseObserver)

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

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)

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

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)

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

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

getStoredInfoType(GetStoredInfoTypeRequest request, StreamObserver<StoredInfoType> responseObserver)

public default void getStoredInfoType(GetStoredInfoTypeRequest request, StreamObserver<StoredInfoType> responseObserver)

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

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

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

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

listDeidentifyTemplates(ListDeidentifyTemplatesRequest request, StreamObserver<ListDeidentifyTemplatesResponse> responseObserver)

public default void listDeidentifyTemplates(ListDeidentifyTemplatesRequest request, StreamObserver<ListDeidentifyTemplatesResponse> responseObserver)

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

Parameters
Name	Description
request	ListDeidentifyTemplatesRequest
responseObserver	io.grpc.stub.StreamObserver<ListDeidentifyTemplatesResponse>

listDlpJobs(ListDlpJobsRequest request, StreamObserver<ListDlpJobsResponse> responseObserver)

public default void listDlpJobs(ListDlpJobsRequest request, StreamObserver<ListDlpJobsResponse> responseObserver)

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

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/dlp/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)

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

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)

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

Parameters
Name	Description
request	ListJobTriggersRequest
responseObserver	io.grpc.stub.StreamObserver<ListJobTriggersResponse>

listStoredInfoTypes(ListStoredInfoTypesRequest request, StreamObserver<ListStoredInfoTypesResponse> responseObserver)

public default void listStoredInfoTypes(ListStoredInfoTypesRequest request, StreamObserver<ListStoredInfoTypesResponse> responseObserver)

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

Parameters
Name	Description
request	ListStoredInfoTypesRequest
responseObserver	io.grpc.stub.StreamObserver<ListStoredInfoTypesResponse>

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/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

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)

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

Parameters
Name	Description
request	ReidentifyContentRequest
responseObserver	io.grpc.stub.StreamObserver<ReidentifyContentResponse>

updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request, StreamObserver<DeidentifyTemplate> responseObserver)

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

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

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

updateInspectTemplate(UpdateInspectTemplateRequest request, StreamObserver<InspectTemplate> responseObserver)

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

Updates the InspectTemplate. See https://cloud.google.com/dlp/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)

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

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

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