Class: Google::Apis::DlpV2::GooglePrivacyDlpV2Action

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dlp_v2/classes.rb,
lib/google/apis/dlp_v2/representations.rb,
lib/google/apis/dlp_v2/representations.rb

Overview

A task to execute on the completion of a job. See https://cloud.google.com/dlp/ docs/concepts-actions to learn more.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2Action

Returns a new instance of GooglePrivacyDlpV2Action.



101
102
103
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 101

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#deidentify ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2Deidentify

Create a de-identified copy of the requested table or files. . A TransformationDetail will be created for each transformation. If any rows in BigQuery are skipped during de-identification (transformation errors or row size exceeds BigQuery insert API limits) they are placed in the failure output table. If the original row exceeds the BigQuery insert API limit it will be truncated when written to the failure output table. The failure output table can be set in the action.deidentify.output.big_query_output. deidentified_failure_output_table field, if no table is set, a table will be automatically created in the same project and dataset as the original table. Compatible with: Inspect Corresponds to the JSON property deidentify

Returns:



42
43
44
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 42

def deidentify
  @deidentify
end

#job_notification_emails ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2JobNotificationEmails

Enable email notification to project owners and editors on jobs's completion/ failure. Corresponds to the JSON property jobNotificationEmails

Returns:



48
49
50
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 48

def job_notification_emails
  @job_notification_emails
end

#pub_sub ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2PublishToPubSub

Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, DlpJobName, which is equal to the finished job's DlpJob.name. Compatible with: Inspect, Risk Corresponds to the JSON property pubSub

Returns:



56
57
58
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 56

def pub_sub
  @pub_sub
end

#publish_findings_to_cloud_data_catalog ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog

Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the roles/datacatalog.tagTemplateOwner permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see Service Specific Terms. Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect Corresponds to the JSON property publishFindingsToCloudDataCatalog

Returns:



73
74
75
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 73

def publish_findings_to_cloud_data_catalog
  @publish_findings_to_cloud_data_catalog
end

#publish_summary_to_cscc ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2PublishSummaryToCscc

Publish the result summary of a DlpJob to the Cloud Security Command Center ( CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish the count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service- specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect Corresponds to the JSON property publishSummaryToCscc

Returns:



84
85
86
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 84

def publish_summary_to_cscc
  @publish_summary_to_cscc
end

#publish_to_stackdriver ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2PublishToStackdriver

Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. Corresponds to the JSON property publishToStackdriver

Returns:



92
93
94
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 92

def publish_to_stackdriver
  @publish_to_stackdriver
end

#save_findings ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2SaveFindings

If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk Corresponds to the JSON property saveFindings

Returns:



99
100
101
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 99

def save_findings
  @save_findings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



106
107
108
109
110
111
112
113
114
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 106

def update!(**args)
  @deidentify = args[:deidentify] if args.key?(:deidentify)
  @job_notification_emails = args[:job_notification_emails] if args.key?(:job_notification_emails)
  @pub_sub = args[:pub_sub] if args.key?(:pub_sub)
  @publish_findings_to_cloud_data_catalog = args[:publish_findings_to_cloud_data_catalog] if args.key?(:publish_findings_to_cloud_data_catalog)
  @publish_summary_to_cscc = args[:publish_summary_to_cscc] if args.key?(:publish_summary_to_cscc)
  @publish_to_stackdriver = args[:publish_to_stackdriver] if args.key?(:publish_to_stackdriver)
  @save_findings = args[:save_findings] if args.key?(:save_findings)
end