Class: PureCloud::ReportSchedule

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/report_schedule.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportSchedule

Initializes the object



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 111

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'quartzCronExpression')
    self.quartz_cron_expression = attributes[:'quartzCronExpression']
  end

  if attributes.has_key?(:'nextFireTime')
    self.next_fire_time = attributes[:'nextFireTime']
  end

  if attributes.has_key?(:'dateCreated')
    self.date_created = attributes[:'dateCreated']
  end

  if attributes.has_key?(:'dateModified')
    self.date_modified = attributes[:'dateModified']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'timeZone')
    self.time_zone = attributes[:'timeZone']
  end

  if attributes.has_key?(:'timePeriod')
    self.time_period = attributes[:'timePeriod']
  end

  if attributes.has_key?(:'interval')
    self.interval = attributes[:'interval']
  end

  if attributes.has_key?(:'reportFormat')
    self.report_format = attributes[:'reportFormat']
  end

  if attributes.has_key?(:'locale')
    self.locale = attributes[:'locale']
  end

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  end

  if attributes.has_key?(:'reportId')
    self.report_id = attributes[:'reportId']
  end

  if attributes.has_key?(:'parameters')
    if (value = attributes[:'parameters']).is_a?(Array)
      self.parameters = value
    end
  end

  if attributes.has_key?(:'lastRun')
    self.last_run = attributes[:'lastRun']
  end

  if attributes.has_key?(:'selfUri')
    self.self_uri = attributes[:'selfUri']
  end

end

Instance Attribute Details

#date_created ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 33

def date_created
  @date_created
end

#date_modified ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 36

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 38

def description
  @description
end

#enabled ⇒ Object

Returns the value of attribute enabled.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 51

def enabled
  @enabled
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 22

def id
  @id
end

#interval ⇒ Object

Interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 45

def interval
  @interval
end

#last_run ⇒ Object

Returns the value of attribute last_run.



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 58

def last_run
  @last_run
end

#locale ⇒ Object

Returns the value of attribute locale.



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 49

def locale
  @locale
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 24

def name
  @name
end

#next_fire_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 30

def next_fire_time
  @next_fire_time
end

#parameters ⇒ Object

Returns the value of attribute parameters.



56
57
58
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 56

def parameters
  @parameters
end

#quartz_cron_expression ⇒ Object

Quartz Cron Expression



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 27

def quartz_cron_expression
  @quartz_cron_expression
end

#report_format ⇒ Object

Returns the value of attribute report_format.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 47

def report_format
  @report_format
end

#report_id ⇒ Object

Report ID



54
55
56
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 54

def report_id
  @report_id
end

#self_uri ⇒ Object

The URI for this object



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 61

def self_uri
  @self_uri
end

#time_period ⇒ Object

Returns the value of attribute time_period.



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 42

def time_period
  @time_period
end

#time_zone ⇒ Object

Returns the value of attribute time_zone.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 40

def time_zone
  @time_zone
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'quartz_cron_expression' => :'quartzCronExpression',
    :'next_fire_time' => :'nextFireTime',
    :'date_created' => :'dateCreated',
    :'date_modified' => :'dateModified',
    :'description' => :'description',
    :'time_zone' => :'timeZone',
    :'time_period' => :'timePeriod',
    :'interval' => :'interval',
    :'report_format' => :'reportFormat',
    :'locale' => :'locale',
    :'enabled' => :'enabled',
    :'report_id' => :'reportId',
    :'parameters' => :'parameters',
    :'last_run' => :'lastRun',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 87

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'quartz_cron_expression' => :'String',
    :'next_fire_time' => :'DateTime',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'description' => :'String',
    :'time_zone' => :'String',
    :'time_period' => :'String',
    :'interval' => :'String',
    :'report_format' => :'String',
    :'locale' => :'String',
    :'enabled' => :'BOOLEAN',
    :'report_id' => :'String',
    :'parameters' => :'Hash<String, Object>',
    :'last_run' => :'ReportRunEntry',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      quartz_cron_expression == o.quartz_cron_expression &&
      next_fire_time == o.next_fire_time &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      description == o.description &&
      time_zone == o.time_zone &&
      time_period == o.time_period &&
      interval == o.interval &&
      report_format == o.report_format &&
      locale == o.locale &&
      enabled == o.enabled &&
      report_id == o.report_id &&
      parameters == o.parameters &&
      last_run == o.last_run &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 265

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 325

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 246

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


235
236
237
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



241
242
243
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 241

def hash
  [id, name, quartz_cron_expression, next_fire_time, date_created, date_modified, description, time_zone, time_period, interval, report_format, locale, enabled, report_id, parameters, last_run, self_uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



191
192
193
194
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 191

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



308
309
310
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 308

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



313
314
315
316
317
318
319
320
321
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 313

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



303
304
305
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 303

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/purecloudplatformclientv2/models/report_schedule.rb', line 198

def valid?
  if @quartz_cron_expression.nil?
    return false
  end

  if @report_id.nil?
    return false
  end

end