Class: SwaggerClient::ScanSchedule

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScanSchedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
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
151
152
153
154
155
156
157
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SwaggerClient::ScanSchedule` 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::ScanSchedule`. 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?(:'assets')
    self.assets = attributes[:'assets']
  end

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

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

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

  if attributes.key?(:'links')
    if (value = attributes[:'links']).is_a?(Array)
      self.links = value
    end
  end

  if attributes.key?(:'next_runtimes')
    if (value = attributes[:'next_runtimes']).is_a?(Array)
      self.next_runtimes = value
    end
  end

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

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

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

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

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

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

Instance Attribute Details

#assets ⇒ Object

Returns the value of attribute assets.



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

def assets
  @assets
end

#duration ⇒ Object

Specifies the maximum duration the scheduled scan is allowed to run. Scheduled scans that do not complete within specified duration will be paused. The scan duration are represented by the format ‘"PDTHM"`. In these representations, the [n] is replaced by a value for each of the date and time elements that follow the [n].The following table describes each supported value: | Value | Description | | ———- | —————- | | P | The duration designator. It must be placed at the start of the duration representation. | | D | The day designator that follows the value for the number of days. | | T | The time designator that precedes the time portion of the representation. | | H | The hour designator that follows the value for the number of hours. | | M | The minute designator that follows the value for the number of minutes. | For example, `"P5DT10H30M"` represents a duration of "5 days, 10 hours, and 30 minutes". Each duration designator is optional; however, at least one must be specified and it must be preceded by the `"P"` designator.



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

def duration
  @duration
end

#enabled ⇒ Object

Flag indicating whether the scan schedule is enabled.



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

def enabled
  @enabled
end

#id ⇒ Object

The identifier of the scan schedule.



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

def id
  @id
end

#links ⇒ Object

Returns the value of attribute links.



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

def links
  @links
end

#next_runtimes ⇒ Object

List the next 10 dates in the future the schedule will launch.



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

def next_runtimes
  @next_runtimes
end

#on_scan_repeat ⇒ Object

Specifies the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration. The following table describes each supported value: | Value | Description | | ———- | —————- | | restart-scan | Stops the previously-paused scan and launches a new scan if the previous scan did not complete within the specified duration. If the previous scheduled scan was not paused, then a new scan is launched. | | resume-scan | Resumes the previously-paused scan if the previous scan did not complete within the specified duration. If the previous scheduled scan was not paused, then a new scan is launched. |



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

def on_scan_repeat
  @on_scan_repeat
end

#repeat ⇒ Object

Returns the value of attribute repeat.



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

def repeat
  @repeat
end

#scan_engine_id ⇒ Object

The identifier of the scan engine to be used for this scan schedule. If not set, the site’s assigned scan engine will be used.



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

def scan_engine_id
  @scan_engine_id
end

#scan_name ⇒ Object

A user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching. Scan names must be unique within the site’s scan schedules.



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

def scan_name
  @scan_name
end

#scan_template_id ⇒ Object

The identifier of the scan template to be used for this scan schedule. If not set, the site’s assigned scan template will be used.



44
45
46
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 44

def scan_template_id
  @scan_template_id
end

#start ⇒ Object

The scheduled start date and time. Date is represented in ISO 8601 format. Repeating schedules will determine the next schedule to begin based on this date and time.



47
48
49
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 47

def start
  @start
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 50

def self.attribute_map
  {
    :'assets' => :'assets',
    :'duration' => :'duration',
    :'enabled' => :'enabled',
    :'id' => :'id',
    :'links' => :'links',
    :'next_runtimes' => :'nextRuntimes',
    :'on_scan_repeat' => :'onScanRepeat',
    :'repeat' => :'repeat',
    :'scan_engine_id' => :'scanEngineId',
    :'scan_name' => :'scanName',
    :'scan_template_id' => :'scanTemplateId',
    :'start' => :'start'
  }
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



221
222
223
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 221

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 68

def self.openapi_types
  {
    :'assets' => :'Object',
    :'duration' => :'Object',
    :'enabled' => :'Object',
    :'id' => :'Object',
    :'links' => :'Object',
    :'next_runtimes' => :'Object',
    :'on_scan_repeat' => :'Object',
    :'repeat' => :'Object',
    :'scan_engine_id' => :'Object',
    :'scan_name' => :'Object',
    :'scan_template_id' => :'Object',
    :'start' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assets == o.assets &&
      duration == o.duration &&
      enabled == o.enabled &&
      id == o.id &&
      links == o.links &&
      next_runtimes == o.next_runtimes &&
      on_scan_repeat == o.on_scan_repeat &&
      repeat == o.repeat &&
      scan_engine_id == o.scan_engine_id &&
      scan_name == o.scan_name &&
      scan_template_id == o.scan_template_id &&
      start == o.start
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 251

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 320

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 228

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


208
209
210
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 214

def hash
  [assets, duration, enabled, id, links, next_runtimes, on_scan_repeat, repeat, scan_engine_id, scan_name, scan_template_id, start].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @enabled.nil?
    invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
  end

  if @on_scan_repeat.nil?
    invalid_properties.push('invalid value for "on_scan_repeat", on_scan_repeat cannot be nil.')
  end

  if @start.nil?
    invalid_properties.push('invalid value for "start", start cannot be nil.')
  end

  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



296
297
298
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 302

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



290
291
292
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 290

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



180
181
182
183
184
185
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_schedule.rb', line 180

def valid?
  return false if @enabled.nil?
  return false if @on_scan_repeat.nil?
  return false if @start.nil?
  true
end