Class: Google::Apis::SecuritycenterV1beta1::Finding

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

Overview

Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Finding

Returns a new instance of Finding.



1670
1671
1672
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1670

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

Instance Attribute Details

#access ⇒ Google::Apis::SecuritycenterV1beta1::Access

Represents an access event. Corresponds to the JSON property access

Returns:



1384
1385
1386
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1384

def access
  @access
end

#application ⇒ Google::Apis::SecuritycenterV1beta1::Application

Represents an application associated with a finding. Corresponds to the JSON property application

Returns:



1389
1390
1391
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1389

def application
  @application
end

#attack_exposure ⇒ Google::Apis::SecuritycenterV1beta1::AttackExposure

An attack exposure contains the results of an attack path simulation run. Corresponds to the JSON property attackExposure

Returns:



1394
1395
1396
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1394

def attack_exposure
  @attack_exposure
end

#backup_disaster_recovery ⇒ Google::Apis::SecuritycenterV1beta1::BackupDisasterRecovery

Information related to Google Cloud Backup and DR Service findings. Corresponds to the JSON property backupDisasterRecovery

Returns:



1399
1400
1401
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1399

def backup_disaster_recovery
  @backup_disaster_recovery
end

#canonical_name ⇒ String

The canonical name of the finding. It's either "organizations/organization_id /sources/source_id/findings/finding_id", "folders/folder_id/sources/ source_id/findings/finding_id" or "projects/project_number/sources/ source_id/findings/finding_id", depending on the closest CRM ancestor of the resource associated with the finding. Corresponds to the JSON property canonicalName

Returns:

  • (String) 


1408
1409
1410
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1408

def canonical_name
  @canonical_name
end

#category ⇒ String

The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" Corresponds to the JSON property category

Returns:

  • (String) 


1414
1415
1416
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1414

def category
  @category
end

#cloud_dlp_data_profile ⇒ Google::Apis::SecuritycenterV1beta1::CloudDlpDataProfile

The data profile associated with the finding. Corresponds to the JSON property cloudDlpDataProfile

Returns:



1420
1421
1422
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1420

def cloud_dlp_data_profile
  @cloud_dlp_data_profile
end

#cloud_dlp_inspection ⇒ Google::Apis::SecuritycenterV1beta1::CloudDlpInspection

Details about the Cloud Data Loss Prevention (Cloud DLP) inspection job that produced the finding. Corresponds to the JSON property cloudDlpInspection

Returns:



1427
1428
1429
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1427

def cloud_dlp_inspection
  @cloud_dlp_inspection
end

#compliances ⇒ Array<Google::Apis::SecuritycenterV1beta1::Compliance>

Contains compliance information for security standards associated to the finding. Corresponds to the JSON property compliances

Returns:



1433
1434
1435
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1433

def compliances
  @compliances
end

#connections ⇒ Array<Google::Apis::SecuritycenterV1beta1::Connection>

Contains information about the IP connection associated with the finding. Corresponds to the JSON property connections

Returns:



1438
1439
1440
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1438

def connections
  @connections
end

#contacts ⇒ Hash<String,Google::Apis::SecuritycenterV1beta1::ContactDetails>

Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource- manager/docs/managing-notification-contacts#notification-categories " security": "contacts": [ "email": "person1@company.com", "email": " person2@company.com" ] Corresponds to the JSON property contacts

Returns:



1448
1449
1450
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1448

def contacts
  @contacts
end

#containers ⇒ Array<Google::Apis::SecuritycenterV1beta1::Container>

Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. Corresponds to the JSON property containers

Returns:



1454
1455
1456
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1454

def containers
  @containers
end

#create_time ⇒ String

The time at which the finding was created in Security Command Center. Corresponds to the JSON property createTime

Returns:

  • (String) 


1459
1460
1461
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1459

def create_time
  @create_time
end

#database ⇒ Google::Apis::SecuritycenterV1beta1::Database

Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the full resource name populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. Corresponds to the JSON property database

Returns:



1470
1471
1472
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1470

def database
  @database
end

#description ⇒ String

Contains more details about the finding. Corresponds to the JSON property description

Returns:

  • (String) 


1475
1476
1477
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1475

def description
  @description
end

#event_time ⇒ String

The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. Corresponds to the JSON property eventTime

Returns:

  • (String) 


1485
1486
1487
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1485

def event_time
  @event_time
end

#exfiltration ⇒ Google::Apis::SecuritycenterV1beta1::Exfiltration

Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The sources attribute lists the sources of the exfiltrated data. The targets attribute lists the destinations the data was copied to. Corresponds to the JSON property exfiltration

Returns:



1493
1494
1495
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1493

def exfiltration
  @exfiltration
end

#external_systems ⇒ Hash<String,Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1ExternalSystem>

Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. Corresponds to the JSON property externalSystems

Returns:



1499
1500
1501
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1499

def external_systems
  @external_systems
end

#external_uri ⇒ String

The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. Corresponds to the JSON property externalUri

Returns:

  • (String) 


1506
1507
1508
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1506

def external_uri
  @external_uri
end

#files ⇒ Array<Google::Apis::SecuritycenterV1beta1::File>

File associated with the finding. Corresponds to the JSON property files

Returns:



1511
1512
1513
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1511

def files
  @files
end

#finding_class ⇒ String

The class of the finding. Corresponds to the JSON property findingClass

Returns:

  • (String) 


1516
1517
1518
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1516

def finding_class
  @finding_class
end

#iam_bindings ⇒ Array<Google::Apis::SecuritycenterV1beta1::IamBinding>

Represents IAM bindings associated with the finding. Corresponds to the JSON property iamBindings

Returns:



1521
1522
1523
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1521

def iam_bindings
  @iam_bindings
end

#indicator ⇒ Google::Apis::SecuritycenterV1beta1::Indicator

Represents what's commonly known as an indicator of compromise (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see Indicator of compromise. Corresponds to the JSON property indicator

Returns:



1530
1531
1532
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1530

def indicator
  @indicator
end

#kernel_rootkit ⇒ Google::Apis::SecuritycenterV1beta1::KernelRootkit

Kernel mode rootkit signatures. Corresponds to the JSON property kernelRootkit

Returns:



1535
1536
1537
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1535

def kernel_rootkit
  @kernel_rootkit
end

#kubernetes ⇒ Google::Apis::SecuritycenterV1beta1::Kubernetes

Kubernetes-related attributes. Corresponds to the JSON property kubernetes

Returns:



1540
1541
1542
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1540

def kubernetes
  @kubernetes
end

#load_balancers ⇒ Array<Google::Apis::SecuritycenterV1beta1::LoadBalancer>

The load balancers associated with the finding. Corresponds to the JSON property loadBalancers

Returns:



1545
1546
1547
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1545

def load_balancers
  @load_balancers
end

#log_entries ⇒ Array<Google::Apis::SecuritycenterV1beta1::LogEntry>

Log entries that are relevant to the finding. Corresponds to the JSON property logEntries

Returns:



1550
1551
1552
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1550

def log_entries
  @log_entries
end

#mitre_attack ⇒ Google::Apis::SecuritycenterV1beta1::MitreAttack

MITRE ATT&CK tactics and techniques related to this finding. See: https:// attack.mitre.org Corresponds to the JSON property mitreAttack

Returns:



1556
1557
1558
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1556

def mitre_attack
  @mitre_attack
end

#module_name ⇒ String

Unique identifier of the module which generated the finding. Example: folders/ 598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 Corresponds to the JSON property moduleName

Returns:

  • (String) 


1562
1563
1564
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1562

def module_name
  @module_name
end

#mute ⇒ String

Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. Corresponds to the JSON property mute

Returns:

  • (String) 


1569
1570
1571
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1569

def mute
  @mute
end

#mute_initiator ⇒ String

Records additional information about the mute operation, for example, the mute configuration that muted the finding and the user who muted the finding. Corresponds to the JSON property muteInitiator

Returns:

  • (String) 


1576
1577
1578
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1576

def mute_initiator
  @mute_initiator
end

#mute_update_time ⇒ String

Output only. The most recent time this finding was muted or unmuted. Corresponds to the JSON property muteUpdateTime

Returns:

  • (String) 


1581
1582
1583
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1581

def mute_update_time
  @mute_update_time
end

#name ⇒ String

The relative resource name of the finding. Example: "organizations/ organization_id/sources/source_id/findings/finding_id", "folders/ folder_id/sources/source_id/findings/finding_id", "projects/project_id/ sources/source_id/findings/finding_id". Corresponds to the JSON property name

Returns:

  • (String) 


1590
1591
1592
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1590

def name
  @name
end

#next_steps ⇒ String

Steps to address the finding. Corresponds to the JSON property nextSteps

Returns:

  • (String) 


1595
1596
1597
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1595

def next_steps
  @next_steps
end

#org_policies ⇒ Array<Google::Apis::SecuritycenterV1beta1::OrgPolicy>

Contains information about the org policies associated with the finding. Corresponds to the JSON property orgPolicies

Returns:



1600
1601
1602
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1600

def org_policies
  @org_policies
end

#parent ⇒ String

The relative resource name of the source the finding belongs to. See: https:// cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/organization_id /sources/source_id" Corresponds to the JSON property parent

Returns:

  • (String) 


1608
1609
1610
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1608

def parent
  @parent
end

#parent_display_name ⇒ String

Output only. The human readable display name of the finding source such as " Event Threat Detection" or "Security Health Analytics". Corresponds to the JSON property parentDisplayName

Returns:

  • (String) 


1614
1615
1616
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1614

def parent_display_name
  @parent_display_name
end

#processes ⇒ Array<Google::Apis::SecuritycenterV1beta1::Process>

Represents operating system processes associated with the Finding. Corresponds to the JSON property processes

Returns:



1619
1620
1621
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1619

def processes
  @processes
end

#resource_name ⇒ String

For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. Corresponds to the JSON property resourceName

Returns:

  • (String) 


1628
1629
1630
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1628

def resource_name
  @resource_name
end

#security_marks ⇒ Google::Apis::SecuritycenterV1beta1::SecurityMarks

User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. Corresponds to the JSON property securityMarks

Returns:



1636
1637
1638
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1636

def security_marks
  @security_marks
end

#security_posture ⇒ Google::Apis::SecuritycenterV1beta1::SecurityPosture

Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. Corresponds to the JSON property securityPosture

Returns:



1644
1645
1646
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1644

def security_posture
  @security_posture
end

#severity ⇒ String

The severity of the finding. This field is managed by the source that writes the finding. Corresponds to the JSON property severity

Returns:

  • (String) 


1650
1651
1652
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1650

def severity
  @severity
end

#source_properties ⇒ Hash<String,Object>

Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. Corresponds to the JSON property sourceProperties

Returns:



1658
1659
1660
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1658

def source_properties
  @source_properties
end

#state ⇒ String

The state of the finding. Corresponds to the JSON property state

Returns:

  • (String) 


1663
1664
1665
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1663

def state
  @state
end

#vulnerability ⇒ Google::Apis::SecuritycenterV1beta1::Vulnerability

Refers to common vulnerability fields e.g. cve, cvss, cwe etc. Corresponds to the JSON property vulnerability

Returns:



1668
1669
1670
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1668

def vulnerability
  @vulnerability
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1675

def update!(**args)
  @access = args[:access] if args.key?(:access)
  @application = args[:application] if args.key?(:application)
  @attack_exposure = args[:attack_exposure] if args.key?(:attack_exposure)
  @backup_disaster_recovery = args[:backup_disaster_recovery] if args.key?(:backup_disaster_recovery)
  @canonical_name = args[:canonical_name] if args.key?(:canonical_name)
  @category = args[:category] if args.key?(:category)
  @cloud_dlp_data_profile = args[:cloud_dlp_data_profile] if args.key?(:cloud_dlp_data_profile)
  @cloud_dlp_inspection = args[:cloud_dlp_inspection] if args.key?(:cloud_dlp_inspection)
  @compliances = args[:compliances] if args.key?(:compliances)
  @connections = args[:connections] if args.key?(:connections)
  @contacts = args[:contacts] if args.key?(:contacts)
  @containers = args[:containers] if args.key?(:containers)
  @create_time = args[:create_time] if args.key?(:create_time)
  @database = args[:database] if args.key?(:database)
  @description = args[:description] if args.key?(:description)
  @event_time = args[:event_time] if args.key?(:event_time)
  @exfiltration = args[:exfiltration] if args.key?(:exfiltration)
  @external_systems = args[:external_systems] if args.key?(:external_systems)
  @external_uri = args[:external_uri] if args.key?(:external_uri)
  @files = args[:files] if args.key?(:files)
  @finding_class = args[:finding_class] if args.key?(:finding_class)
  @iam_bindings = args[:iam_bindings] if args.key?(:iam_bindings)
  @indicator = args[:indicator] if args.key?(:indicator)
  @kernel_rootkit = args[:kernel_rootkit] if args.key?(:kernel_rootkit)
  @kubernetes = args[:kubernetes] if args.key?(:kubernetes)
  @load_balancers = args[:load_balancers] if args.key?(:load_balancers)
  @log_entries = args[:log_entries] if args.key?(:log_entries)
  @mitre_attack = args[:mitre_attack] if args.key?(:mitre_attack)
  @module_name = args[:module_name] if args.key?(:module_name)
  @mute = args[:mute] if args.key?(:mute)
  @mute_initiator = args[:mute_initiator] if args.key?(:mute_initiator)
  @mute_update_time = args[:mute_update_time] if args.key?(:mute_update_time)
  @name = args[:name] if args.key?(:name)
  @next_steps = args[:next_steps] if args.key?(:next_steps)
  @org_policies = args[:org_policies] if args.key?(:org_policies)
  @parent = args[:parent] if args.key?(:parent)
  @parent_display_name = args[:parent_display_name] if args.key?(:parent_display_name)
  @processes = args[:processes] if args.key?(:processes)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @security_marks = args[:security_marks] if args.key?(:security_marks)
  @security_posture = args[:security_posture] if args.key?(:security_posture)
  @severity = args[:severity] if args.key?(:severity)
  @source_properties = args[:source_properties] if args.key?(:source_properties)
  @state = args[:state] if args.key?(:state)
  @vulnerability = args[:vulnerability] if args.key?(:vulnerability)
end