Class DlpServiceGrpc.DlpServiceFutureStub

public static final class DlpServiceGrpc.DlpServiceFutureStub extends AbstractFutureStub<DlpServiceGrpc.DlpServiceFutureStub>

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DlpServiceGrpc.DlpServiceFutureStub

Methods

activateJobTrigger(ActivateJobTriggerRequest request)

public ListenableFuture<DlpJob> activateJobTrigger(ActivateJobTriggerRequest request)

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

Parameter
NameDescription
requestActivateJobTriggerRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DlpJob>

build(Channel channel, CallOptions callOptions)

protected DlpServiceGrpc.DlpServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DlpServiceGrpc.DlpServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelDlpJob(CancelDlpJobRequest request)

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

Parameter
NameDescription
requestCancelDlpJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

createDeidentifyTemplate(CreateDeidentifyTemplateRequest request)

public ListenableFuture<DeidentifyTemplate> createDeidentifyTemplate(CreateDeidentifyTemplateRequest request)

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

Parameter
NameDescription
requestCreateDeidentifyTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DeidentifyTemplate>

createDlpJob(CreateDlpJobRequest request)

public ListenableFuture<DlpJob> createDlpJob(CreateDlpJobRequest request)

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.

Parameter
NameDescription
requestCreateDlpJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DlpJob>

createInspectTemplate(CreateInspectTemplateRequest request)

public ListenableFuture<InspectTemplate> createInspectTemplate(CreateInspectTemplateRequest request)

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

Parameter
NameDescription
requestCreateInspectTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<InspectTemplate>

createJobTrigger(CreateJobTriggerRequest request)

public ListenableFuture<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/dlp/docs/creating-job-triggers to learn more.

Parameter
NameDescription
requestCreateJobTriggerRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<JobTrigger>

createStoredInfoType(CreateStoredInfoTypeRequest request)

public ListenableFuture<StoredInfoType> createStoredInfoType(CreateStoredInfoTypeRequest request)

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

Parameter
NameDescription
requestCreateStoredInfoTypeRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<StoredInfoType>

deidentifyContent(DeidentifyContentRequest request)

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

Parameter
NameDescription
requestDeidentifyContentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DeidentifyContentResponse>

deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request)

public ListenableFuture<Empty> deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request)

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

Parameter
NameDescription
requestDeleteDeidentifyTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDlpJob(DeleteDlpJobRequest request)

public ListenableFuture<Empty> 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 cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Parameter
NameDescription
requestDeleteDlpJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteInspectTemplate(DeleteInspectTemplateRequest request)

public ListenableFuture<Empty> deleteInspectTemplate(DeleteInspectTemplateRequest request)

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

Parameter
NameDescription
requestDeleteInspectTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteJobTrigger(DeleteJobTriggerRequest request)

public ListenableFuture<Empty> deleteJobTrigger(DeleteJobTriggerRequest request)

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

Parameter
NameDescription
requestDeleteJobTriggerRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteStoredInfoType(DeleteStoredInfoTypeRequest request)

public ListenableFuture<Empty> deleteStoredInfoType(DeleteStoredInfoTypeRequest request)

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

Parameter
NameDescription
requestDeleteStoredInfoTypeRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

finishDlpJob(FinishDlpJobRequest request)

public ListenableFuture<Empty> finishDlpJob(FinishDlpJobRequest request)

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

Parameter
NameDescription
requestFinishDlpJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

getDeidentifyTemplate(GetDeidentifyTemplateRequest request)

public ListenableFuture<DeidentifyTemplate> getDeidentifyTemplate(GetDeidentifyTemplateRequest request)

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

Parameter
NameDescription
requestGetDeidentifyTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DeidentifyTemplate>

getDlpJob(GetDlpJobRequest request)

public ListenableFuture<DlpJob> getDlpJob(GetDlpJobRequest request)

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.

Parameter
NameDescription
requestGetDlpJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DlpJob>

getInspectTemplate(GetInspectTemplateRequest request)

public ListenableFuture<InspectTemplate> getInspectTemplate(GetInspectTemplateRequest request)

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

Parameter
NameDescription
requestGetInspectTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<InspectTemplate>

getJobTrigger(GetJobTriggerRequest request)

public ListenableFuture<JobTrigger> getJobTrigger(GetJobTriggerRequest request)

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

Parameter
NameDescription
requestGetJobTriggerRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<JobTrigger>

getStoredInfoType(GetStoredInfoTypeRequest request)

public ListenableFuture<StoredInfoType> getStoredInfoType(GetStoredInfoTypeRequest request)

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

Parameter
NameDescription
requestGetStoredInfoTypeRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<StoredInfoType>

hybridInspectDlpJob(HybridInspectDlpJobRequest request)

public ListenableFuture<HybridInspectResponse> hybridInspectDlpJob(HybridInspectDlpJobRequest request)

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

Parameter
NameDescription
requestHybridInspectDlpJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<HybridInspectResponse>

hybridInspectJobTrigger(HybridInspectJobTriggerRequest request)

public ListenableFuture<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.

Parameter
NameDescription
requestHybridInspectJobTriggerRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<HybridInspectResponse>

inspectContent(InspectContentRequest request)

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

Parameter
NameDescription
requestInspectContentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<InspectContentResponse>

listDeidentifyTemplates(ListDeidentifyTemplatesRequest request)

public ListenableFuture<ListDeidentifyTemplatesResponse> listDeidentifyTemplates(ListDeidentifyTemplatesRequest request)

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

Parameter
NameDescription
requestListDeidentifyTemplatesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDeidentifyTemplatesResponse>

listDlpJobs(ListDlpJobsRequest request)

public ListenableFuture<ListDlpJobsResponse> listDlpJobs(ListDlpJobsRequest request)

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.

Parameter
NameDescription
requestListDlpJobsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDlpJobsResponse>

listInfoTypes(ListInfoTypesRequest request)

public ListenableFuture<ListInfoTypesResponse> listInfoTypes(ListInfoTypesRequest request)

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

Parameter
NameDescription
requestListInfoTypesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListInfoTypesResponse>

listInspectTemplates(ListInspectTemplatesRequest request)

public ListenableFuture<ListInspectTemplatesResponse> listInspectTemplates(ListInspectTemplatesRequest request)

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

Parameter
NameDescription
requestListInspectTemplatesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListInspectTemplatesResponse>

listJobTriggers(ListJobTriggersRequest request)

public ListenableFuture<ListJobTriggersResponse> listJobTriggers(ListJobTriggersRequest request)

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

Parameter
NameDescription
requestListJobTriggersRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListJobTriggersResponse>

listStoredInfoTypes(ListStoredInfoTypesRequest request)

public ListenableFuture<ListStoredInfoTypesResponse> listStoredInfoTypes(ListStoredInfoTypesRequest request)

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

Parameter
NameDescription
requestListStoredInfoTypesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListStoredInfoTypesResponse>

redactImage(RedactImageRequest request)

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

Parameter
NameDescription
requestRedactImageRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<RedactImageResponse>

reidentifyContent(ReidentifyContentRequest request)

public ListenableFuture<ReidentifyContentResponse> reidentifyContent(ReidentifyContentRequest request)

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.

Parameter
NameDescription
requestReidentifyContentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ReidentifyContentResponse>

updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request)

public ListenableFuture<DeidentifyTemplate> updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request)

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

Parameter
NameDescription
requestUpdateDeidentifyTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DeidentifyTemplate>

updateInspectTemplate(UpdateInspectTemplateRequest request)

public ListenableFuture<InspectTemplate> updateInspectTemplate(UpdateInspectTemplateRequest request)

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

Parameter
NameDescription
requestUpdateInspectTemplateRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<InspectTemplate>

updateJobTrigger(UpdateJobTriggerRequest request)

public ListenableFuture<JobTrigger> updateJobTrigger(UpdateJobTriggerRequest request)

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

Parameter
NameDescription
requestUpdateJobTriggerRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<JobTrigger>

updateStoredInfoType(UpdateStoredInfoTypeRequest request)

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

Parameter
NameDescription
requestUpdateStoredInfoTypeRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<StoredInfoType>