Class: Comet::SourceConfig

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeSourceConfig

Returns a new instance of SourceConfig.



53
54
55
# File 'lib/comet/models/source_config.rb', line 53

def initialize
  clear
end

Instance Attribute Details

#create_timeObject

Returns the value of attribute create_time.



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

def create_time
  @create_time
end

#descriptionObject

Returns the value of attribute description.



21
22
23
# File 'lib/comet/models/source_config.rb', line 21

def description
  @description
end

#engineObject

Returns the value of attribute engine.



18
19
20
# File 'lib/comet/models/source_config.rb', line 18

def engine
  @engine
end

#engine_propsObject

Returns the value of attribute engine_props.



42
43
44
# File 'lib/comet/models/source_config.rb', line 42

def engine_props
  @engine_props
end

#modify_timeObject

Returns the value of attribute modify_time.



30
31
32
# File 'lib/comet/models/source_config.rb', line 30

def modify_time
  @modify_time
end

#override_destination_retentionObject

Returns the value of attribute override_destination_retention.



45
46
47
# File 'lib/comet/models/source_config.rb', line 45

def override_destination_retention
  @override_destination_retention
end

#owner_deviceObject

Returns the value of attribute owner_device.



24
25
26
# File 'lib/comet/models/source_config.rb', line 24

def owner_device
  @owner_device
end

#post_execObject

Returns the value of attribute post_exec.



39
40
41
# File 'lib/comet/models/source_config.rb', line 39

def post_exec
  @post_exec
end

#pre_execObject

Returns the value of attribute pre_exec.



33
34
35
# File 'lib/comet/models/source_config.rb', line 33

def pre_exec
  @pre_exec
end

#statisticsObject

Returns the value of attribute statistics.



48
49
50
# File 'lib/comet/models/source_config.rb', line 48

def statistics
  @statistics
end

#thaw_execObject

Returns the value of attribute thaw_exec.



36
37
38
# File 'lib/comet/models/source_config.rb', line 36

def thaw_exec
  @thaw_exec
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



51
52
53
# File 'lib/comet/models/source_config.rb', line 51

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/comet/models/source_config.rb', line 57

def clear
  @engine = ''
  @description = ''
  @owner_device = ''
  @create_time = 0
  @modify_time = 0
  @pre_exec = []
  @thaw_exec = []
  @post_exec = []
  @engine_props = {}
  @override_destination_retention = {}
  @statistics = Comet::SourceStatistics.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/comet/models/source_config.rb', line 80

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 'Engine'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @engine = v
    when 'Description'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

      @modify_time = v
    when 'PreExec'
      if v.nil?
        @pre_exec = []
      else
        @pre_exec = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @pre_exec[i1] = v1
        end
      end
    when 'ThawExec'
      if v.nil?
        @thaw_exec = []
      else
        @thaw_exec = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @thaw_exec[i1] = v1
        end
      end
    when 'PostExec'
      if v.nil?
        @post_exec = []
      else
        @post_exec = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @post_exec[i1] = v1
        end
      end
    when 'EngineProps'
      @engine_props = {}
      if v.nil?
        @engine_props = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @engine_props[k1] = v1
        end
      end
    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
    when 'Statistics'
      @statistics = Comet::SourceStatistics.new
      @statistics.from_hash(v)
    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)


73
74
75
76
77
# File 'lib/comet/models/source_config.rb', line 73

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_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



193
194
195
# File 'lib/comet/models/source_config.rb', line 193

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/comet/models/source_config.rb', line 169

def to_hash
  ret = {}
  ret['Engine'] = @engine
  ret['Description'] = @description
  ret['OwnerDevice'] = @owner_device
  ret['CreateTime'] = @create_time
  ret['ModifyTime'] = @modify_time
  ret['PreExec'] = @pre_exec
  ret['ThawExec'] = @thaw_exec
  ret['PostExec'] = @post_exec
  ret['EngineProps'] = @engine_props
  unless @override_destination_retention.nil?
    ret['OverrideDestinationRetention'] = @override_destination_retention
  end
  unless @statistics.nil?
    ret['Statistics'] = @statistics
  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



198
199
200
# File 'lib/comet/models/source_config.rb', line 198

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