class Comet::RetentionRange

the notes on the RETENTIONRANGE_ constants.
The Type field controls which fields of this data type are used. For additional information, see
RetentionRange is a typed class wrapper around the underlying Comet Server API data structure.

def clear

def clear
  @type = 0
  @timestamp = 0
  @jobs = 0
  @days = 0
  @weeks = 0
  @months = 0
  @week_offset = 0
  @month_offset = 0
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • obj (Hash) -- The complete object as a Ruby hash
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

def from_json(json_string)

Parameters:
  • json_string (String) -- The complete object in JSON format
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

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
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

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end