Class: Google::Apis::SecuritycenterV1::Finding

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



2868
2869
2870
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2868

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

Instance Attribute Details

#accessGoogle::Apis::SecuritycenterV1::Access

Represents an access event. Corresponds to the JSON property access



2530
2531
2532
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2530

def access
  @access
end

#applicationGoogle::Apis::SecuritycenterV1::Application

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



2535
2536
2537
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2535

def application
  @application
end

#attack_exposureGoogle::Apis::SecuritycenterV1::AttackExposure

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



2540
2541
2542
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2540

def attack_exposure
  @attack_exposure
end

#backup_disaster_recoveryGoogle::Apis::SecuritycenterV1::BackupDisasterRecovery

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



2545
2546
2547
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2545

def backup_disaster_recovery
  @backup_disaster_recovery
end

#canonical_nameString

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)


2554
2555
2556
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2554

def canonical_name
  @canonical_name
end

#categoryString

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)


2560
2561
2562
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2560

def category
  @category
end

#cloud_armorGoogle::Apis::SecuritycenterV1::CloudArmor

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



2565
2566
2567
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2565

def cloud_armor
  @cloud_armor
end

#cloud_dlp_data_profileGoogle::Apis::SecuritycenterV1::CloudDlpDataProfile

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



2571
2572
2573
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2571

def cloud_dlp_data_profile
  @cloud_dlp_data_profile
end

#cloud_dlp_inspectionGoogle::Apis::SecuritycenterV1::CloudDlpInspection

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



2578
2579
2580
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2578

def cloud_dlp_inspection
  @cloud_dlp_inspection
end

#compliancesArray<Google::Apis::SecuritycenterV1::Compliance>

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



2584
2585
2586
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2584

def compliances
  @compliances
end

#connectionsArray<Google::Apis::SecuritycenterV1::Connection>

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



2589
2590
2591
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2589

def connections
  @connections
end

#contactsHash<String,Google::Apis::SecuritycenterV1::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



2599
2600
2601
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2599

def contacts
  @contacts
end

#containersArray<Google::Apis::SecuritycenterV1::Container>

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



2605
2606
2607
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2605

def containers
  @containers
end

#create_timeString

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

Returns:

  • (String)


2610
2611
2612
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2610

def create_time
  @create_time
end

#data_access_eventsArray<Google::Apis::SecuritycenterV1::DataAccessEvent>

Data access events associated with the finding. Corresponds to the JSON property dataAccessEvents



2615
2616
2617
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2615

def data_access_events
  @data_access_events
end

#data_flow_eventsArray<Google::Apis::SecuritycenterV1::DataFlowEvent>

Data flow events associated with the finding. Corresponds to the JSON property dataFlowEvents



2620
2621
2622
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2620

def data_flow_events
  @data_flow_events
end

#data_retention_deletion_eventsArray<Google::Apis::SecuritycenterV1::DataRetentionDeletionEvent>

Data retention deletion events associated with the finding. Corresponds to the JSON property dataRetentionDeletionEvents



2625
2626
2627
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2625

def data_retention_deletion_events
  @data_retention_deletion_events
end

#databaseGoogle::Apis::SecuritycenterV1::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



2636
2637
2638
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2636

def database
  @database
end

#descriptionString

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

Returns:

  • (String)


2641
2642
2643
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2641

def description
  @description
end

#diskGoogle::Apis::SecuritycenterV1::Disk

Contains information about the disk associated with the finding. Corresponds to the JSON property disk



2646
2647
2648
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2646

def disk
  @disk
end

#event_timeString

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)


2656
2657
2658
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2656

def event_time
  @event_time
end

#exfiltrationGoogle::Apis::SecuritycenterV1::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



2664
2665
2666
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2664

def exfiltration
  @exfiltration
end

#external_systemsHash<String,Google::Apis::SecuritycenterV1::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



2670
2671
2672
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2670

def external_systems
  @external_systems
end

#external_uriString

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)


2677
2678
2679
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2677

def external_uri
  @external_uri
end

#filesArray<Google::Apis::SecuritycenterV1::File>

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



2682
2683
2684
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2682

def files
  @files
end

#finding_classString

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

Returns:

  • (String)


2687
2688
2689
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2687

def finding_class
  @finding_class
end

#group_membershipsArray<Google::Apis::SecuritycenterV1::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



2694
2695
2696
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2694

def group_memberships
  @group_memberships
end

#iam_bindingsArray<Google::Apis::SecuritycenterV1::IamBinding>

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



2699
2700
2701
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2699

def iam_bindings
  @iam_bindings
end

#indicatorGoogle::Apis::SecuritycenterV1::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



2708
2709
2710
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2708

def indicator
  @indicator
end

#kernel_rootkitGoogle::Apis::SecuritycenterV1::KernelRootkit

Kernel mode rootkit signatures. Corresponds to the JSON property kernelRootkit



2713
2714
2715
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2713

def kernel_rootkit
  @kernel_rootkit
end

#kubernetesGoogle::Apis::SecuritycenterV1::Kubernetes

Kubernetes-related attributes. Corresponds to the JSON property kubernetes



2718
2719
2720
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2718

def kubernetes
  @kubernetes
end

#load_balancersArray<Google::Apis::SecuritycenterV1::LoadBalancer>

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



2723
2724
2725
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2723

def load_balancers
  @load_balancers
end

#log_entriesArray<Google::Apis::SecuritycenterV1::LogEntry>

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



2728
2729
2730
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2728

def log_entries
  @log_entries
end

#mitre_attackGoogle::Apis::SecuritycenterV1::MitreAttack

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



2734
2735
2736
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2734

def mitre_attack
  @mitre_attack
end

#module_nameString

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

Returns:

  • (String)


2740
2741
2742
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2740

def module_name
  @module_name
end

#muteString

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)


2747
2748
2749
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2747

def mute
  @mute
end

#mute_infoGoogle::Apis::SecuritycenterV1::MuteInfo

Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. Corresponds to the JSON property muteInfo



2753
2754
2755
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2753

def mute_info
  @mute_info
end

#mute_initiatorString

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)


2760
2761
2762
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2760

def mute_initiator
  @mute_initiator
end

#mute_update_timeString

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

Returns:

  • (String)


2765
2766
2767
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2765

def mute_update_time
  @mute_update_time
end

#nameString

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)


2774
2775
2776
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2774

def name
  @name
end

#next_stepsString

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

Returns:

  • (String)


2779
2780
2781
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2779

def next_steps
  @next_steps
end

#notebookGoogle::Apis::SecuritycenterV1::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



2786
2787
2788
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2786

def notebook
  @notebook
end

#org_policiesArray<Google::Apis::SecuritycenterV1::OrgPolicy>

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



2791
2792
2793
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2791

def org_policies
  @org_policies
end

#parentString

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)


2799
2800
2801
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2799

def parent
  @parent
end

#parent_display_nameString

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)


2805
2806
2807
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2805

def parent_display_name
  @parent_display_name
end

#processesArray<Google::Apis::SecuritycenterV1::Process>

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



2810
2811
2812
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2810

def processes
  @processes
end

#resource_nameString

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)


2819
2820
2821
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2819

def resource_name
  @resource_name
end

#security_marksGoogle::Apis::SecuritycenterV1::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



2827
2828
2829
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2827

def security_marks
  @security_marks
end

#security_postureGoogle::Apis::SecuritycenterV1::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



2835
2836
2837
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2835

def security_posture
  @security_posture
end

#severityString

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

Returns:

  • (String)


2841
2842
2843
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2841

def severity
  @severity
end

#source_propertiesHash<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:



2849
2850
2851
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2849

def source_properties
  @source_properties
end

#stateString

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

Returns:

  • (String)


2854
2855
2856
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2854

def state
  @state
end

#toxic_combinationGoogle::Apis::SecuritycenterV1::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



2861
2862
2863
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2861

def toxic_combination
  @toxic_combination
end

#vulnerabilityGoogle::Apis::SecuritycenterV1::Vulnerability

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



2866
2867
2868
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2866

def vulnerability
  @vulnerability
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 2873

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)
  @data_access_events = args[:data_access_events] if args.key?(:data_access_events)
  @data_flow_events = args[:data_flow_events] if args.key?(:data_flow_events)
  @data_retention_deletion_events = args[:data_retention_deletion_events] if args.key?(:data_retention_deletion_events)
  @database = args[:database] if args.key?(:database)
  @description = args[:description] if args.key?(:description)
  @disk = args[:disk] if args.key?(:disk)
  @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_info = args[:mute_info] if args.key?(:mute_info)
  @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