Class DlpServiceGrpc.DlpServiceFutureStub (3.49.0)

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

A stub to allow clients to do ListenableFuture-style rpc calls to service DlpService.

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

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
Name Description
request ActivateJobTriggerRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DlpJob>

build(Channel channel, CallOptions callOptions)

protected DlpServiceGrpc.DlpServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
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/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Parameter
Name Description
request CancelDlpJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

createConnection(CreateConnectionRequest request)

public ListenableFuture<Connection> createConnection(CreateConnectionRequest request)

Create a Connection to an external data source.

Parameter
Name Description
request CreateConnectionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Connection>

createDeidentifyTemplate(CreateDeidentifyTemplateRequest request)

public ListenableFuture<DeidentifyTemplate> createDeidentifyTemplate(CreateDeidentifyTemplateRequest request)

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

Parameter
Name Description
request CreateDeidentifyTemplateRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DeidentifyTemplate>

createDiscoveryConfig(CreateDiscoveryConfigRequest request)

public ListenableFuture<DiscoveryConfig> createDiscoveryConfig(CreateDiscoveryConfigRequest request)

Creates a config for discovery to scan and profile storage.

Parameter
Name Description
request CreateDiscoveryConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DiscoveryConfig>

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

Parameter
Name Description
request CreateDlpJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DlpJob>

createInspectTemplate(CreateInspectTemplateRequest request)

public ListenableFuture<InspectTemplate> createInspectTemplate(CreateInspectTemplateRequest request)

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

Parameter
Name Description
request CreateInspectTemplateRequest
Returns
Type Description
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/sensitive-data-protection/docs/creating-job-triggers to learn more.

Parameter
Name Description
request CreateJobTriggerRequest
Returns
Type Description
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/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Parameter
Name Description
request CreateStoredInfoTypeRequest
Returns
Type Description
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/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.

Parameter
Name Description
request DeidentifyContentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DeidentifyContentResponse>

deleteConnection(DeleteConnectionRequest request)

public ListenableFuture<Empty> deleteConnection(DeleteConnectionRequest request)

Delete a Connection.

Parameter
Name Description
request DeleteConnectionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request)

public ListenableFuture<Empty> deleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request)
Parameter
Name Description
request DeleteDeidentifyTemplateRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDiscoveryConfig(DeleteDiscoveryConfigRequest request)

public ListenableFuture<Empty> deleteDiscoveryConfig(DeleteDiscoveryConfigRequest request)

Deletes a discovery configuration.

Parameter
Name Description
request DeleteDiscoveryConfigRequest
Returns
Type Description
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 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.

Parameter
Name Description
request DeleteDlpJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteInspectTemplate(DeleteInspectTemplateRequest request)

public ListenableFuture<Empty> deleteInspectTemplate(DeleteInspectTemplateRequest request)
Parameter
Name Description
request DeleteInspectTemplateRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteJobTrigger(DeleteJobTriggerRequest request)

public ListenableFuture<Empty> deleteJobTrigger(DeleteJobTriggerRequest request)
Parameter
Name Description
request DeleteJobTriggerRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteStoredInfoType(DeleteStoredInfoTypeRequest request)

public ListenableFuture<Empty> deleteStoredInfoType(DeleteStoredInfoTypeRequest request)
Parameter
Name Description
request DeleteStoredInfoTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteTableDataProfile(DeleteTableDataProfileRequest request)

public ListenableFuture<Empty> deleteTableDataProfile(DeleteTableDataProfileRequest request)

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

Parameter
Name Description
request DeleteTableDataProfileRequest
Returns
Type Description
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
Name Description
request FinishDlpJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getColumnDataProfile(GetColumnDataProfileRequest request)

public ListenableFuture<ColumnDataProfile> getColumnDataProfile(GetColumnDataProfileRequest request)

Gets a column data profile.

Parameter
Name Description
request GetColumnDataProfileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ColumnDataProfile>

getConnection(GetConnectionRequest request)

public ListenableFuture<Connection> getConnection(GetConnectionRequest request)

Get a Connection by name.

Parameter
Name Description
request GetConnectionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Connection>

getDeidentifyTemplate(GetDeidentifyTemplateRequest request)

public ListenableFuture<DeidentifyTemplate> getDeidentifyTemplate(GetDeidentifyTemplateRequest request)
Parameter
Name Description
request GetDeidentifyTemplateRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DeidentifyTemplate>

getDiscoveryConfig(GetDiscoveryConfigRequest request)

public ListenableFuture<DiscoveryConfig> getDiscoveryConfig(GetDiscoveryConfigRequest request)

Gets a discovery configuration.

Parameter
Name Description
request GetDiscoveryConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DiscoveryConfig>

getDlpJob(GetDlpJobRequest request)

public ListenableFuture<DlpJob> getDlpJob(GetDlpJobRequest request)
Parameter
Name Description
request GetDlpJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DlpJob>

getInspectTemplate(GetInspectTemplateRequest request)

public ListenableFuture<InspectTemplate> getInspectTemplate(GetInspectTemplateRequest request)
Parameter
Name Description
request GetInspectTemplateRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<InspectTemplate>

getJobTrigger(GetJobTriggerRequest request)

public ListenableFuture<JobTrigger> getJobTrigger(GetJobTriggerRequest request)
Parameter
Name Description
request GetJobTriggerRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<JobTrigger>

getProjectDataProfile(GetProjectDataProfileRequest request)

public ListenableFuture<ProjectDataProfile> getProjectDataProfile(GetProjectDataProfileRequest request)

Gets a project data profile.

Parameter
Name Description
request GetProjectDataProfileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ProjectDataProfile>

getStoredInfoType(GetStoredInfoTypeRequest request)

public ListenableFuture<StoredInfoType> getStoredInfoType(GetStoredInfoTypeRequest request)
Parameter
Name Description
request GetStoredInfoTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<StoredInfoType>

getTableDataProfile(GetTableDataProfileRequest request)

public ListenableFuture<TableDataProfile> getTableDataProfile(GetTableDataProfileRequest request)

Gets a table data profile.

Parameter
Name Description
request GetTableDataProfileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<TableDataProfile>

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
Name Description
request HybridInspectDlpJobRequest
Returns
Type Description
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
Name Description
request HybridInspectJobTriggerRequest
Returns
Type Description
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/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,

Parameter
Name Description
request InspectContentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<InspectContentResponse>

listColumnDataProfiles(ListColumnDataProfilesRequest request)

public ListenableFuture<ListColumnDataProfilesResponse> listColumnDataProfiles(ListColumnDataProfilesRequest request)

Lists column data profiles for an organization.

Parameter
Name Description
request ListColumnDataProfilesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListColumnDataProfilesResponse>

listConnections(ListConnectionsRequest request)

public ListenableFuture<ListConnectionsResponse> listConnections(ListConnectionsRequest request)

Lists Connections in a parent.

Parameter
Name Description
request ListConnectionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListConnectionsResponse>

listDeidentifyTemplates(ListDeidentifyTemplatesRequest request)

public ListenableFuture<ListDeidentifyTemplatesResponse> listDeidentifyTemplates(ListDeidentifyTemplatesRequest request)
Parameter
Name Description
request ListDeidentifyTemplatesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDeidentifyTemplatesResponse>

listDiscoveryConfigs(ListDiscoveryConfigsRequest request)

public ListenableFuture<ListDiscoveryConfigsResponse> listDiscoveryConfigs(ListDiscoveryConfigsRequest request)

Lists discovery configurations.

Parameter
Name Description
request ListDiscoveryConfigsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDiscoveryConfigsResponse>

listDlpJobs(ListDlpJobsRequest request)

public ListenableFuture<ListDlpJobsResponse> listDlpJobs(ListDlpJobsRequest request)
Parameter
Name Description
request ListDlpJobsRequest
Returns
Type Description
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 DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

Parameter
Name Description
request ListInfoTypesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListInfoTypesResponse>

listInspectTemplates(ListInspectTemplatesRequest request)

public ListenableFuture<ListInspectTemplatesResponse> listInspectTemplates(ListInspectTemplatesRequest request)
Parameter
Name Description
request ListInspectTemplatesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListInspectTemplatesResponse>

listJobTriggers(ListJobTriggersRequest request)

public ListenableFuture<ListJobTriggersResponse> listJobTriggers(ListJobTriggersRequest request)
Parameter
Name Description
request ListJobTriggersRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListJobTriggersResponse>

listProjectDataProfiles(ListProjectDataProfilesRequest request)

public ListenableFuture<ListProjectDataProfilesResponse> listProjectDataProfiles(ListProjectDataProfilesRequest request)

Lists project data profiles for an organization.

Parameter
Name Description
request ListProjectDataProfilesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListProjectDataProfilesResponse>

listStoredInfoTypes(ListStoredInfoTypesRequest request)

public ListenableFuture<ListStoredInfoTypesResponse> listStoredInfoTypes(ListStoredInfoTypesRequest request)
Parameter
Name Description
request ListStoredInfoTypesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListStoredInfoTypesResponse>

listTableDataProfiles(ListTableDataProfilesRequest request)

public ListenableFuture<ListTableDataProfilesResponse> listTableDataProfiles(ListTableDataProfilesRequest request)

Lists table data profiles for an organization.

Parameter
Name Description
request ListTableDataProfilesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListTableDataProfilesResponse>

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

Parameter
Name Description
request RedactImageRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<RedactImageResponse>

reidentifyContent(ReidentifyContentRequest request)

public ListenableFuture<ReidentifyContentResponse> reidentifyContent(ReidentifyContentRequest request)
Parameter
Name Description
request ReidentifyContentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ReidentifyContentResponse>

searchConnections(SearchConnectionsRequest request)

public ListenableFuture<SearchConnectionsResponse> searchConnections(SearchConnectionsRequest request)

Searches for Connections in a parent.

Parameter
Name Description
request SearchConnectionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchConnectionsResponse>

updateConnection(UpdateConnectionRequest request)

public ListenableFuture<Connection> updateConnection(UpdateConnectionRequest request)

Update a Connection.

Parameter
Name Description
request UpdateConnectionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Connection>

updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request)

public ListenableFuture<DeidentifyTemplate> updateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request)

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

Parameter
Name Description
request UpdateDeidentifyTemplateRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DeidentifyTemplate>

updateDiscoveryConfig(UpdateDiscoveryConfigRequest request)

public ListenableFuture<DiscoveryConfig> updateDiscoveryConfig(UpdateDiscoveryConfigRequest request)

Updates a discovery configuration.

Parameter
Name Description
request UpdateDiscoveryConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DiscoveryConfig>

updateInspectTemplate(UpdateInspectTemplateRequest request)

public ListenableFuture<InspectTemplate> updateInspectTemplate(UpdateInspectTemplateRequest request)

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

Parameter
Name Description
request UpdateInspectTemplateRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<InspectTemplate>

updateJobTrigger(UpdateJobTriggerRequest request)

public ListenableFuture<JobTrigger> updateJobTrigger(UpdateJobTriggerRequest request)
Parameter
Name Description
request UpdateJobTriggerRequest
Returns
Type Description
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/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Parameter
Name Description
request UpdateStoredInfoTypeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<StoredInfoType>