Class: Google::Apis::CloudsearchV1::DlpScanSummary

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

Overview

A summary of a DLP scan event. This is a summary and should contain the minimum amount of data required to identify and process DLP scans. It is written to Starcast and encoded & returned to the client on attachment upload.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DlpScanSummary

Returns a new instance of DlpScanSummary.



7755
7756
7757
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7755

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

Instance Attribute Details

#dlp_action ⇒ Google::Apis::CloudsearchV1::DlpAction

Corresponds to the JSON property dlpAction

Returns:



7721
7722
7723
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7721

def dlp_action
  @dlp_action
end

#scan_id ⇒ String

The scan ID of the corresponding @link DlpViolationScanRecord in the @link EphemeralDlpScans Spanner table. This can be used to fetch additional details about the scan, e.g. for audit logging. Corresponds to the JSON property scanId

Returns:

  • (String) 


7728
7729
7730
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7728

def scan_id
  @scan_id
end

#scan_not_applicable_for_context ⇒ Boolean Also known as: scan_not_applicable_for_context?

Indicates that was no attempt to scan a message or attachment because it was not applicable in the given context (e.g. atomic mutuate). If this is true, scan_outcome should not be set. This flag is used to identify messages that DLP did not attempt to scan for monitoring scan coverage. Contents that DLP attempted to scan but skipped can be identified by DlpScanOutcome. SCAN_SKIPPED_* reasons. DEPRECATED: The prober can determine this from the context. Corresponds to the JSON property scanNotApplicableForContext

Returns:

  • (Boolean) 


7739
7740
7741
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7739

def scan_not_applicable_for_context
  @scan_not_applicable_for_context
end

#scan_outcome ⇒ String

The outcome of a DLP Scan. If this is set, scan_not_applicable_for_context should not be true. Corresponds to the JSON property scanOutcome

Returns:

  • (String) 


7746
7747
7748
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7746

def scan_outcome
  @scan_outcome
end

#scan_trigger ⇒ String

The event that triggered the scan. This corresponds to the rule trigger configured in admin console and maps to the different things that can be scanned. Corresponds to the JSON property scanTrigger

Returns:

  • (String) 


7753
7754
7755
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7753

def scan_trigger
  @scan_trigger
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7760
7761
7762
7763
7764
7765
7766
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7760

def update!(**args)
  @dlp_action = args[:dlp_action] if args.key?(:dlp_action)
  @scan_id = args[:scan_id] if args.key?(:scan_id)
  @scan_not_applicable_for_context = args[:scan_not_applicable_for_context] if args.key?(:scan_not_applicable_for_context)
  @scan_outcome = args[:scan_outcome] if args.key?(:scan_outcome)
  @scan_trigger = args[:scan_trigger] if args.key?(:scan_trigger)
end