Class: Google::Apis::SecuritycenterV1beta2::Finding

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/securitycenter_v1beta2/classes.rb,
lib/google/apis/securitycenter_v1beta2/representations.rb,
lib/google/apis/securitycenter_v1beta2/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.



1620
1621
1622
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1620

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

Instance Attribute Details

#access ⇒ Google::Apis::SecuritycenterV1beta2::Access

Represents an access event. Corresponds to the JSON property access



1334
1335
1336
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1334

def access
  @access
end

#application ⇒ Google::Apis::SecuritycenterV1beta2::Application

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



1339
1340
1341
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1339

def application
  @application
end

#attack_exposure ⇒ Google::Apis::SecuritycenterV1beta2::AttackExposure

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



1344
1345
1346
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1344

def attack_exposure
  @attack_exposure
end

#backup_disaster_recovery ⇒ Google::Apis::SecuritycenterV1beta2::BackupDisasterRecovery

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



1349
1350
1351
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1349

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)


1358
1359
1360
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1358

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)


1364
1365
1366
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1364

def category
  @category
end

#cloud_dlp_data_profile ⇒ Google::Apis::SecuritycenterV1beta2::CloudDlpDataProfile

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



1370
1371
1372
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1370

def cloud_dlp_data_profile
  @cloud_dlp_data_profile
end

#cloud_dlp_inspection ⇒ Google::Apis::SecuritycenterV1beta2::CloudDlpInspection

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



1377
1378
1379
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1377

def cloud_dlp_inspection
  @cloud_dlp_inspection
end

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

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



1383
1384
1385
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1383

def compliances
  @compliances
end

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

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



1388
1389
1390
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1388

def connections
  @connections
end

#contacts ⇒ Hash<String,Google::Apis::SecuritycenterV1beta2::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



1398
1399
1400
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1398

def contacts
  @contacts
end

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

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



1404
1405
1406
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1404

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)


1409
1410
1411
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1409

def create_time
  @create_time
end

#database ⇒ Google::Apis::SecuritycenterV1beta2::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



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

def database
  @database
end

#description ⇒ String

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

Returns:

  • (String)


1425
1426
1427
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1425

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)


1435
1436
1437
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1435

def event_time
  @event_time
end

#exfiltration ⇒ Google::Apis::SecuritycenterV1beta2::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



1443
1444
1445
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1443

def exfiltration
  @exfiltration
end

#external_systems ⇒ Hash<String,Google::Apis::SecuritycenterV1beta2::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



1449
1450
1451
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1449

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)


1456
1457
1458
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1456

def external_uri
  @external_uri
end

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

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



1461
1462
1463
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1461

def files
  @files
end

#finding_class ⇒ String

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

Returns:

  • (String)


1466
1467
1468
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1466

def finding_class
  @finding_class
end

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

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



1471
1472
1473
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1471

def iam_bindings
  @iam_bindings
end

#indicator ⇒ Google::Apis::SecuritycenterV1beta2::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



1480
1481
1482
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1480

def indicator
  @indicator
end

#kernel_rootkit ⇒ Google::Apis::SecuritycenterV1beta2::KernelRootkit

Kernel mode rootkit signatures. Corresponds to the JSON property kernelRootkit



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

def kernel_rootkit
  @kernel_rootkit
end

#kubernetes ⇒ Google::Apis::SecuritycenterV1beta2::Kubernetes

Kubernetes-related attributes. Corresponds to the JSON property kubernetes



1490
1491
1492
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1490

def kubernetes
  @kubernetes
end

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

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



1495
1496
1497
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1495

def load_balancers
  @load_balancers
end

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

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



1500
1501
1502
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1500

def log_entries
  @log_entries
end

#mitre_attack ⇒ Google::Apis::SecuritycenterV1beta2::MitreAttack

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



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

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)


1512
1513
1514
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1512

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)


1519
1520
1521
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1519

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)


1526
1527
1528
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1526

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)


1531
1532
1533
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1531

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)


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

def name
  @name
end

#next_steps ⇒ String

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

Returns:

  • (String)


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

def next_steps
  @next_steps
end

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

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



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

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)


1558
1559
1560
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1558

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)


1564
1565
1566
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1564

def parent_display_name
  @parent_display_name
end

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

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



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

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)


1578
1579
1580
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1578

def resource_name
  @resource_name
end

#security_marks ⇒ Google::Apis::SecuritycenterV1beta2::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



1586
1587
1588
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1586

def security_marks
  @security_marks
end

#security_posture ⇒ Google::Apis::SecuritycenterV1beta2::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



1594
1595
1596
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1594

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)


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

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:



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

def source_properties
  @source_properties
end

#state ⇒ String

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

Returns:

  • (String)


1613
1614
1615
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1613

def state
  @state
end

#vulnerability ⇒ Google::Apis::SecuritycenterV1beta2::Vulnerability

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



1618
1619
1620
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1618

def vulnerability
  @vulnerability
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1625

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