Class: Comet::AmazonAWSVirtualStorageRoleSettings

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeAmazonAWSVirtualStorageRoleSettings

Returns a new instance of AmazonAWSVirtualStorageRoleSettings.



39
40
41
# File 'lib/comet/models/amazon_awsvirtual_storage_role_settings.rb', line 39

def initialize
  clear
end

Instance Attribute Details

#access_keyObject

Returns the value of attribute access_key.



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

def access_key
  @access_key
end

#master_bucketObject

Returns the value of attribute master_bucket.



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

def master_bucket
  @master_bucket
end

#object_lock_daysObject

Returns the value of attribute object_lock_days.



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

def object_lock_days
  @object_lock_days
end

#object_lock_modeObject

Returns the value of attribute object_lock_mode.



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

def object_lock_mode
  @object_lock_mode
end

#remove_deletedObject

Returns the value of attribute remove_deleted.



34
35
36
# File 'lib/comet/models/amazon_awsvirtual_storage_role_settings.rb', line 34

def remove_deleted
  @remove_deleted
end

#secret_keyObject

Returns the value of attribute secret_key.



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

def secret_key
  @secret_key
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#use_object_lock__legacy__do_not_useObject

Returns the value of attribute use_object_lock__legacy__do_not_use.



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

def use_object_lock__legacy__do_not_use
  @use_object_lock__legacy__do_not_use
end

Instance Method Details

#clearObject



43
44
45
46
47
48
49
50
# File 'lib/comet/models/amazon_awsvirtual_storage_role_settings.rb', line 43

def clear
  @master_bucket = ''
  @access_key = ''
  @secret_key = ''
  @object_lock_mode = 0
  @object_lock_days = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


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
90
91
92
93
# File 'lib/comet/models/amazon_awsvirtual_storage_role_settings.rb', line 60

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 '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
    when 'UseObjectLock'
      @use_object_lock__legacy__do_not_use = v
    when 'ObjectLockMode'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

      @object_lock_days = v
    when 'RemoveDeleted'
      @remove_deleted = 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)


53
54
55
56
57
# File 'lib/comet/models/amazon_awsvirtual_storage_role_settings.rb', line 53

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



112
113
114
# File 'lib/comet/models/amazon_awsvirtual_storage_role_settings.rb', line 112

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/comet/models/amazon_awsvirtual_storage_role_settings.rb', line 96

def to_hash
  ret = {}
  ret['MasterBucket'] = @master_bucket
  ret['AccessKey'] = @access_key
  ret['SecretKey'] = @secret_key
  ret['UseObjectLock'] = @use_object_lock__legacy__do_not_use
  ret['ObjectLockMode'] = @object_lock_mode
  ret['ObjectLockDays'] = @object_lock_days
  ret['RemoveDeleted'] = @remove_deleted
  @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



117
118
119
# File 'lib/comet/models/amazon_awsvirtual_storage_role_settings.rb', line 117

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