Class: Comet::MSSQLLoginArgs

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MSSQLLoginArgs

Returns a new instance of MSSQLLoginArgs.



38
39
40
 
# File 'lib/comet/models/mssqllogin_args.rb', line 38

def initialize
  clear
end

Instance Attribute Details

#auth_mode ⇒ Object

Returns the value of attribute auth_mode.



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

def auth_mode
  @auth_mode
end

#instance ⇒ Object

Returns the value of attribute instance.



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

def instance
  @instance
end

#method_is_oledb_32bit ⇒ Object

Returns the value of attribute method_is_oledb_32bit.



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

def method_is_oledb_32bit
  @method_is_oledb_32bit
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#restore_no_recovery ⇒ Object

If this MSSQLLoginArgs structure is used for a restore job (RestoreJobAdvancedOptions) using RESTORETYPE_MSSQL, then, this field controls the RECOVERY / NO RECOVERY option state.



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

def restore_no_recovery
  @restore_no_recovery
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end

Instance Method Details

#clear ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/comet/models/mssqllogin_args.rb', line 42

def clear
  @instance = ''
  @auth_mode = ''
  @username = ''
  @password = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/comet/models/mssqllogin_args.rb', line 58

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

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

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

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

      @password = v
    when 'MethodIsOledb32Bit'
      @method_is_oledb_32bit = v
    when 'RestoreNoRecovery'
      @restore_no_recovery = 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) 


51
52
53
54
55
 
# File 'lib/comet/models/mssqllogin_args.rb', line 51

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



105
106
107
 
# File 'lib/comet/models/mssqllogin_args.rb', line 105

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



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/comet/models/mssqllogin_args.rb', line 90

def to_hash
  ret = {}
  ret['Instance'] = @instance
  ret['AuthMode'] = @auth_mode
  ret['Username'] = @username
  ret['Password'] = @password
  ret['MethodIsOledb32Bit'] = @method_is_oledb_32bit
  ret['RestoreNoRecovery'] = @restore_no_recovery
  @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



110
111
112
 
# File 'lib/comet/models/mssqllogin_args.rb', line 110

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