class Comet::SourceBasicInfo

SourceBasicInfo is a typed class wrapper around the underlying Comet Server API data structure.

Attributes

description[RW]

@type [String] description

override_destination_retention[RW]

@type [Hash{String => Comet::RetentionPolicy}] override_destination_retention

size[RW]

@type [Number] size

unknown_json_fields[RW]

@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations

Public Class Methods

new() click to toggle source
# File lib/comet/models/source_basic_info.rb, line 29
def initialize
  clear
end

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/source_basic_info.rb, line 33
def clear
  @description = ''
  @size = 0
  @override_destination_retention = {}
  @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/source_basic_info.rb, line 48
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 'Description'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @description = v
    when 'Size'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @size = v
    when 'OverrideDestinationRetention'
      @override_destination_retention = {}
      if v.nil?
        @override_destination_retention = {}
      else
        v.each do |k1, v1|
          @override_destination_retention[k1] = Comet::RetentionPolicy.new
          @override_destination_retention[k1].from_hash(v1)
        end
      end
    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/source_basic_info.rb, line 41
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/source_basic_info.rb, line 92
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/source_basic_info.rb, line 78
def to_hash
  ret = {}
  ret['Description'] = @description
  ret['Size'] = @size
  unless @override_destination_retention.nil?
    ret['OverrideDestinationRetention'] = @override_destination_retention
  end
  @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/source_basic_info.rb, line 97
def to_json(options = {})
  to_hash.to_json(options)
end