Class: OCI::Dblm::Models::VulnerabilityScan

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dblm/models/vulnerability_scan.rb

Overview

A VulnerabilityScan is a description of a VulnerabilityScan.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

VULNERABILITY_SCAN_TYPE_ENUM = 
[
  VULNERABILITY_SCAN_TYPE_CVE = 'CVE'.freeze,
  VULNERABILITY_SCAN_TYPE_PATCH = 'PATCH'.freeze,
  VULNERABILITY_SCAN_TYPE_IMAGE_PATCH = 'IMAGE_PATCH'.freeze,
  VULNERABILITY_SCAN_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
VULNERABILITY_SCAN_STATUS_ENUM = 
[
  VULNERABILITY_SCAN_STATUS_COMPLETED = 'COMPLETED'.freeze,
  VULNERABILITY_SCAN_STATUS_ERROR = 'ERROR'.freeze,
  VULNERABILITY_SCAN_STATUS_RUNNING = 'RUNNING'.freeze,
  VULNERABILITY_SCAN_STATUS_ABORTED = 'ABORTED'.freeze,
  VULNERABILITY_SCAN_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VulnerabilityScan

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :vulnerability_scan_type (String) —

    The value to assign to the #vulnerability_scan_type property

  • :vulnerability_scan_status (String) —

    The value to assign to the #vulnerability_scan_status property

  • :vulnerability_scan_message (String) —

    The value to assign to the #vulnerability_scan_message property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_ended (DateTime) —

    The value to assign to the #time_ended property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 160

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.vulnerability_scan_type = attributes[:'vulnerabilityScanType'] if attributes[:'vulnerabilityScanType']

  raise 'You cannot provide both :vulnerabilityScanType and :vulnerability_scan_type' if attributes.key?(:'vulnerabilityScanType') && attributes.key?(:'vulnerability_scan_type')

  self.vulnerability_scan_type = attributes[:'vulnerability_scan_type'] if attributes[:'vulnerability_scan_type']

  self.vulnerability_scan_status = attributes[:'vulnerabilityScanStatus'] if attributes[:'vulnerabilityScanStatus']

  raise 'You cannot provide both :vulnerabilityScanStatus and :vulnerability_scan_status' if attributes.key?(:'vulnerabilityScanStatus') && attributes.key?(:'vulnerability_scan_status')

  self.vulnerability_scan_status = attributes[:'vulnerability_scan_status'] if attributes[:'vulnerability_scan_status']

  self.vulnerability_scan_message = attributes[:'vulnerabilityScanMessage'] if attributes[:'vulnerabilityScanMessage']

  raise 'You cannot provide both :vulnerabilityScanMessage and :vulnerability_scan_message' if attributes.key?(:'vulnerabilityScanMessage') && attributes.key?(:'vulnerability_scan_message')

  self.vulnerability_scan_message = attributes[:'vulnerability_scan_message'] if attributes[:'vulnerability_scan_message']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

  raise 'You cannot provide both :timeEnded and :time_ended' if attributes.key?(:'timeEnded') && attributes.key?(:'time_ended')

  self.time_ended = attributes[:'time_ended'] if attributes[:'time_ended']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 52

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


94
95
96
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 94

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. It does not have to be unique, and it is changeable.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 48

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


88
89
90
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 88

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the VulnerabilityScan.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 44

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the VulnerabilityScan.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 82

def lifecycle_state
  @lifecycle_state
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


100
101
102
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 100

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the VulnerabilityScan was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 71

def time_created
  @time_created
end

#time_ended ⇒ DateTime

[Required] The date and time the VulnerabilityScan was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 78

def time_ended
  @time_ended
end

#vulnerability_scan_message ⇒ String

[Required] The message of the vulnerability scan status.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 64

def vulnerability_scan_message
  @vulnerability_scan_message
end

#vulnerability_scan_status ⇒ String

[Required] The status of the vulnerability scan.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 60

def vulnerability_scan_status
  @vulnerability_scan_status
end

#vulnerability_scan_type ⇒ String

[Required] Scan type is CVE, PATCH or IMAGE_PATCH

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 56

def vulnerability_scan_type
  @vulnerability_scan_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 103

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'vulnerability_scan_type': :'vulnerabilityScanType',
    'vulnerability_scan_status': :'vulnerabilityScanStatus',
    'vulnerability_scan_message': :'vulnerabilityScanMessage',
    'time_created': :'timeCreated',
    'time_ended': :'timeEnded',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 123

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'vulnerability_scan_type': :'String',
    'vulnerability_scan_status': :'String',
    'vulnerability_scan_message': :'String',
    'time_created': :'DateTime',
    'time_ended': :'DateTime',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 281

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    vulnerability_scan_type == other.vulnerability_scan_type &&
    vulnerability_scan_status == other.vulnerability_scan_status &&
    vulnerability_scan_message == other.vulnerability_scan_message &&
    time_created == other.time_created &&
    time_ended == other.time_ended &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 322

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


302
303
304
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 302

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 311

def hash
  [id, display_name, compartment_id, vulnerability_scan_type, vulnerability_scan_status, vulnerability_scan_message, time_created, time_ended, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 355

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



349
350
351
 
# File 'lib/oci/dblm/models/vulnerability_scan.rb', line 349

def to_s
  to_hash.to_s
end