class Dkron::Job

A Job represents a scheduled task to execute.

Attributes

concurrency[RW]

Concurrency policy for the job allow/forbid

dependent_jobs[RW]

Array containing the jobs that depends on this one

disabled[RW]

Disabled state of the job

displayname[RW]

Nice name for the job. Optional.

error_count[RW]

Number of failed executions

executor[RW]

Executor plugin used to run the job

executor_config[RW]

Executor plugin parameters

last_error[RW]

Last time this job failed

last_success[RW]

Last time this job executed successfully

metadata[RW]

Extra metadata tags for this job

name[RW]

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

owner[RW]

Owner of the job

owner_email[RW]

Email of the owner

parent_job[RW]

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

processors[RW]
retries[RW]

Number of times to retry a failed job execution

schedule[RW]

Cron expression for the job.

status[RW]

Status of the job

success_count[RW]

Number of successful executions

tags[RW]

Target nodes tags of this job

timezone[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# File lib/dkron-rb/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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/dkron-rb/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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/dkron-rb/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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/dkron-rb/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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/dkron-rb/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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/dkron-rb/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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/dkron-rb/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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/dkron-rb/models/job.rb, line 288
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/dkron-rb/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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/dkron-rb/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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/dkron-rb/models/job.rb, line 368
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/dkron-rb/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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/dkron-rb/models/job.rb, line 362
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/dkron-rb/models/job.rb, line 252
def valid?
  return false if @name.nil?
  return false if @schedule.nil?
  true
end