class Comet::EmailReportConfig
EmailReportConfig
is a typed class wrapper around the underlying Comet
Server API data structure.
Attributes
filter[RW]
@type [Comet::SearchClause] filter
report_type[RW]
@type [Number] report_type
summary_frequency[RW]
@type [Array<Comet::ScheduleConfig>] summary_frequency
unknown_json_fields[RW]
@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
Public Class Methods
new()
click to toggle source
# File lib/comet/models/email_report_config.rb, line 29 def initialize clear end
Public Instance Methods
clear()
click to toggle source
# File lib/comet/models/email_report_config.rb, line 33 def clear @report_type = 0 @summary_frequency = [] @filter = Comet::SearchClause.new @unknown_json_fields = {} end
from_hash(obj)
click to toggle source
@param [Hash] obj The complete object as a Ruby hash
# File lib/comet/models/email_report_config.rb, line 48 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 'ReportType' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @report_type = v when 'SummaryFrequency' if v.nil? @summary_frequency = [] else @summary_frequency = Array.new(v.length) v.each_with_index do |v1, i1| @summary_frequency[i1] = Comet::ScheduleConfig.new @summary_frequency[i1].from_hash(v1) end end when 'Filter' @filter = Comet::SearchClause.new @filter.from_hash(v) else @unknown_json_fields[k] = v end end end
from_json(json_string)
click to toggle source
@param [String] json_string The complete object in JSON format
# File lib/comet/models/email_report_config.rb, line 41 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()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/email_report_config.rb, line 89 def to_h to_hash end
to_hash()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/email_report_config.rb, line 77 def to_hash ret = {} ret['ReportType'] = @report_type ret['SummaryFrequency'] = @summary_frequency ret['Filter'] = @filter @unknown_json_fields.each do |k, v| ret[k] = v end ret end
to_json(options = {})
click to toggle source
@return [String] The complete object as a JSON string
# File lib/comet/models/email_report_config.rb, line 94 def to_json(options = {}) to_hash.to_json(options) end