class OCI::DataCatalog::Models::JobExecution

A job execution is a unit of work being executed on behalf of a job.

Constants

JOB_TYPE_ENUM
LIFECYCLE_STATE_ENUM

Attributes

created_by_id[RW]

OCID of the user who created the job execution. @return [String]

data_entity_key[RW]

The key of the associated data entity resource. @return [String]

error_code[RW]

Error code returned from the job execution or null if job is still running or didn't return an error.

@return [String]

error_message[RW]

Error message returned from the job execution or null if job is still running or didn't return an error.

@return [String]

event_key[RW]

An identifier used for log message correlation.

@return [String]

external_url[RW]

If the job is an external process, then a URL of the job for accessing this resource and its status.

@return [String]

job_key[RW]

The unique key of the parent job. @return [String]

job_type[R]

Type of the job execution. @return [String]

key[RW]

[Required] Unique key of the job execution resource. @return [String]

lifecycle_state[R]

Status of the job execution, such as running, paused, or completed. @return [String]

parent_key[RW]

The unique key of the parent execution or null if this job execution has no parent. @return [String]

process_key[RW]

Process identifier related to the job execution if the job is an external job. @return [String]

properties[RW]

A map of maps that contains the execution context properties which are specific to a job execution. Each job execution may define it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job executions have required properties within the "default" category. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

@return [Hash<String, Hash<String, String>>]

schedule_instance_key[RW]

The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered. @return [String]

sub_type[RW]

Sub-type of this job execution. @return [String]

time_created[RW]

The date and time the job execution was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`

@return [DateTime]

time_ended[RW]

Time that the job execution ended or null if it hasn't yet completed. An [RFC3339](tools.ietf.org/html/rfc3339) formatted datetime string.

@return [DateTime]

time_started[RW]

Time that job execution started. An [RFC3339](tools.ietf.org/html/rfc3339) formatted datetime string. @return [DateTime]

updated_by[RW]

OCID of the user who updated the job execution. @return [String]

uri[RW]

URI to the job execution instance in the API. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_catalog/models/job_execution.rb, line 137
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'job_key': :'jobKey',
    'job_type': :'jobType',
    'sub_type': :'subType',
    'parent_key': :'parentKey',
    'schedule_instance_key': :'scheduleInstanceKey',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'error_code': :'errorCode',
    'error_message': :'errorMessage',
    'process_key': :'processKey',
    'external_url': :'externalUrl',
    'event_key': :'eventKey',
    'data_entity_key': :'dataEntityKey',
    'created_by_id': :'createdById',
    'updated_by': :'updatedBy',
    'uri': :'uri',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key The value to assign to the {#key} property @option attributes [String] :job_key The value to assign to the {#job_key} property @option attributes [String] :job_type The value to assign to the {#job_type} property @option attributes [String] :sub_type The value to assign to the {#sub_type} property @option attributes [String] :parent_key The value to assign to the {#parent_key} property @option attributes [String] :schedule_instance_key The value to assign to the {#schedule_instance_key} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_started The value to assign to the {#time_started} property @option attributes [DateTime] :time_ended The value to assign to the {#time_ended} property @option attributes [String] :error_code The value to assign to the {#error_code} property @option attributes [String] :error_message The value to assign to the {#error_message} property @option attributes [String] :process_key The value to assign to the {#process_key} property @option attributes [String] :external_url The value to assign to the {#external_url} property @option attributes [String] :event_key The value to assign to the {#event_key} property @option attributes [String] :data_entity_key The value to assign to the {#data_entity_key} property @option attributes [String] :created_by_id The value to assign to the {#created_by_id} property @option attributes [String] :updated_by The value to assign to the {#updated_by} property @option attributes [String] :uri The value to assign to the {#uri} property @option attributes [Hash<String, Hash<String, String>>] :properties The value to assign to the {#properties} property

# File lib/oci/data_catalog/models/job_execution.rb, line 218
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 }

  self.key = attributes[:'key'] if attributes[:'key']

  self.job_key = attributes[:'jobKey'] if attributes[:'jobKey']

  raise 'You cannot provide both :jobKey and :job_key' if attributes.key?(:'jobKey') && attributes.key?(:'job_key')

  self.job_key = attributes[:'job_key'] if attributes[:'job_key']

  self.job_type = attributes[:'jobType'] if attributes[:'jobType']

  raise 'You cannot provide both :jobType and :job_type' if attributes.key?(:'jobType') && attributes.key?(:'job_type')

  self.job_type = attributes[:'job_type'] if attributes[:'job_type']

  self.sub_type = attributes[:'subType'] if attributes[:'subType']

  raise 'You cannot provide both :subType and :sub_type' if attributes.key?(:'subType') && attributes.key?(:'sub_type')

  self.sub_type = attributes[:'sub_type'] if attributes[:'sub_type']

  self.parent_key = attributes[:'parentKey'] if attributes[:'parentKey']

  raise 'You cannot provide both :parentKey and :parent_key' if attributes.key?(:'parentKey') && attributes.key?(:'parent_key')

  self.parent_key = attributes[:'parent_key'] if attributes[:'parent_key']

  self.schedule_instance_key = attributes[:'scheduleInstanceKey'] if attributes[:'scheduleInstanceKey']

  raise 'You cannot provide both :scheduleInstanceKey and :schedule_instance_key' if attributes.key?(:'scheduleInstanceKey') && attributes.key?(:'schedule_instance_key')

  self.schedule_instance_key = attributes[:'schedule_instance_key'] if attributes[:'schedule_instance_key']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

  raise 'You cannot provide both :timeStarted and :time_started' if attributes.key?(:'timeStarted') && attributes.key?(:'time_started')

  self.time_started = attributes[:'time_started'] if attributes[:'time_started']

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

  raise 'You cannot provide both :timeEnded and :time_ended' if attributes.key?(:'timeEnded') && attributes.key?(:'time_ended')

  self.time_ended = attributes[:'time_ended'] if attributes[:'time_ended']

  self.error_code = attributes[:'errorCode'] if attributes[:'errorCode']

  raise 'You cannot provide both :errorCode and :error_code' if attributes.key?(:'errorCode') && attributes.key?(:'error_code')

  self.error_code = attributes[:'error_code'] if attributes[:'error_code']

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

  raise 'You cannot provide both :errorMessage and :error_message' if attributes.key?(:'errorMessage') && attributes.key?(:'error_message')

  self.error_message = attributes[:'error_message'] if attributes[:'error_message']

  self.process_key = attributes[:'processKey'] if attributes[:'processKey']

  raise 'You cannot provide both :processKey and :process_key' if attributes.key?(:'processKey') && attributes.key?(:'process_key')

  self.process_key = attributes[:'process_key'] if attributes[:'process_key']

  self.external_url = attributes[:'externalUrl'] if attributes[:'externalUrl']

  raise 'You cannot provide both :externalUrl and :external_url' if attributes.key?(:'externalUrl') && attributes.key?(:'external_url')

  self.external_url = attributes[:'external_url'] if attributes[:'external_url']

  self.event_key = attributes[:'eventKey'] if attributes[:'eventKey']

  raise 'You cannot provide both :eventKey and :event_key' if attributes.key?(:'eventKey') && attributes.key?(:'event_key')

  self.event_key = attributes[:'event_key'] if attributes[:'event_key']

  self.data_entity_key = attributes[:'dataEntityKey'] if attributes[:'dataEntityKey']

  raise 'You cannot provide both :dataEntityKey and :data_entity_key' if attributes.key?(:'dataEntityKey') && attributes.key?(:'data_entity_key')

  self.data_entity_key = attributes[:'data_entity_key'] if attributes[:'data_entity_key']

  self.created_by_id = attributes[:'createdById'] if attributes[:'createdById']

  raise 'You cannot provide both :createdById and :created_by_id' if attributes.key?(:'createdById') && attributes.key?(:'created_by_id')

  self.created_by_id = attributes[:'created_by_id'] if attributes[:'created_by_id']

  self.updated_by = attributes[:'updatedBy'] if attributes[:'updatedBy']

  raise 'You cannot provide both :updatedBy and :updated_by' if attributes.key?(:'updatedBy') && attributes.key?(:'updated_by')

  self.updated_by = attributes[:'updated_by'] if attributes[:'updated_by']

  self.uri = attributes[:'uri'] if attributes[:'uri']

  self.properties = attributes[:'properties'] if attributes[:'properties']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_catalog/models/job_execution.rb, line 165
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'job_key': :'String',
    'job_type': :'String',
    'sub_type': :'String',
    'parent_key': :'String',
    'schedule_instance_key': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'error_code': :'String',
    'error_message': :'String',
    'process_key': :'String',
    'external_url': :'String',
    'event_key': :'String',
    'data_entity_key': :'String',
    'created_by_id': :'String',
    'updated_by': :'String',
    'uri': :'String',
    'properties': :'Hash<String, Hash<String, String>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

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

# File lib/oci/data_catalog/models/job_execution.rb, line 366
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    job_key == other.job_key &&
    job_type == other.job_type &&
    sub_type == other.sub_type &&
    parent_key == other.parent_key &&
    schedule_instance_key == other.schedule_instance_key &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    error_code == other.error_code &&
    error_message == other.error_message &&
    process_key == other.process_key &&
    external_url == other.external_url &&
    event_key == other.event_key &&
    data_entity_key == other.data_entity_key &&
    created_by_id == other.created_by_id &&
    updated_by == other.updated_by &&
    uri == other.uri &&
    properties == other.properties
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/oci/data_catalog/models/job_execution.rb, line 415
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
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) click to toggle source

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

# File lib/oci/data_catalog/models/job_execution.rb, line 395
def eql?(other)
  self == other
end
hash() click to toggle source

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

# File lib/oci/data_catalog/models/job_execution.rb, line 404
def hash
  [key, job_key, job_type, sub_type, parent_key, schedule_instance_key, lifecycle_state, time_created, time_started, time_ended, error_code, error_message, process_key, external_url, event_key, data_entity_key, created_by_id, updated_by, uri, properties].hash
end
job_type=(job_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] job_type Object to be assigned

# File lib/oci/data_catalog/models/job_execution.rb, line 337
def job_type=(job_type)
  # rubocop:disable Style/ConditionalAssignment
  if job_type && !JOB_TYPE_ENUM.include?(job_type)
    OCI.logger.debug("Unknown value for 'job_type' [" + job_type + "]. Mapping to 'JOB_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @job_type = JOB_TYPE_UNKNOWN_ENUM_VALUE
  else
    @job_type = job_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/data_catalog/models/job_execution.rb, line 350
def lifecycle_state=(lifecycle_state)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
    OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_state = lifecycle_state
  end
  # rubocop:enable Style/ConditionalAssignment
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/oci/data_catalog/models/job_execution.rb, line 448
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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/oci/data_catalog/models/job_execution.rb, line 442
def to_s
  to_hash.to_s
end

Private Instance Methods

_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/oci/data_catalog/models/job_execution.rb, line 465
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