Class: Comet::Office365CustomSettingV2

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

Overview

This type is available in Comet 21.9.xx and later.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Office365CustomSettingV2

Returns a new instance of Office365CustomSettingV2.



54
55
56
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 54

def initialize
  clear
end

Instance Attribute Details

#backup_options ⇒ Object

Key is the ID of User, Group, or Site Value is a bitset of the SERVICE_ constants, to select which services to backup for accounts



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

def backup_options
  @backup_options
end

#filter_member_options ⇒ Object

Key is the ID of a Group or Team Site Value is a bitset of the SERVICE_ constants, to select which services to not backup for members



49
50
51
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 49

def filter_member_options
  @filter_member_options
end

#filter_mode ⇒ Object

If true, exclude all filtered IDs and Members. Backup everything else



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

def filter_mode
  @filter_mode
end

#filter_options ⇒ Object

Key is the ID of a User, Group, or Site Value is a bitset of the SERVICE_ constants, to select which services to not backup for accounts



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

def filter_options
  @filter_options
end

#member_backup_options ⇒ Object

Key is the ID of a Group or Team Site Value is a bitset of the SERVICE_ constants, to select which services to backup for members



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

def member_backup_options
  @member_backup_options
end

#organization ⇒ Object

Deprecated.

This member has been deprecated since Comet version 24.12.2

If true, then backup everything except the selected users (group members are still included)



21
22
23
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 21

def organization
  @organization
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



52
53
54
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 52

def unknown_json_fields
  @unknown_json_fields
end

#whole_org ⇒ Object

If true, backup everything, ignoring selection and filter options



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

def whole_org
  @whole_org
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @backup_options = {}
  @member_backup_options = {}
  @filter_options = {}
  @filter_member_options = {}
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 74

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 'Organization'
      @organization = v
    when 'FilterMode'
      @filter_mode = v
    when 'WholeOrg'
      @whole_org = v
    when 'BackupOptions'
      @backup_options = {}
      if v.nil?
        @backup_options = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @backup_options[k1] = v1
        end
      end
    when 'MemberBackupOptions'
      @member_backup_options = {}
      if v.nil?
        @member_backup_options = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @member_backup_options[k1] = v1
        end
      end
    when 'FilterOptions'
      @filter_options = {}
      if v.nil?
        @filter_options = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @filter_options[k1] = v1
        end
      end
    when 'FilterMemberOptions'
      @filter_member_options = {}
      if v.nil?
        @filter_member_options = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @filter_member_options[k1] = v1
        end
      end
    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) 


67
68
69
70
71
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 67

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



164
165
166
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 164

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 136

def to_hash
  ret = {}
  ret['Organization'] = @organization
  unless @filter_mode.nil?
    ret['FilterMode'] = @filter_mode
  end
  unless @whole_org.nil?
    ret['WholeOrg'] = @whole_org
  end
  unless @backup_options.nil?
    ret['BackupOptions'] = @backup_options
  end
  unless @member_backup_options.nil?
    ret['MemberBackupOptions'] = @member_backup_options
  end
  unless @filter_options.nil?
    ret['FilterOptions'] = @filter_options
  end
  unless @filter_member_options.nil?
    ret['FilterMemberOptions'] = @filter_member_options
  end
  @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



169
170
171
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 169

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