Class: OCI::VulnerabilityScanning::Models::HostScanTargetErrorSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb

Overview

One of the error during scanning on instances associated with a host scan target (application of a host scan recipe to a compartment or list of hosts).

Constant Summary collapse

VENDOR_ENUM = 
[
  VENDOR_OCI = 'OCI'.freeze,
  VENDOR_QUALYS = 'QUALYS'.freeze,
  VENDOR_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 = {}) ⇒ HostScanTargetErrorSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vendor (String) —

    The value to assign to the #vendor property

  • :task (String) —

    The value to assign to the #task property

  • :message (String) —

    The value to assign to the #message property

  • :error_code (String) —

    The value to assign to the #error_code property

  • :instance_id (String) —

    The value to assign to the #instance_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated 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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 126

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.vendor = attributes[:'vendor'] if attributes[:'vendor']

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

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

  self.error_code = attributes[:'errorCode'] if attributes[:'errorCode']

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

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

  self.instance_id = attributes[:'instanceId'] if attributes[:'instanceId']

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

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

  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.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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

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


66
67
68
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 66

def defined_tags
  @defined_tags
end

#error_code ⇒ String

Error code of task failure.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 42

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


60
61
62
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 60

def freeform_tags
  @freeform_tags
end

#instance_id ⇒ String

[Required] OCID of the host instance where scan was done.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 46

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

[Required] The current state of the config.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 50

def lifecycle_state
  @lifecycle_state
end

#message ⇒ String

[Required] Error message detailing task failure.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 38

def message
  @message
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


72
73
74
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 72

def system_tags
  @system_tags
end

#task ⇒ String

Task during scan which failed.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 34

def task
  @task
end

#time_updated ⇒ DateTime

[Required] Date and time the error was updated, format as described in RFC 3339.

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 54

def time_updated
  @time_updated
end

#vendor ⇒ String

[Required] Vendor which was used for the host scan agent.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 30

def vendor
  @vendor
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 75

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'vendor': :'vendor',
    'task': :'task',
    'message': :'message',
    'error_code': :'errorCode',
    'instance_id': :'instanceId',
    'lifecycle_state': :'lifecycleState',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 93

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'vendor': :'String',
    'task': :'String',
    'message': :'String',
    'error_code': :'String',
    'instance_id': :'String',
    'lifecycle_state': :'String',
    'time_updated': :'DateTime',
    '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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 214

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

  self.class == other.class &&
    vendor == other.vendor &&
    task == other.task &&
    message == other.message &&
    error_code == other.error_code &&
    instance_id == other.instance_id &&
    lifecycle_state == other.lifecycle_state &&
    time_updated == other.time_updated &&
    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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 253

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


233
234
235
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 233

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



242
243
244
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 242

def hash
  [vendor, task, message, error_code, instance_id, lifecycle_state, time_updated, 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



286
287
288
289
290
291
292
293
294
295
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 286

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



280
281
282
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target_error_summary.rb', line 280

def to_s
  to_hash.to_s
end