Class: Comet::ObjectLockStorageTemplateSettings

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ObjectLockStorageTemplateSettings

Returns a new instance of ObjectLockStorageTemplateSettings.



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

def initialize
  clear
end

Instance Attribute Details

#object_lock_days ⇒ Object

Returns the value of attribute object_lock_days.



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

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



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

def object_lock_mode
  @object_lock_mode
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.



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

def remove_deleted
  @remove_deleted
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

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



17
18
19
 
# File 'lib/comet/models/object_lock_storage_template_settings.rb', line 17

def use_object_lock__legacy__do_not_use
  @use_object_lock__legacy__do_not_use
end

Instance Method Details

#clear ⇒ Object 



41
42
43
44
45
 
# File 'lib/comet/models/object_lock_storage_template_settings.rb', line 41

def clear
  @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) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/comet/models/object_lock_storage_template_settings.rb', line 55

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 '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) 


48
49
50
51
52
 
# File 'lib/comet/models/object_lock_storage_template_settings.rb', line 48

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



92
93
94
 
# File 'lib/comet/models/object_lock_storage_template_settings.rb', line 92

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



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/comet/models/object_lock_storage_template_settings.rb', line 79

def to_hash
  ret = {}
  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



97
98
99
 
# File 'lib/comet/models/object_lock_storage_template_settings.rb', line 97

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