class Comet::RetentionRange
RetentionRange
is a typed class wrapper around the underlying Comet
Server API data structure.
Attributes
days[RW]
@type [Number] days
jobs[RW]
@type [Number] jobs
month_offset[RW]
@type [Number] month_offset
months[RW]
@type [Number] months
timestamp[RW]
@type [Number] timestamp
type[RW]
@type [Number] type
unknown_json_fields[RW]
@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
week_offset[RW]
@type [Number] week_offset
weeks[RW]
@type [Number] weeks
Public Class Methods
new()
click to toggle source
# File lib/comet/models/retention_range.rb, line 44 def initialize clear end
Public Instance Methods
clear()
click to toggle source
# File lib/comet/models/retention_range.rb, line 48 def clear @type = 0 @timestamp = 0 @jobs = 0 @days = 0 @weeks = 0 @months = 0 @week_offset = 0 @month_offset = 0 @unknown_json_fields = {} end
from_hash(obj)
click to toggle source
@param [Hash] obj The complete object as a Ruby hash
# File lib/comet/models/retention_range.rb, line 68 def from_hash(obj) raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash obj.each do |k, v| case k when 'Type' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @type = v when 'Timestamp' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @timestamp = v when 'Jobs' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @jobs = v when 'Days' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @days = v when 'Weeks' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @weeks = v when 'Months' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @months = v when 'WeekOffset' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @week_offset = v when 'MonthOffset' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @month_offset = v else @unknown_json_fields[k] = v end end end
from_json(json_string)
click to toggle source
@param [String] json_string The complete object in JSON format
# File lib/comet/models/retention_range.rb, line 61 def from_json(json_string) raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String from_hash(JSON.parse(json_string)) end
to_h()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/retention_range.rb, line 129 def to_h to_hash end
to_hash()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/retention_range.rb, line 112 def to_hash ret = {} ret['Type'] = @type ret['Timestamp'] = @timestamp ret['Jobs'] = @jobs ret['Days'] = @days ret['Weeks'] = @weeks ret['Months'] = @months ret['WeekOffset'] = @week_offset ret['MonthOffset'] = @month_offset @unknown_json_fields.each do |k, v| ret[k] = v end ret end
to_json(options = {})
click to toggle source
@return [String] The complete object as a JSON string
# File lib/comet/models/retention_range.rb, line 134 def to_json(options = {}) to_hash.to_json(options) end