Class: SwaggerClient::RiskTrendResource

Inherits:
Object
  • Object
show all
Defined in:
lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RiskTrendResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 102

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SwaggerClient::RiskTrendResource` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SwaggerClient::RiskTrendResource`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'all_assets')
    self.all_assets = attributes[:'all_assets']
  end

  if attributes.key?(:'asset_group_membership')
    self.asset_group_membership = attributes[:'asset_group_membership']
  end

  if attributes.key?(:'asset_groups')
    self.asset_groups = attributes[:'asset_groups']
  end

  if attributes.key?(:'assets')
    self.assets = attributes[:'assets']
  end

  if attributes.key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.key?(:'sites')
    self.sites = attributes[:'sites']
  end

  if attributes.key?(:'tag_membership')
    self.tag_membership = attributes[:'tag_membership']
  end

  if attributes.key?(:'tags')
    self.tags = attributes[:'tags']
  end

  if attributes.key?(:'to')
    self.to = attributes[:'to']
  end
end

Instance Attribute Details

#all_assets ⇒ Object

Returns the value of attribute all_assets.



16
17
18
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 16

def all_assets
  @all_assets
end

#asset_group_membership ⇒ Object

Whether all asset groups in the history of deployment or those as of the report generation time are to be included.



19
20
21
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 19

def asset_group_membership
  @asset_group_membership
end

#asset_groups ⇒ Object

Whether to include a trend for the 5 highest-risk asset groups in the scope of the report (either the average or total risk). Only allowed if asset groups are specified in the report scope.



22
23
24
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 22

def asset_groups
  @asset_groups
end

#assets ⇒ Object

Whether to include a trend for the 5 highest-risk assets in the scope of the report.



25
26
27
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 25

def assets
  @assets
end

#from ⇒ Object

The start date of the risk trend, which can either be a duration or a specific date and time.



28
29
30
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 28

def from
  @from
end

#sites ⇒ Object

Whether to include a trend for the 5 highest-risk sites in the scope of the report (either the average or total risk). Only allowed if sites are specified in the report scope.



31
32
33
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 31

def sites
  @sites
end

#tag_membership ⇒ Object

Whether all assets tagged in the history of deployment or those tagged as of the report generation time are to be included.



34
35
36
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 34

def tag_membership
  @tag_membership
end

#tags ⇒ Object

Whether to include a trend for the 5 highest-risk tags for assets in the scope of the report (either the average or total risk). Only allowed if tags are specified in the report scope.



37
38
39
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 37

def tags
  @tags
end

#to ⇒ Object

The end date of the risk trend (empty if ‘from` is a duration).



40
41
42
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 40

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 65

def self.attribute_map
  {
    :'all_assets' => :'allAssets',
    :'asset_group_membership' => :'assetGroupMembership',
    :'asset_groups' => :'assetGroups',
    :'assets' => :'assets',
    :'from' => :'from',
    :'sites' => :'sites',
    :'tag_membership' => :'tagMembership',
    :'tags' => :'tags',
    :'to' => :'to'
  }
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



268
269
270
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 268

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 95

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 80

def self.openapi_types
  {
    :'all_assets' => :'Object',
    :'asset_group_membership' => :'Object',
    :'asset_groups' => :'Object',
    :'assets' => :'Object',
    :'from' => :'Object',
    :'sites' => :'Object',
    :'tag_membership' => :'Object',
    :'tags' => :'Object',
    :'to' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      all_assets == o.all_assets &&
      asset_group_membership == o.asset_group_membership &&
      asset_groups == o.asset_groups &&
      assets == o.assets &&
      from == o.from &&
      sites == o.sites &&
      tag_membership == o.tag_membership &&
      tags == o.tags &&
      to == o.to
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 298

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    SwaggerClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 367

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 275

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


255
256
257
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 261

def hash
  [all_assets, asset_group_membership, asset_groups, assets, from, sites, tag_membership, tags, to].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



154
155
156
157
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



343
344
345
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 343

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 349

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



337
338
339
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 337

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/risk_trend_resource.rb', line 161

def valid?
  asset_group_membership_validator = EnumAttributeValidator.new('Object', ['historical', 'generation'])
  return false unless asset_group_membership_validator.valid?(@asset_group_membership)
  asset_groups_validator = EnumAttributeValidator.new('Object', ['average', 'total'])
  return false unless asset_groups_validator.valid?(@asset_groups)
  from_validator = EnumAttributeValidator.new('Object', ['P1Y', 'P6M', 'P3M', 'P1M', '<date>'])
  return false unless from_validator.valid?(@from)
  sites_validator = EnumAttributeValidator.new('Object', ['average', 'total'])
  return false unless sites_validator.valid?(@sites)
  tag_membership_validator = EnumAttributeValidator.new('Object', ['historical', 'generation'])
  return false unless tag_membership_validator.valid?(@tag_membership)
  tags_validator = EnumAttributeValidator.new('Object', ['average', 'total'])
  return false unless tags_validator.valid?(@tags)
  true
end