Class: Comet::BrowseVSSResponse

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BrowseVSSResponse

Returns a new instance of BrowseVSSResponse.



28
29
30
 
# File 'lib/comet/models/browse_vssresponse.rb', line 28

def initialize
  clear
end

Instance Attribute Details

#message ⇒ Object

Returns the value of attribute message.



20
21
22
 
# File 'lib/comet/models/browse_vssresponse.rb', line 20

def message
  @message
end

#status ⇒ Object

If the operation was successful, the status will be in the 200-299 range.



17
18
19
 
# File 'lib/comet/models/browse_vssresponse.rb', line 17

def status
  @status
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



26
27
28
 
# File 'lib/comet/models/browse_vssresponse.rb', line 26

def unknown_json_fields
  @unknown_json_fields
end

#vsswriters ⇒ Object

Returns the value of attribute vsswriters.



23
24
25
 
# File 'lib/comet/models/browse_vssresponse.rb', line 23

def vsswriters
  @vsswriters
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @status = 0
  @message = ''
  @vsswriters = {}
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
74
 
# File 'lib/comet/models/browse_vssresponse.rb', line 47

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

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

      @message = v
    when 'VSSWriters'
      @vsswriters = {}
      if v.nil?
        @vsswriters = {}
      else
        v.each do |k1, v1|
          @vsswriters[k1] = Comet::VSSWriterInfo.new
          @vsswriters[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) 


40
41
42
43
44
 
# File 'lib/comet/models/browse_vssresponse.rb', line 40

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



89
90
91
 
# File 'lib/comet/models/browse_vssresponse.rb', line 89

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



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

def to_hash
  ret = {}
  ret['Status'] = @status
  ret['Message'] = @message
  ret['VSSWriters'] = @vsswriters
  @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



94
95
96
 
# File 'lib/comet/models/browse_vssresponse.rb', line 94

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