Class: OCI::CloudGuard::Models::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/resource.rb

Overview

Details of cloud guard resource

Constant Summary collapse

RISK_LEVEL_ENUM = 
[
  RISK_LEVEL_CRITICAL = 'CRITICAL'.freeze,
  RISK_LEVEL_HIGH = 'HIGH'.freeze,
  RISK_LEVEL_MEDIUM = 'MEDIUM'.freeze,
  RISK_LEVEL_LOW = 'LOW'.freeze,
  RISK_LEVEL_MINOR = 'MINOR'.freeze,
  RISK_LEVEL_NONE = 'NONE'.freeze,
  RISK_LEVEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Resource

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

  • :resource_name (String) —

    The value to assign to the #resource_name property

  • :resource_type (String) —

    The value to assign to the #resource_type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :target_id (String) —

    The value to assign to the #target_id property

  • :target_name (String) —

    The value to assign to the #target_name property

  • :region (String) —

    The value to assign to the #region property

  • :risk_level (String) —

    The value to assign to the #risk_level property

  • :time_first_monitored (DateTime) —

    The value to assign to the #time_first_monitored property

  • :time_last_monitored (DateTime) —

    The value to assign to the #time_last_monitored property

  • :problem_count (Integer) —

    The value to assign to the #problem_count property

  • :vulnerability_count (Integer) —

    The value to assign to the #vulnerability_count property

  • :open_ports_count (Integer) —

    The value to assign to the #open_ports_count property

  • :additional_details (OCI::CloudGuard::Models::ResourceAdditionalDetails) —

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



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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 173

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

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

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

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

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

  self.target_name = attributes[:'targetName'] if attributes[:'targetName']

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

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

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

  self.risk_level = attributes[:'riskLevel'] if attributes[:'riskLevel']

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

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

  self.time_first_monitored = attributes[:'timeFirstMonitored'] if attributes[:'timeFirstMonitored']

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

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

  self.time_last_monitored = attributes[:'timeLastMonitored'] if attributes[:'timeLastMonitored']

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

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

  self.problem_count = attributes[:'problemCount'] if attributes[:'problemCount']

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

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

  self.vulnerability_count = attributes[:'vulnerabilityCount'] if attributes[:'vulnerabilityCount']

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

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

  self.open_ports_count = attributes[:'openPortsCount'] if attributes[:'openPortsCount']

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

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

  self.additional_details = attributes[:'additionalDetails'] if attributes[:'additionalDetails']

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

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

  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

#additional_details ⇒ OCI::CloudGuard::Models::ResourceAdditionalDetails

Returns:



75
76
77
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 75

def additional_details
  @additional_details
end

#compartment_id ⇒ String

[Required] CompartmentId of CG Resource

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 36

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


89
90
91
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 89

def defined_tags
  @defined_tags
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\"}

Avoid entering confidential information.

Returns:

  • (Hash<String, String>) 


83
84
85
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Ocid for CG resource

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 24

def id
  @id
end

#open_ports_count ⇒ Integer

Number of open ports in a resource

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 72

def open_ports_count
  @open_ports_count
end

#problem_count ⇒ Integer

Count of existing problems for a resource

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 64

def problem_count
  @problem_count
end

#region ⇒ String

[Required] region of CG Resource

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 48

def region
  @region
end

#resource_name ⇒ String

Name for the CG resource

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 28

def resource_name
  @resource_name
end

#resource_type ⇒ String

[Required] resource type of the CG resource

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 32

def resource_type
  @resource_type
end

#risk_level ⇒ String

The Risk Level

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 52

def risk_level
  @risk_level
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


98
99
100
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 98

def system_tags
  @system_tags
end

#target_id ⇒ String

[Required] TargetId of CG Resource

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 40

def target_id
  @target_id
end

#target_name ⇒ String

Target name for the CG Resource

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 44

def target_name
  @target_name
end

#time_first_monitored ⇒ DateTime

First monitored time

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 56

def time_first_monitored
  @time_first_monitored
end

#time_last_monitored ⇒ DateTime

Last monitored time

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 60

def time_last_monitored
  @time_last_monitored
end

#vulnerability_count ⇒ Integer

Count of existing number of vulnerabilities in the resource

Returns:

  • (Integer) 


68
69
70
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 68

def vulnerability_count
  @vulnerability_count
end

Class Method Details

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 101

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'resource_name': :'resourceName',
    'resource_type': :'resourceType',
    'compartment_id': :'compartmentId',
    'target_id': :'targetId',
    'target_name': :'targetName',
    'region': :'region',
    'risk_level': :'riskLevel',
    'time_first_monitored': :'timeFirstMonitored',
    'time_last_monitored': :'timeLastMonitored',
    'problem_count': :'problemCount',
    'vulnerability_count': :'vulnerabilityCount',
    'open_ports_count': :'openPortsCount',
    'additional_details': :'additionalDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 126

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'resource_name': :'String',
    'resource_type': :'String',
    'compartment_id': :'String',
    'target_id': :'String',
    'target_name': :'String',
    'region': :'String',
    'risk_level': :'String',
    'time_first_monitored': :'DateTime',
    'time_last_monitored': :'DateTime',
    'problem_count': :'Integer',
    'vulnerability_count': :'Integer',
    'open_ports_count': :'Integer',
    'additional_details': :'OCI::CloudGuard::Models::ResourceAdditionalDetails',
    '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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 294

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

  self.class == other.class &&
    id == other.id &&
    resource_name == other.resource_name &&
    resource_type == other.resource_type &&
    compartment_id == other.compartment_id &&
    target_id == other.target_id &&
    target_name == other.target_name &&
    region == other.region &&
    risk_level == other.risk_level &&
    time_first_monitored == other.time_first_monitored &&
    time_last_monitored == other.time_last_monitored &&
    problem_count == other.problem_count &&
    vulnerability_count == other.vulnerability_count &&
    open_ports_count == other.open_ports_count &&
    additional_details == other.additional_details &&
    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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 340

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


320
321
322
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 320

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



329
330
331
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 329

def hash
  [id, resource_name, resource_type, compartment_id, target_id, target_name, region, risk_level, time_first_monitored, time_last_monitored, problem_count, vulnerability_count, open_ports_count, additional_details, 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



373
374
375
376
377
378
379
380
381
382
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 373

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



367
368
369
 
# File 'lib/oci/cloud_guard/models/resource.rb', line 367

def to_s
  to_hash.to_s
end