Class: OCI::CloudGuard::Models::ResourceSummary

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

Overview

Summary of CG 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 = {}) ⇒ ResourceSummary

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

  • :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

  • :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



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
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
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 153

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.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.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] CompartmentId of CG Resource

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/cloud_guard/models/resource_summary.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>>) 


78
79
80
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 78

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


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

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_summary.rb', line 24

def id
  @id
end

#open_ports_count ⇒ Integer

Number of open ports in a resource

Returns:

  • (Integer) 


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

def open_ports_count
  @open_ports_count
end

#problem_count ⇒ Integer

Count of existing problems for a resource

Returns:

  • (Integer) 


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

def problem_count
  @problem_count
end

#region ⇒ String

region of CG Resource

Returns:

  • (String) 


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

def region
  @region
end

#resource_name ⇒ String

name of the CG resource

Returns:

  • (String) 


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

def resource_name
  @resource_name
end

#resource_type ⇒ String

resource type of the CG resource

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/cloud_guard/models/resource_summary.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_summary.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>>) 


87
88
89
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 87

def system_tags
  @system_tags
end

#target_id ⇒ String

TargetId of CG Resource

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/cloud_guard/models/resource_summary.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_summary.rb', line 44

def target_name
  @target_name
end

#vulnerability_count ⇒ Integer

Count of existing number of vulnerabilities in the resource

Returns:

  • (Integer) 


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

def vulnerability_count
  @vulnerability_count
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 90

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',
    'problem_count': :'problemCount',
    'vulnerability_count': :'vulnerabilityCount',
    'open_ports_count': :'openPortsCount',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 112

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',
    'problem_count': :'Integer',
    'vulnerability_count': :'Integer',
    'open_ports_count': :'Integer',
    '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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 256

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 &&
    problem_count == other.problem_count &&
    vulnerability_count == other.vulnerability_count &&
    open_ports_count == other.open_ports_count &&
    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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 299

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


279
280
281
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 279

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 288

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



332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 332

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



326
327
328
 
# File 'lib/oci/cloud_guard/models/resource_summary.rb', line 326

def to_s
  to_hash.to_s
end