Class: Comet::ImpossibleCloudPartnerTemplateSettings

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

Overview

ImpossibleCloudPartnerTemplateSettings is a typed class wrapper around the underlying Comet Server API data structure. This type is available in Comet 24.3.1 and later.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ImpossibleCloudPartnerTemplateSettings

Returns a new instance of ImpossibleCloudPartnerTemplateSettings.



46
47
48
 
# File 'lib/comet/models/impossible_cloud_partner_template_settings.rb', line 46

def initialize
  clear
end

Instance Attribute Details

#access_key ⇒ Object

Returns the value of attribute access_key.



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

def access_key
  @access_key
end

#object_lock_days ⇒ Object

Returns the value of attribute object_lock_days.



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

def object_lock_days
  @object_lock_days
end

#object_lock_mode ⇒ Object

Control whether the resulting Storage Vaults are configured for Object Lock. One of the OBJECT_LOCK_ constants



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

def object_lock_mode
  @object_lock_mode
end

#region ⇒ Object

Optional. The region for your Partner console and for provisioning new buckets. If blank, uses the default region for Impossible Cloud (eu-central-2).



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

def region
  @region
end

#remove_deleted ⇒ Object

Control whether the “Allow removal of deleted files” checkbox is enabled for Storage Vaults generated from this Storage Template. When configuring a Storage Template from the Comet Server web interface, this field is set automatically for Storage Templates using Object Lock.



41
42
43
 
# File 'lib/comet/models/impossible_cloud_partner_template_settings.rb', line 41

def remove_deleted
  @remove_deleted
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



44
45
46
 
# File 'lib/comet/models/impossible_cloud_partner_template_settings.rb', line 44

def unknown_json_fields
  @unknown_json_fields
end

#use_object_lock__legacy__do_not_use ⇒ Object

Deprecated.

This member has been deprecated since Comet version 23.x.x



26
27
28
 
# File 'lib/comet/models/impossible_cloud_partner_template_settings.rb', line 26

def use_object_lock__legacy__do_not_use
  @use_object_lock__legacy__do_not_use
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @region = ''
  @access_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) 


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
94
95
 
# File 'lib/comet/models/impossible_cloud_partner_template_settings.rb', line 66

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

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

      @access_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) 


59
60
61
62
63
 
# File 'lib/comet/models/impossible_cloud_partner_template_settings.rb', line 59

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



113
114
115
 
# File 'lib/comet/models/impossible_cloud_partner_template_settings.rb', line 113

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



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

def to_hash
  ret = {}
  ret['Region'] = @region
  ret['AccessKey'] = @access_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



118
119
120
 
# File 'lib/comet/models/impossible_cloud_partner_template_settings.rb', line 118

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