Class: SwaggerClient::ReportRepeat

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportRepeat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 56

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

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

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

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

Instance Attribute Details

#day_of_week ⇒ Object

The day of the week the scheduled task should repeat. This property only applies to schedules with a ‘every` value of `"day-of-month"`.



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

def day_of_week
  @day_of_week
end

#every ⇒ Object

The frequency schedule repeats. Each value represents a different unit of time and is used in conjunction with the property ‘interval`. For example, a schedule can repeat hourly, daily, monthly, etc. The following table describes each supported value: | Value | Description | | ———- | —————- | | hour | Specifies the schedule repeats in hourly increments. | | day | Specifies the schedule repeats in daily increments. | | week | Specifies the schedule repeats in weekly increments. | | date-of-month | Specifies the schedule repeats nth day of the `interval` month. Requires the property `dateOfMonth` to be specified. For example, if `dateOfMonth` is `17` and the `interval` is `2`, then the schedule will repeat every 2 months on the 17th day of the month. | | day-of-month | Specifies the schedule repeats on a monthly interval but instead of a specific date being specified, the day of the week and week of the month are specified. Requires the properties `dayOfWeek` and `weekOfMonth` to be specified. For example, if `dayOfWeek` is `"friday"`, `weekOfMonth` is `3`, and the `interval` is `4`, then the schedule will repeat every 4 months on the 3rd Friday of the month. |



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

def every
  @every
end

#interval ⇒ Object

The interval time the schedule should repeat. The is depends on the value set in ‘every`. For example, if the value in property `every` is set to `"day"` and `interval` is set to `2`, then the schedule will repeat every 2 days.



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

def interval
  @interval
end

#week_of_month ⇒ Object

The week of the month the scheduled task should repeat. For This property only applies to schedules with a ‘every` value of `"day-of-month"`. Each week of the month is counted in 7-day increments. For example, week 1 consists of days 1-7 of the month while week 2 consists of days 8-14 of the month and so forth.



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

def week_of_month
  @week_of_month
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 29

def self.attribute_map
  {
    :'day_of_week' => :'dayOfWeek',
    :'every' => :'every',
    :'interval' => :'interval',
    :'week_of_month' => :'weekOfMonth'
  }
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



135
136
137
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 135

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



49
50
51
52
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 49

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 39

def self.openapi_types
  {
    :'day_of_week' => :'Object',
    :'every' => :'Object',
    :'interval' => :'Object',
    :'week_of_month' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



111
112
113
114
115
116
117
118
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 111

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      day_of_week == o.day_of_week &&
      every == o.every &&
      interval == o.interval &&
      week_of_month == o.week_of_month
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



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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 165

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 234

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 142

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


122
123
124
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 122

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



128
129
130
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 128

def hash
  [day_of_week, every, interval, week_of_month].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



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 88

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

  if @interval.nil?
    invalid_properties.push('invalid value for "interval", interval 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



210
211
212
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 210

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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 216

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



204
205
206
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 204

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



103
104
105
106
107
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/report_repeat.rb', line 103

def valid?
  return false if @every.nil?
  return false if @interval.nil?
  true
end