Class: Comet::LocalDestinationLocation

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ LocalDestinationLocation

Returns a new instance of LocalDestinationLocation.



35
36
37
 
# File 'lib/comet/models/local_destination_location.rb', line 35

def initialize
  clear
end

Instance Attribute Details

#localcopy_path ⇒ Object

Returns the value of attribute localcopy_path.



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

def localcopy_path
  @localcopy_path
end

#localcopy_win_smbpassword ⇒ Object

If logging in to a Windows network share (SMB/CIFS) is required, enter the password here. The password may be hashed as per the LocalcopyWinSMBPasswordFormat field.



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

def localcopy_win_smbpassword
  @localcopy_win_smbpassword
end

#localcopy_win_smbpassword_format ⇒ Object

One of the PASSWORD_FORMAT_ constants. It controls the hash format of the LocalcopyWinSMBPassword field.



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

def localcopy_win_smbpassword_format
  @localcopy_win_smbpassword_format
end

#localcopy_win_smbusername ⇒ Object

If logging in to a Windows network share (SMB/CIFS) is required, enter the username here.



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

def localcopy_win_smbusername
  @localcopy_win_smbusername
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @localcopy_path = ''
  @localcopy_win_smbusername = ''
  @localcopy_win_smbpassword = ''
  @localcopy_win_smbpassword_format = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/comet/models/local_destination_location.rb', line 55

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

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

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

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

      @localcopy_win_smbpassword_format = 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) 


48
49
50
51
52
 
# File 'lib/comet/models/local_destination_location.rb', line 48

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



96
97
98
 
# File 'lib/comet/models/local_destination_location.rb', line 96

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



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/comet/models/local_destination_location.rb', line 83

def to_hash
  ret = {}
  ret['LocalcopyPath'] = @localcopy_path
  ret['LocalcopyWinSMBUsername'] = @localcopy_win_smbusername
  ret['LocalcopyWinSMBPassword'] = @localcopy_win_smbpassword
  ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
  @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



101
102
103
 
# File 'lib/comet/models/local_destination_location.rb', line 101

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