Class: Dkron::Job

Inherits:
Object
  • Object
show all
Defined in:
lib/dkron-ruby/models/job.rb

Overview

A Job represents a scheduled task to execute.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Job

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of 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
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/dkron-ruby/models/job.rb', line 136

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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#concurrency ⇒ Object

Concurrency policy for the job allow/forbid



69
70
71
 
# File 'lib/dkron-ruby/models/job.rb', line 69

def concurrency
  @concurrency
end

#dependent_jobs ⇒ Object

Array containing the jobs that depends on this one



64
65
66
 
# File 'lib/dkron-ruby/models/job.rb', line 64

def dependent_jobs
  @dependent_jobs
end

#disabled ⇒ Object

Disabled state of the job



49
50
51
 
# File 'lib/dkron-ruby/models/job.rb', line 49

def disabled
  @disabled
end

#displayname ⇒ Object

Nice name for the job. Optional.



22
23
24
 
# File 'lib/dkron-ruby/models/job.rb', line 22

def displayname
  @displayname
end

#error_count ⇒ Object

Number of failed executions



40
41
42
 
# File 'lib/dkron-ruby/models/job.rb', line 40

def error_count
  @error_count
end

#executor ⇒ Object

Executor plugin used to run the job



72
73
74
 
# File 'lib/dkron-ruby/models/job.rb', line 72

def executor
  @executor
end

#executor_config ⇒ Object

Executor plugin parameters



75
76
77
 
# File 'lib/dkron-ruby/models/job.rb', line 75

def executor_config
  @executor_config
end

#last_error ⇒ Object

Last time this job failed



46
47
48
 
# File 'lib/dkron-ruby/models/job.rb', line 46

def last_error
  @last_error
end

#last_success ⇒ Object

Last time this job executed successfully



43
44
45
 
# File 'lib/dkron-ruby/models/job.rb', line 43

def last_success
  @last_success
end

#metadata ⇒ Object

Extra metadata tags for this job



55
56
57
 
# File 'lib/dkron-ruby/models/job.rb', line 55

def metadata
  @metadata
end

#name ⇒ Object

Name for the job. Use only lower case letters (unicode), digits, underscore and dash.



19
20
21
 
# File 'lib/dkron-ruby/models/job.rb', line 19

def name
  @name
end

#owner ⇒ Object

Owner of the job



31
32
33
 
# File 'lib/dkron-ruby/models/job.rb', line 31

def owner
  @owner
end

#owner_email ⇒ Object

Email of the owner



34
35
36
 
# File 'lib/dkron-ruby/models/job.rb', line 34

def owner_email
  @owner_email
end

#parent_job ⇒ Object

The name/id of the job that will trigger the execution of this job



61
62
63
 
# File 'lib/dkron-ruby/models/job.rb', line 61

def parent_job
  @parent_job
end

#processors ⇒ Object

Returns the value of attribute processors.



66
67
68
 
# File 'lib/dkron-ruby/models/job.rb', line 66

def processors
  @processors
end

#retries ⇒ Object

Number of times to retry a failed job execution



58
59
60
 
# File 'lib/dkron-ruby/models/job.rb', line 58

def retries
  @retries
end

#schedule ⇒ Object

Cron expression for the job.



25
26
27
 
# File 'lib/dkron-ruby/models/job.rb', line 25

def schedule
  @schedule
end

#status ⇒ Object

Status of the job



78
79
80
 
# File 'lib/dkron-ruby/models/job.rb', line 78

def status
  @status
end

#success_count ⇒ Object

Number of successful executions



37
38
39
 
# File 'lib/dkron-ruby/models/job.rb', line 37

def success_count
  @success_count
end

#tags ⇒ Object

Target nodes tags of this job



52
53
54
 
# File 'lib/dkron-ruby/models/job.rb', line 52

def tags
  @tags
end

#timezone ⇒ Object

Timezone where the job will be executed. By default and when field is set to empty string, the job will run in local time.



28
29
30
 
# File 'lib/dkron-ruby/models/job.rb', line 28

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/dkron-ruby/models/job.rb', line 81

def self.attribute_map
  {
    :'name' => :'name',
    :'displayname' => :'displayname',
    :'schedule' => :'schedule',
    :'timezone' => :'timezone',
    :'owner' => :'owner',
    :'owner_email' => :'owner_email',
    :'success_count' => :'success_count',
    :'error_count' => :'error_count',
    :'last_success' => :'last_success',
    :'last_error' => :'last_error',
    :'disabled' => :'disabled',
    :'tags' => :'tags',
    :'metadata' => :'metadata',
    :'retries' => :'retries',
    :'parent_job' => :'parent_job',
    :'dependent_jobs' => :'dependent_jobs',
    :'processors' => :'processors',
    :'concurrency' => :'concurrency',
    :'executor' => :'executor',
    :'executor_config' => :'executor_config',
    :'status' => :'status'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/dkron-ruby/models/job.rb', line 108

def self.swagger_types
  {
    :'name' => :'String',
    :'displayname' => :'String',
    :'schedule' => :'String',
    :'timezone' => :'String',
    :'owner' => :'String',
    :'owner_email' => :'String',
    :'success_count' => :'Integer',
    :'error_count' => :'Integer',
    :'last_success' => :'DateTime',
    :'last_error' => :'DateTime',
    :'disabled' => :'BOOLEAN',
    :'tags' => :'Hash<String, String>',
    :'metadata' => :'Hash<String, String>',
    :'retries' => :'Integer',
    :'parent_job' => :'String',
    :'dependent_jobs' => :'Array<String>',
    :'processors' => :'Processors',
    :'concurrency' => :'String',
    :'executor' => :'String',
    :'executor_config' => :'Hash<String, String>',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/dkron-ruby/models/job.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      displayname == o.displayname &&
      schedule == o.schedule &&
      timezone == o.timezone &&
      owner == o.owner &&
      owner_email == o.owner_email &&
      success_count == o.success_count &&
      error_count == o.error_count &&
      last_success == o.last_success &&
      last_error == o.last_error &&
      disabled == o.disabled &&
      tags == o.tags &&
      metadata == o.metadata &&
      retries == o.retries &&
      parent_job == o.parent_job &&
      dependent_jobs == o.dependent_jobs &&
      processors == o.processors &&
      concurrency == o.concurrency &&
      executor == o.executor &&
      executor_config == o.executor_config &&
      status == o.status
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/dkron-ruby/models/job.rb', line 322

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = Dkron.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/dkron-ruby/models/job.rb', line 388

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/dkron-ruby/models/job.rb', line 301

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


288
289
290
 
# File 'lib/dkron-ruby/models/job.rb', line 288

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



294
295
296
 
# File 'lib/dkron-ruby/models/job.rb', line 294

def hash
  [name, displayname, schedule, timezone, owner, owner_email, success_count, error_count, last_success, last_error, disabled, tags, metadata, retries, parent_job, dependent_jobs, processors, concurrency, executor, executor_config, status].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/dkron-ruby/models/job.rb', line 237

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @schedule.nil?
    invalid_properties.push('invalid value for "schedule", schedule cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



368
369
370
 
# File 'lib/dkron-ruby/models/job.rb', line 368

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



374
375
376
377
378
379
380
381
382
 
# File 'lib/dkron-ruby/models/job.rb', line 374

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



362
363
364
 
# File 'lib/dkron-ruby/models/job.rb', line 362

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



252
253
254
255
256
 
# File 'lib/dkron-ruby/models/job.rb', line 252

def valid?
  return false if @name.nil?
  return false if @schedule.nil?
  true
end