Class: Google::Apis::SecuritycenterV1p1alpha1::Finding

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

Overview

Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Cloud SCC 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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Finding

Returns a new instance of Finding.



127
128
129
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 127

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

Instance Attribute Details

#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) 


58
59
60
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 58

def category
  @category
end

#create_time ⇒ String

The time at which the finding was created in Cloud SCC. Corresponds to the JSON property createTime

Returns:

  • (String) 


63
64
65
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 63

def create_time
  @create_time
end

#event_time ⇒ String

The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. Corresponds to the JSON property eventTime

Returns:

  • (String) 


70
71
72
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 70

def event_time
  @event_time
end

#external_uri ⇒ String

The URI that, if available, points to a web page outside of Cloud SCC 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) 


77
78
79
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 77

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


85
86
87
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 85

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


94
95
96
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 94

def parent
  @parent
end

#resource_name ⇒ String

For findings on Google Cloud Platform (GCP) resources, the full resource name of the GCP resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-GCP 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) 


104
105
106
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 104

def resource_name
  @resource_name
end

#security_marks ⇒ Google::Apis::SecuritycenterV1p1alpha1::SecurityMarks

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

Returns:



112
113
114
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 112

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


120
121
122
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 120

def source_properties
  @source_properties
end

#state ⇒ String

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

Returns:

  • (String) 


125
126
127
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 125

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'generated/google/apis/securitycenter_v1p1alpha1/classes.rb', line 132

def update!(**args)
  @category = args[:category] if args.key?(:category)
  @create_time = args[:create_time] if args.key?(:create_time)
  @event_time = args[:event_time] if args.key?(:event_time)
  @external_uri = args[:external_uri] if args.key?(:external_uri)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @security_marks = args[:security_marks] if args.key?(:security_marks)
  @source_properties = args[:source_properties] if args.key?(:source_properties)
  @state = args[:state] if args.key?(:state)
end