Class: Comet::StorjDestinationLocation

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeStorjDestinationLocation

Returns a new instance of StorjDestinationLocation.



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

def initialize
  clear
end

Instance Attribute Details

#apikeyObject

Returns the value of attribute apikey.



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

def apikey
  @apikey
end

#passphraseObject

Returns the value of attribute passphrase.



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

def passphrase
  @passphrase
end

#satellite_addressObject

Returns the value of attribute satellite_address.



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

def satellite_address
  @satellite_address
end

#storj_bucketObject

Returns the value of attribute storj_bucket.



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

def storj_bucket
  @storj_bucket
end

#storj_bucket_prefixObject

Returns the value of attribute storj_bucket_prefix.



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

def storj_bucket_prefix
  @storj_bucket_prefix
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



31
32
33
# File 'lib/comet/models/storj_destination_location.rb', line 31

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



37
38
39
40
41
42
43
44
# File 'lib/comet/models/storj_destination_location.rb', line 37

def clear
  @satellite_address = ''
  @apikey = ''
  @passphrase = ''
  @storj_bucket = ''
  @storj_bucket_prefix = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


54
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
81
82
83
# File 'lib/comet/models/storj_destination_location.rb', line 54

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

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

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

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

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

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


47
48
49
50
51
# File 'lib/comet/models/storj_destination_location.rb', line 47

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



102
103
104
# File 'lib/comet/models/storj_destination_location.rb', line 102

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/comet/models/storj_destination_location.rb', line 86

def to_hash
  ret = {}
  ret['SatelliteAddress'] = @satellite_address
  ret['APIKey'] = @apikey
  ret['Passphrase'] = @passphrase
  ret['StorjBucket'] = @storj_bucket
  unless @storj_bucket_prefix.nil?
    ret['StorjBucketPrefix'] = @storj_bucket_prefix
  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



107
108
109
# File 'lib/comet/models/storj_destination_location.rb', line 107

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