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.



1200
1201
1202
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1200

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

Instance Attribute Details

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

Represents an access event. Corresponds to the JSON property access

Returns:



949
950
951
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 949

def access
  @access
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) 


958
959
960
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 958

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) 


964
965
966
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 964

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

Returns:



970
971
972
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 970

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

Returns:



977
978
979
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 977

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

Returns:



983
984
985
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 983

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

Returns:



988
989
990
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 988

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

Returns:



998
999
1000
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 998

def contacts
  @contacts
end

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

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

Returns:



1004
1005
1006
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1004

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) 


1009
1010
1011
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1009

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 CloudSQL instances or Cloud Spanner instances), or the database instance itself. Some database resources may not have the full resource name populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. CloudSQL databases). In these cases only the display name will be provided. Corresponds to the JSON property database

Returns:



1019
1020
1021
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1019

def database
  @database
end

#description ⇒ String

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

Returns:

  • (String) 


1024
1025
1026
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1024

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) 


1034
1035
1036
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1034

def event_time
  @event_time
end

#exfiltration ⇒ Google::Apis::SecuritycenterV1beta2::Exfiltration

Exfiltration represents a data exfiltration attempt of one or more sources to one or more targets. Sources represent the source of data that is exfiltrated, and Targets represents the destination the data was copied to. Corresponds to the JSON property exfiltration

Returns:



1041
1042
1043
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1041

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

Returns:



1047
1048
1049
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1047

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) 


1054
1055
1056
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1054

def external_uri
  @external_uri
end

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

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

Returns:



1059
1060
1061
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1059

def files
  @files
end

#finding_class ⇒ String

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

Returns:

  • (String) 


1064
1065
1066
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1064

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

Returns:



1069
1070
1071
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1069

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

Returns:



1078
1079
1080
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1078

def indicator
  @indicator
end

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

Kernel mode rootkit signatures. Corresponds to the JSON property kernelRootkit

Returns:



1083
1084
1085
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1083

def kernel_rootkit
  @kernel_rootkit
end

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

Kubernetes-related attributes. Corresponds to the JSON property kubernetes

Returns:



1088
1089
1090
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1088

def kubernetes
  @kubernetes
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

Returns:



1094
1095
1096
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1094

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) 


1100
1101
1102
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1100

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) 


1107
1108
1109
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1107

def mute
  @mute
end

#mute_initiator ⇒ String

First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. Corresponds to the JSON property muteInitiator

Returns:

  • (String) 


1115
1116
1117
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1115

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) 


1120
1121
1122
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1120

def mute_update_time
  @mute_update_time
end

#name ⇒ String

The relative resource name of this finding. See: https://cloud.google.com/apis/ design/resource_names#relative_resource_name Example: "organizations/ organization_id/sources/source_id/findings/finding_id" Corresponds to the JSON property name

Returns:

  • (String) 


1127
1128
1129
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1127

def name
  @name
end

#next_steps ⇒ String

Next steps associate to the finding. Corresponds to the JSON property nextSteps

Returns:

  • (String) 


1132
1133
1134
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1132

def next_steps
  @next_steps
end

#org_policy_constraints ⇒ Array<Google::Apis::SecuritycenterV1beta2::OrgPolicyConstraint>

Contains information about the org policy constraints associated with the finding. Corresponds to the JSON property orgPolicyConstraints

Returns:



1138
1139
1140
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1138

def org_policy_constraints
  @org_policy_constraints
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) 


1146
1147
1148
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1146

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) 


1152
1153
1154
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1152

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

Returns:



1157
1158
1159
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1157

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) 


1166
1167
1168
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1166

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

Returns:



1174
1175
1176
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1174

def security_marks
  @security_marks
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) 


1180
1181
1182
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1180

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:

  • (Hash<String,Object>) 


1188
1189
1190
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1188

def source_properties
  @source_properties
end

#state ⇒ String

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

Returns:

  • (String) 


1193
1194
1195
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1193

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

Returns:



1198
1199
1200
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1198

def vulnerability
  @vulnerability
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1205

def update!(**args)
  @access = args[:access] if args.key?(:access)
  @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)
  @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_policy_constraints = args[:org_policy_constraints] if args.key?(:org_policy_constraints)
  @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)
  @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