Class: Comet::B2DestinationLocation

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ B2DestinationLocation

Returns a new instance of B2DestinationLocation.



37
38
39
 
# File 'lib/comet/models/b2destination_location.rb', line 37

def initialize
  clear
end

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



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

def 
  @account_id
end

#bucket ⇒ Object

Returns the value of attribute bucket.



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

def bucket
  @bucket
end

#hide_deleted_files ⇒ Object

Returns the value of attribute hide_deleted_files.



32
33
34
 
# File 'lib/comet/models/b2destination_location.rb', line 32

def hide_deleted_files
  @hide_deleted_files
end

#key ⇒ Object

Returns the value of attribute key.



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

def key
  @key
end

#max_connections ⇒ Object

Deprecated.

This member has been deprecated since Comet version 21.9.7



29
30
31
 
# File 'lib/comet/models/b2destination_location.rb', line 29

def max_connections
  @max_connections
end

#prefix ⇒ Object

Returns the value of attribute prefix.



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

def prefix
  @prefix
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @account_id = ''
  @key = ''
  @bucket = ''
  @prefix = ''
  @max_connections = 0
  @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
88
89
 
# File 'lib/comet/models/b2destination_location.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 'AccountID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

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

      @max_connections = v
    when 'HideDeletedFiles'
      @hide_deleted_files = 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/b2destination_location.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



119
120
121
 
# File 'lib/comet/models/b2destination_location.rb', line 119

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



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
 
# File 'lib/comet/models/b2destination_location.rb', line 92

def to_hash
  ret = {}
  unless @account_id.nil?
    ret['AccountID'] = @account_id
  end
  unless @key.nil?
    ret['Key'] = @key
  end
  unless @bucket.nil?
    ret['Bucket'] = @bucket
  end
  unless @prefix.nil?
    ret['Prefix'] = @prefix
  end
  unless @max_connections.nil?
    ret['MaxConnections'] = @max_connections
  end
  unless @hide_deleted_files.nil?
    ret['HideDeletedFiles'] = @hide_deleted_files
  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



124
125
126
 
# File 'lib/comet/models/b2destination_location.rb', line 124

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