Class: Comet::S3GenericVirtualStorageRole

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeS3GenericVirtualStorageRole

Returns a new instance of S3GenericVirtualStorageRole.



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

def initialize
  clear
end

Instance Attribute Details

#access_keyObject

Returns the value of attribute access_key.



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

def access_key
  @access_key
end

#iamendpointObject

Returns the value of attribute iamendpoint.



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

def iamendpoint
  @iamendpoint
end

#master_bucketObject

Returns the value of attribute master_bucket.



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

def master_bucket
  @master_bucket
end

#s3endpointObject

Returns the value of attribute s3endpoint.



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

def s3endpoint
  @s3endpoint
end

#secret_keyObject

Returns the value of attribute secret_key.



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

def secret_key
  @secret_key
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



31
32
33
# File 'lib/comet/models/s3generic_virtual_storage_role.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/s3generic_virtual_storage_role.rb', line 37

def clear
  @s3endpoint = ''
  @iamendpoint = ''
  @master_bucket = ''
  @access_key = ''
  @secret_key = ''
  @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/s3generic_virtual_storage_role.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 'S3Endpoint'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

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

      @secret_key = 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/s3generic_virtual_storage_role.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



100
101
102
# File 'lib/comet/models/s3generic_virtual_storage_role.rb', line 100

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

def to_hash
  ret = {}
  ret['S3Endpoint'] = @s3endpoint
  ret['IAMEndpoint'] = @iamendpoint
  ret['MasterBucket'] = @master_bucket
  ret['AccessKey'] = @access_key
  ret['SecretKey'] = @secret_key
  @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



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

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