Class: Comet::ExtraFileExclusion

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ExtraFileExclusion

Returns a new instance of ExtraFileExclusion.



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

def initialize
  clear
end

Instance Attribute Details

#exclude ⇒ Object

The glob or regular expression to exclude from backup jobs



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

def exclude
  @exclude
end

#regex ⇒ Object

Choose whether the ‘Exclude’ parameter will be treated as a regular expression (true) or a glob (false)



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

def regex
  @regex
end

#restrict_os ⇒ Object

Either OS_ANY or one of the OS_ONLY constants



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

def restrict_os
  @restrict_os
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



29
30
31
 
# File 'lib/comet/models/extra_file_exclusion.rb', line 29

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



35
36
37
38
39
 
# File 'lib/comet/models/extra_file_exclusion.rb', line 35

def clear
  @exclude = ''
  @restrict_os = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/comet/models/extra_file_exclusion.rb', line 49

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

      @exclude = v
    when 'Regex'
      @regex = v
    when 'RestrictOS'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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


42
43
44
45
46
 
# File 'lib/comet/models/extra_file_exclusion.rb', line 42

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



83
84
85
 
# File 'lib/comet/models/extra_file_exclusion.rb', line 83

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



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/comet/models/extra_file_exclusion.rb', line 71

def to_hash
  ret = {}
  ret['Exclude'] = @exclude
  ret['Regex'] = @regex
  ret['RestrictOS'] = @restrict_os
  @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



88
89
90
 
# File 'lib/comet/models/extra_file_exclusion.rb', line 88

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