JobExecution

class oci.data_catalog.models.JobExecution(**kwargs)

Bases: object

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

Attributes:

JOB_TYPE_ASYNC_DELETE

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_ASYNC_EXPORT_DATA_ASSET

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_ASYNC_EXPORT_GLOSSARY

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_CREATE_SCAN_PROXY

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_EXPORT

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_EXPORT_GLOSSARY

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_HARVEST

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_IMMEDIATE

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_IMMEDIATE_EXECUTION

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_IMPORT

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_IMPORT_DATA_ASSET

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_IMPORT_GLOSSARY

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_INTERNAL

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_PREVIEW

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_PROFILING

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_PURGE

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_SAMPLING

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_SCHEDULED

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_SCHEDULED_EXECUTION

A constant which can be used with the job_type property of a JobExecution.

JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE

A constant which can be used with the job_type property of a JobExecution.

LIFECYCLE_STATE_CANCELED

A constant which can be used with the lifecycle_state property of a JobExecution.

LIFECYCLE_STATE_CREATED

A constant which can be used with the lifecycle_state property of a JobExecution.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a JobExecution.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a JobExecution.

LIFECYCLE_STATE_IN_PROGRESS

A constant which can be used with the lifecycle_state property of a JobExecution.

LIFECYCLE_STATE_SUCCEEDED

A constant which can be used with the lifecycle_state property of a JobExecution.

LIFECYCLE_STATE_SUCCEEDED_WITH_WARNINGS

A constant which can be used with the lifecycle_state property of a JobExecution.

created_by_id

Gets the created_by_id of this JobExecution.

data_entity_key

Gets the data_entity_key of this JobExecution.

error_code

Gets the error_code of this JobExecution.

error_message

Gets the error_message of this JobExecution.

event_key

Gets the event_key of this JobExecution.

external_url

Gets the external_url of this JobExecution.

job_key

Gets the job_key of this JobExecution.

job_type

Gets the job_type of this JobExecution.

key

[Required] Gets the key of this JobExecution.

lifecycle_state

Gets the lifecycle_state of this JobExecution.

parent_key

Gets the parent_key of this JobExecution.

process_key

Gets the process_key of this JobExecution.

properties

Gets the properties of this JobExecution.

schedule_instance_key

Gets the schedule_instance_key of this JobExecution.

sub_type

Gets the sub_type of this JobExecution.

time_created

Gets the time_created of this JobExecution.

time_ended

Gets the time_ended of this JobExecution.

time_started

Gets the time_started of this JobExecution.

updated_by

Gets the updated_by of this JobExecution.

uri

Gets the uri of this JobExecution.

Methods:

__init__(**kwargs)

Initializes a new JobExecution object with values from keyword arguments.

JOB_TYPE_ASYNC_DELETE = 'ASYNC_DELETE'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “ASYNC_DELETE”

JOB_TYPE_ASYNC_EXPORT_DATA_ASSET = 'ASYNC_EXPORT_DATA_ASSET'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “ASYNC_EXPORT_DATA_ASSET”

JOB_TYPE_ASYNC_EXPORT_GLOSSARY = 'ASYNC_EXPORT_GLOSSARY'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “ASYNC_EXPORT_GLOSSARY”

JOB_TYPE_CREATE_SCAN_PROXY = 'CREATE_SCAN_PROXY'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “CREATE_SCAN_PROXY”

JOB_TYPE_EXPORT = 'EXPORT'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “EXPORT”

JOB_TYPE_EXPORT_GLOSSARY = 'EXPORT_GLOSSARY'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “EXPORT_GLOSSARY”

JOB_TYPE_HARVEST = 'HARVEST'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “HARVEST”

JOB_TYPE_IMMEDIATE = 'IMMEDIATE'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “IMMEDIATE”

JOB_TYPE_IMMEDIATE_EXECUTION = 'IMMEDIATE_EXECUTION'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “IMMEDIATE_EXECUTION”

JOB_TYPE_IMPORT = 'IMPORT'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “IMPORT”

JOB_TYPE_IMPORT_DATA_ASSET = 'IMPORT_DATA_ASSET'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “IMPORT_DATA_ASSET”

JOB_TYPE_IMPORT_GLOSSARY = 'IMPORT_GLOSSARY'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “IMPORT_GLOSSARY”

JOB_TYPE_INTERNAL = 'INTERNAL'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “INTERNAL”

JOB_TYPE_PREVIEW = 'PREVIEW'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “PREVIEW”

JOB_TYPE_PROFILING = 'PROFILING'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “PROFILING”

JOB_TYPE_PURGE = 'PURGE'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “PURGE”

JOB_TYPE_SAMPLING = 'SAMPLING'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “SAMPLING”

JOB_TYPE_SCHEDULED = 'SCHEDULED'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “SCHEDULED”

JOB_TYPE_SCHEDULED_EXECUTION = 'SCHEDULED_EXECUTION'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “SCHEDULED_EXECUTION”

JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE = 'SCHEDULED_EXECUTION_INSTANCE'

A constant which can be used with the job_type property of a JobExecution. This constant has a value of “SCHEDULED_EXECUTION_INSTANCE”

LIFECYCLE_STATE_CANCELED = 'CANCELED'

A constant which can be used with the lifecycle_state property of a JobExecution. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CREATED = 'CREATED'

A constant which can be used with the lifecycle_state property of a JobExecution. This constant has a value of “CREATED”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a JobExecution. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a JobExecution. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'

A constant which can be used with the lifecycle_state property of a JobExecution. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'

A constant which can be used with the lifecycle_state property of a JobExecution. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_SUCCEEDED_WITH_WARNINGS = 'SUCCEEDED_WITH_WARNINGS'

A constant which can be used with the lifecycle_state property of a JobExecution. This constant has a value of “SUCCEEDED_WITH_WARNINGS”

__init__(**kwargs)

Initializes a new JobExecution object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • key (str) – The value to assign to the key property of this JobExecution.

  • job_key (str) – The value to assign to the job_key property of this JobExecution.

  • job_type (str) – The value to assign to the job_type property of this JobExecution. Allowed values for this property are: “HARVEST”, “PROFILING”, “SAMPLING”, “PREVIEW”, “IMPORT”, “EXPORT”, “IMPORT_GLOSSARY”, “EXPORT_GLOSSARY”, “INTERNAL”, “PURGE”, “IMMEDIATE”, “SCHEDULED”, “IMMEDIATE_EXECUTION”, “SCHEDULED_EXECUTION”, “SCHEDULED_EXECUTION_INSTANCE”, “ASYNC_DELETE”, “IMPORT_DATA_ASSET”, “CREATE_SCAN_PROXY”, “ASYNC_EXPORT_GLOSSARY”, “ASYNC_EXPORT_DATA_ASSET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • sub_type (str) – The value to assign to the sub_type property of this JobExecution.

  • parent_key (str) – The value to assign to the parent_key property of this JobExecution.

  • schedule_instance_key (str) – The value to assign to the schedule_instance_key property of this JobExecution.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this JobExecution. Allowed values for this property are: “CREATED”, “IN_PROGRESS”, “INACTIVE”, “FAILED”, “SUCCEEDED”, “CANCELED”, “SUCCEEDED_WITH_WARNINGS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_created (datetime) – The value to assign to the time_created property of this JobExecution.

  • time_started (datetime) – The value to assign to the time_started property of this JobExecution.

  • time_ended (datetime) – The value to assign to the time_ended property of this JobExecution.

  • error_code (str) – The value to assign to the error_code property of this JobExecution.

  • error_message (str) – The value to assign to the error_message property of this JobExecution.

  • process_key (str) – The value to assign to the process_key property of this JobExecution.

  • external_url (str) – The value to assign to the external_url property of this JobExecution.

  • event_key (str) – The value to assign to the event_key property of this JobExecution.

  • data_entity_key (str) – The value to assign to the data_entity_key property of this JobExecution.

  • created_by_id (str) – The value to assign to the created_by_id property of this JobExecution.

  • updated_by (str) – The value to assign to the updated_by property of this JobExecution.

  • uri (str) – The value to assign to the uri property of this JobExecution.

  • properties (dict(str, dict(str, str))) – The value to assign to the properties property of this JobExecution.

property created_by_id

Gets the created_by_id of this JobExecution. OCID of the user who created the job execution.

Returns

The created_by_id of this JobExecution.

Return type

str

property data_entity_key

Gets the data_entity_key of this JobExecution. The key of the associated data entity resource.

Returns

The data_entity_key of this JobExecution.

Return type

str

property error_code

Gets the error_code of this JobExecution. Error code returned from the job execution or null if job is still running or didn’t return an error.

Returns

The error_code of this JobExecution.

Return type

str

property error_message

Gets the error_message of this JobExecution. Error message returned from the job execution or null if job is still running or didn’t return an error.

Returns

The error_message of this JobExecution.

Return type

str

property event_key

Gets the event_key of this JobExecution. An identifier used for log message correlation.

Returns

The event_key of this JobExecution.

Return type

str

property external_url

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

Returns

The external_url of this JobExecution.

Return type

str

property job_key

Gets the job_key of this JobExecution. The unique key of the parent job.

Returns

The job_key of this JobExecution.

Return type

str

property job_type

Gets the job_type of this JobExecution. Type of the job execution.

Allowed values for this property are: “HARVEST”, “PROFILING”, “SAMPLING”, “PREVIEW”, “IMPORT”, “EXPORT”, “IMPORT_GLOSSARY”, “EXPORT_GLOSSARY”, “INTERNAL”, “PURGE”, “IMMEDIATE”, “SCHEDULED”, “IMMEDIATE_EXECUTION”, “SCHEDULED_EXECUTION”, “SCHEDULED_EXECUTION_INSTANCE”, “ASYNC_DELETE”, “IMPORT_DATA_ASSET”, “CREATE_SCAN_PROXY”, “ASYNC_EXPORT_GLOSSARY”, “ASYNC_EXPORT_DATA_ASSET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The job_type of this JobExecution.

Return type

str

property key

[Required] Gets the key of this JobExecution. Unique key of the job execution resource.

Returns

The key of this JobExecution.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this JobExecution. Status of the job execution, such as running, paused, or completed.

Allowed values for this property are: “CREATED”, “IN_PROGRESS”, “INACTIVE”, “FAILED”, “SUCCEEDED”, “CANCELED”, “SUCCEEDED_WITH_WARNINGS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this JobExecution.

Return type

str

property parent_key

Gets the parent_key of this JobExecution. The unique key of the parent execution or null if this job execution has no parent.

Returns

The parent_key of this JobExecution.

Return type

str

property process_key

Gets the process_key of this JobExecution. Process identifier related to the job execution if the job is an external job.

Returns

The process_key of this JobExecution.

Return type

str

property properties

Gets the properties of this JobExecution. 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”}}}

Returns

The properties of this JobExecution.

Return type

dict(str, dict(str, str))

property schedule_instance_key

Gets the schedule_instance_key of this JobExecution. The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.

Returns

The schedule_instance_key of this JobExecution.

Return type

str

property sub_type

Gets the sub_type of this JobExecution. Sub-type of this job execution.

Returns

The sub_type of this JobExecution.

Return type

str

property time_created

Gets the time_created of this JobExecution. The date and time the job execution was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns

The time_created of this JobExecution.

Return type

datetime

property time_ended

Gets the time_ended of this JobExecution. Time that the job execution ended or null if it hasn’t yet completed. An RFC3339 formatted datetime string.

Returns

The time_ended of this JobExecution.

Return type

datetime

property time_started

Gets the time_started of this JobExecution. Time that job execution started. An RFC3339 formatted datetime string.

Returns

The time_started of this JobExecution.

Return type

datetime

property updated_by

Gets the updated_by of this JobExecution. OCID of the user who updated the job execution.

Returns

The updated_by of this JobExecution.

Return type

str

property uri

Gets the uri of this JobExecution. URI to the job execution instance in the API.

Returns

The uri of this JobExecution.

Return type

str