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.



6721
6722
6723
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6721

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

Instance Attribute Details

#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) 


6702
6703
6704
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6702

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. Corresponds to the JSON property scanNotApplicableForContext

Returns:

  • (Boolean) 


6712
6713
6714
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6712

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) 


6719
6720
6721
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6719

def scan_outcome
  @scan_outcome
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6726
6727
6728
6729
6730
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6726

def update!(**args)
  @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)
end