Class: Comet::SelfBackupExportOptions

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SelfBackupExportOptions

Returns a new instance of SelfBackupExportOptions.



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

def initialize
  clear
end

Instance Attribute Details

#compression ⇒ Object

One of the COMPRESS_LVL_ constants



27
28
29
 
# File 'lib/comet/models/self_backup_export_options.rb', line 27

def compression
  @compression
end

#encryption_key ⇒ Object

Returns the value of attribute encryption_key.



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

def encryption_key
  @encryption_key
end

#encryption_key_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



23
24
25
 
# File 'lib/comet/models/self_backup_export_options.rb', line 23

def encryption_key_format
  @encryption_key_format
end

#exclude_jobs_db ⇒ Object

The jobs database is often the largest component of the Server Self-Backup archive. By excluding it, you could run the Server Self-Backup more often.



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

def exclude_jobs_db
  @exclude_jobs_db
end

#include_server_logs ⇒ Object

Returns the value of attribute include_server_logs.



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

def include_server_logs
  @include_server_logs
end

#index ⇒ Object

Returns the value of attribute index.



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

def index
  @index
end

#location ⇒ Object

Returns the value of attribute location.



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

def location
  @location
end

#restrict_to_single_org_id ⇒ Object

Returns the value of attribute restrict_to_single_org_id.



38
39
40
 
# File 'lib/comet/models/self_backup_export_options.rb', line 38

def restrict_to_single_org_id
  @restrict_to_single_org_id
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @location = Comet::DestinationLocation.new
  @encryption_key = ''
  @encryption_key_format = 0
  @compression = 0
  @restrict_to_single_org_id = ''
  @index = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
96
97
98
99
100
101
102
103
104
 
# File 'lib/comet/models/self_backup_export_options.rb', line 68

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 'Location'
      @location = Comet::DestinationLocation.new
      @location.from_hash(v)
    when 'EncryptionKey'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

      @compression = v
    when 'ExcludeJobsDB'
      @exclude_jobs_db = v
    when 'IncludeServerLogs'
      @include_server_logs = v
    when 'RestrictToSingleOrgID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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


61
62
63
64
65
 
# File 'lib/comet/models/self_backup_export_options.rb', line 61

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



126
127
128
 
# File 'lib/comet/models/self_backup_export_options.rb', line 126

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/comet/models/self_backup_export_options.rb', line 107

def to_hash
  ret = {}
  ret['Location'] = @location
  ret['EncryptionKey'] = @encryption_key
  ret['EncryptionKeyFormat'] = @encryption_key_format
  ret['Compression'] = @compression
  ret['ExcludeJobsDB'] = @exclude_jobs_db
  ret['IncludeServerLogs'] = @include_server_logs
  unless @restrict_to_single_org_id.nil?
    ret['RestrictToSingleOrgID'] = @restrict_to_single_org_id
  end
  ret['Index'] = @index
  @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



131
132
133
 
# File 'lib/comet/models/self_backup_export_options.rb', line 131

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