Class: Comet::SourceBasicInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/source_basic_info.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SourceBasicInfo

Returns a new instance of SourceBasicInfo.



27
28
29
 
# File 'lib/comet/models/source_basic_info.rb', line 27

def initialize
  clear
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



16
17
18
 
# File 'lib/comet/models/source_basic_info.rb', line 16

def description
  @description
end

#override_destination_retention ⇒ Object

Returns the value of attribute override_destination_retention.



22
23
24
 
# File 'lib/comet/models/source_basic_info.rb', line 22

def override_destination_retention
  @override_destination_retention
end

#size ⇒ Object

Returns the value of attribute size.



19
20
21
 
# File 'lib/comet/models/source_basic_info.rb', line 19

def size
  @size
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



25
26
27
 
# File 'lib/comet/models/source_basic_info.rb', line 25

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/comet/models/source_basic_info.rb', line 31

def clear
  @description = ''
  @size = 0
  @override_destination_retention = {}
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/comet/models/source_basic_info.rb', line 46

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) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


39
40
41
42
43
 
# File 'lib/comet/models/source_basic_info.rb', line 39

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 ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



90
91
92
 
# File 'lib/comet/models/source_basic_info.rb', line 90

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/comet/models/source_basic_info.rb', line 76

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 = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



95
96
97
 
# File 'lib/comet/models/source_basic_info.rb', line 95

def to_json(options = {})
  to_hash.to_json(options)
end