Google Cloud Data Loss Prevention v2 API - Class DlpService.DlpServiceBase (4.2.0)

[BindServiceMethod(typeof(DlpService), "BindService")]
public abstract class DlpServiceBase

Reference documentation and code samples for the Google Cloud Data Loss Prevention v2 API class DlpService.DlpServiceBase.

Base class for server-side implementations of DlpService

Inheritance

Object > DlpService.DlpServiceBase

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Methods

ActivateJobTrigger(ActivateJobTriggerRequest, ServerCallContext)

public virtual Task<DlpJob> ActivateJobTrigger(ActivateJobTriggerRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DlpJob>	The response to send back to the client (wrapped by a task).

CancelDlpJob(CancelDlpJobRequest, ServerCallContext)

public virtual Task<Empty> CancelDlpJob(CancelDlpJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

CreateDeidentifyTemplate(CreateDeidentifyTemplateRequest, ServerCallContext)

public virtual Task<DeidentifyTemplate> CreateDeidentifyTemplate(CreateDeidentifyTemplateRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DeidentifyTemplate>	The response to send back to the client (wrapped by a task).

CreateDlpJob(CreateDlpJobRequest, ServerCallContext)

public virtual Task<DlpJob> CreateDlpJob(CreateDlpJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DlpJob>	The response to send back to the client (wrapped by a task).

CreateInspectTemplate(CreateInspectTemplateRequest, ServerCallContext)

public virtual Task<InspectTemplate> CreateInspectTemplate(CreateInspectTemplateRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<InspectTemplate>	The response to send back to the client (wrapped by a task).

CreateJobTrigger(CreateJobTriggerRequest, ServerCallContext)

public virtual Task<JobTrigger> CreateJobTrigger(CreateJobTriggerRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<JobTrigger>	The response to send back to the client (wrapped by a task).

CreateStoredInfoType(CreateStoredInfoTypeRequest, ServerCallContext)

public virtual Task<StoredInfoType> CreateStoredInfoType(CreateStoredInfoTypeRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<StoredInfoType>	The response to send back to the client (wrapped by a task).

DeidentifyContent(DeidentifyContentRequest, ServerCallContext)

public virtual Task<DeidentifyContentResponse> DeidentifyContent(DeidentifyContentRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DeidentifyContentResponse>	The response to send back to the client (wrapped by a task).

DeleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest, ServerCallContext)

public virtual Task<Empty> DeleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	DeleteDeidentifyTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

DeleteDlpJob(DeleteDlpJobRequest, ServerCallContext)

public virtual Task<Empty> DeleteDlpJob(DeleteDlpJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

DeleteInspectTemplate(DeleteInspectTemplateRequest, ServerCallContext)

public virtual Task<Empty> DeleteInspectTemplate(DeleteInspectTemplateRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	DeleteInspectTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

DeleteJobTrigger(DeleteJobTriggerRequest, ServerCallContext)

public virtual Task<Empty> DeleteJobTrigger(DeleteJobTriggerRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	DeleteJobTriggerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

DeleteStoredInfoType(DeleteStoredInfoTypeRequest, ServerCallContext)

public virtual Task<Empty> DeleteStoredInfoType(DeleteStoredInfoTypeRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	DeleteStoredInfoTypeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

FinishDlpJob(FinishDlpJobRequest, ServerCallContext)

public virtual Task<Empty> FinishDlpJob(FinishDlpJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

GetDeidentifyTemplate(GetDeidentifyTemplateRequest, ServerCallContext)

public virtual Task<DeidentifyTemplate> GetDeidentifyTemplate(GetDeidentifyTemplateRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	GetDeidentifyTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DeidentifyTemplate>	The response to send back to the client (wrapped by a task).

GetDlpJob(GetDlpJobRequest, ServerCallContext)

public virtual Task<DlpJob> GetDlpJob(GetDlpJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DlpJob>	The response to send back to the client (wrapped by a task).

GetInspectTemplate(GetInspectTemplateRequest, ServerCallContext)

public virtual Task<InspectTemplate> GetInspectTemplate(GetInspectTemplateRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	GetInspectTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<InspectTemplate>	The response to send back to the client (wrapped by a task).

GetJobTrigger(GetJobTriggerRequest, ServerCallContext)

public virtual Task<JobTrigger> GetJobTrigger(GetJobTriggerRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	GetJobTriggerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<JobTrigger>	The response to send back to the client (wrapped by a task).

GetStoredInfoType(GetStoredInfoTypeRequest, ServerCallContext)

public virtual Task<StoredInfoType> GetStoredInfoType(GetStoredInfoTypeRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	GetStoredInfoTypeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<StoredInfoType>	The response to send back to the client (wrapped by a task).

HybridInspectDlpJob(HybridInspectDlpJobRequest, ServerCallContext)

public virtual Task<HybridInspectResponse> HybridInspectDlpJob(HybridInspectDlpJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<HybridInspectResponse>	The response to send back to the client (wrapped by a task).

HybridInspectJobTrigger(HybridInspectJobTriggerRequest, ServerCallContext)

public virtual Task<HybridInspectResponse> HybridInspectJobTrigger(HybridInspectJobTriggerRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<HybridInspectResponse>	The response to send back to the client (wrapped by a task).

InspectContent(InspectContentRequest, ServerCallContext)

public virtual Task<InspectContentResponse> InspectContent(InspectContentRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<InspectContentResponse>	The response to send back to the client (wrapped by a task).

ListDeidentifyTemplates(ListDeidentifyTemplatesRequest, ServerCallContext)

public virtual Task<ListDeidentifyTemplatesResponse> ListDeidentifyTemplates(ListDeidentifyTemplatesRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	ListDeidentifyTemplatesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListDeidentifyTemplatesResponse>	The response to send back to the client (wrapped by a task).

ListDlpJobs(ListDlpJobsRequest, ServerCallContext)

public virtual Task<ListDlpJobsResponse> ListDlpJobs(ListDlpJobsRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListDlpJobsResponse>	The response to send back to the client (wrapped by a task).

ListInfoTypes(ListInfoTypesRequest, ServerCallContext)

public virtual Task<ListInfoTypesResponse> ListInfoTypes(ListInfoTypesRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListInfoTypesResponse>	The response to send back to the client (wrapped by a task).

ListInspectTemplates(ListInspectTemplatesRequest, ServerCallContext)

public virtual Task<ListInspectTemplatesResponse> ListInspectTemplates(ListInspectTemplatesRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	ListInspectTemplatesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListInspectTemplatesResponse>	The response to send back to the client (wrapped by a task).

ListJobTriggers(ListJobTriggersRequest, ServerCallContext)

public virtual Task<ListJobTriggersResponse> ListJobTriggers(ListJobTriggersRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	ListJobTriggersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListJobTriggersResponse>	The response to send back to the client (wrapped by a task).

ListStoredInfoTypes(ListStoredInfoTypesRequest, ServerCallContext)

public virtual Task<ListStoredInfoTypesResponse> ListStoredInfoTypes(ListStoredInfoTypesRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	ListStoredInfoTypesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListStoredInfoTypesResponse>	The response to send back to the client (wrapped by a task).

RedactImage(RedactImageRequest, ServerCallContext)

public virtual Task<RedactImageResponse> RedactImage(RedactImageRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<RedactImageResponse>	The response to send back to the client (wrapped by a task).

ReidentifyContent(ReidentifyContentRequest, ServerCallContext)

public virtual Task<ReidentifyContentResponse> ReidentifyContent(ReidentifyContentRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ReidentifyContentResponse>	The response to send back to the client (wrapped by a task).

UpdateDeidentifyTemplate(UpdateDeidentifyTemplateRequest, ServerCallContext)

public virtual Task<DeidentifyTemplate> UpdateDeidentifyTemplate(UpdateDeidentifyTemplateRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	UpdateDeidentifyTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<DeidentifyTemplate>	The response to send back to the client (wrapped by a task).

UpdateInspectTemplate(UpdateInspectTemplateRequest, ServerCallContext)

public virtual Task<InspectTemplate> UpdateInspectTemplate(UpdateInspectTemplateRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	UpdateInspectTemplateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<InspectTemplate>	The response to send back to the client (wrapped by a task).

UpdateJobTrigger(UpdateJobTriggerRequest, ServerCallContext)

public virtual Task<JobTrigger> UpdateJobTrigger(UpdateJobTriggerRequest request, ServerCallContext context)

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

Parameters

Name	Description
request	UpdateJobTriggerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<JobTrigger>	The response to send back to the client (wrapped by a task).

UpdateStoredInfoType(UpdateStoredInfoTypeRequest, ServerCallContext)

public virtual Task<StoredInfoType> UpdateStoredInfoType(UpdateStoredInfoTypeRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns

Type	Description
Task<StoredInfoType>	The response to send back to the client (wrapped by a task).