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.



2110
2111
2112
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2110

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:



1798
1799
1800
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1798

def access
  @access
end

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

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

Returns:



1803
1804
1805
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1803

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:



1808
1809
1810
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1808

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:



1813
1814
1815
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1813

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) 


1822
1823
1824
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1822

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) 


1828
1829
1830
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1828

def category
  @category
end

#cloud_armor ⇒ Google::Apis::SecuritycenterV1beta1::CloudArmor

Fields related to Google Cloud Armor findings. Corresponds to the JSON property cloudArmor

Returns:



1833
1834
1835
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1833

def cloud_armor
  @cloud_armor
end

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

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

Returns:



1839
1840
1841
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1839

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:



1846
1847
1848
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1846

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:



1852
1853
1854
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1852

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:



1857
1858
1859
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1857

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:



1867
1868
1869
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1867

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:



1873
1874
1875
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1873

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) 


1878
1879
1880
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1878

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:



1889
1890
1891
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1889

def database
  @database
end

#description ⇒ String

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

Returns:

  • (String) 


1894
1895
1896
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1894

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) 


1904
1905
1906
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1904

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:



1912
1913
1914
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1912

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:



1918
1919
1920
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1918

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) 


1925
1926
1927
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1925

def external_uri
  @external_uri
end

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

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

Returns:



1930
1931
1932
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1930

def files
  @files
end

#finding_class ⇒ String

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

Returns:

  • (String) 


1935
1936
1937
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1935

def finding_class
  @finding_class
end

#group_memberships ⇒ Array<Google::Apis::SecuritycenterV1beta1::GroupMembership>

Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. Corresponds to the JSON property groupMemberships

Returns:



1942
1943
1944
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1942

def group_memberships
  @group_memberships
end

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

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

Returns:



1947
1948
1949
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1947

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:



1956
1957
1958
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1956

def indicator
  @indicator
end

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

Kernel mode rootkit signatures. Corresponds to the JSON property kernelRootkit

Returns:



1961
1962
1963
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1961

def kernel_rootkit
  @kernel_rootkit
end

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

Kubernetes-related attributes. Corresponds to the JSON property kubernetes

Returns:



1966
1967
1968
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1966

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:



1971
1972
1973
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1971

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:



1976
1977
1978
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1976

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:



1982
1983
1984
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1982

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) 


1988
1989
1990
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1988

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) 


1995
1996
1997
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 1995

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) 


2002
2003
2004
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2002

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) 


2007
2008
2009
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2007

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) 


2016
2017
2018
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2016

def name
  @name
end

#next_steps ⇒ String

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

Returns:

  • (String) 


2021
2022
2023
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2021

def next_steps
  @next_steps
end

#notebook ⇒ Google::Apis::SecuritycenterV1beta1::Notebook

Represents a Jupyter notebook IPYNB file, such as a Colab Enterprise notebook file, that is associated with a finding. Corresponds to the JSON property notebook

Returns:



2028
2029
2030
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2028

def notebook
  @notebook
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:



2033
2034
2035
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2033

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) 


2041
2042
2043
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2041

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) 


2047
2048
2049
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2047

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:



2052
2053
2054
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2052

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) 


2061
2062
2063
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2061

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:



2069
2070
2071
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2069

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:



2077
2078
2079
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2077

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) 


2083
2084
2085
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2083

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:



2091
2092
2093
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2091

def source_properties
  @source_properties
end

#state ⇒ String

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

Returns:

  • (String) 


2096
2097
2098
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2096

def state
  @state
end

#toxic_combination ⇒ Google::Apis::SecuritycenterV1beta1::ToxicCombination

Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. Corresponds to the JSON property toxicCombination

Returns:



2103
2104
2105
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2103

def toxic_combination
  @toxic_combination
end

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

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

Returns:



2108
2109
2110
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2108

def vulnerability
  @vulnerability
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
 
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2115

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_armor = args[:cloud_armor] if args.key?(:cloud_armor)
  @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)
  @group_memberships = args[:group_memberships] if args.key?(:group_memberships)
  @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)
  @notebook = args[:notebook] if args.key?(:notebook)
  @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)
  @toxic_combination = args[:toxic_combination] if args.key?(:toxic_combination)
  @vulnerability = args[:vulnerability] if args.key?(:vulnerability)
end