CreateJobExecutionDetails

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

Bases: object

Properties for creating a new job execution.

Attributes

JOB_TYPE_EXPORT A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_EXPORT_GLOSSARY A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_HARVEST A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_IMMEDIATE A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_IMMEDIATE_EXECUTION A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_IMPORT A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_IMPORT_GLOSSARY A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_INTERNAL A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_PREVIEW A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_PROFILING A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_PURGE A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_SAMPLING A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_SCHEDULED A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_SCHEDULED_EXECUTION A constant which can be used with the job_type property of a CreateJobExecutionDetails.
JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE A constant which can be used with the job_type property of a CreateJobExecutionDetails.
LIFECYCLE_STATE_CANCELED A constant which can be used with the lifecycle_state property of a CreateJobExecutionDetails.
LIFECYCLE_STATE_CREATED A constant which can be used with the lifecycle_state property of a CreateJobExecutionDetails.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a CreateJobExecutionDetails.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a CreateJobExecutionDetails.
LIFECYCLE_STATE_IN_PROGRESS A constant which can be used with the lifecycle_state property of a CreateJobExecutionDetails.
LIFECYCLE_STATE_SUCCEEDED A constant which can be used with the lifecycle_state property of a CreateJobExecutionDetails.
data_entity_key Gets the data_entity_key of this CreateJobExecutionDetails.
error_code Gets the error_code of this CreateJobExecutionDetails.
error_message Gets the error_message of this CreateJobExecutionDetails.
event_key Gets the event_key of this CreateJobExecutionDetails.
external_url Gets the external_url of this CreateJobExecutionDetails.
job_type Gets the job_type of this CreateJobExecutionDetails.
lifecycle_state Gets the lifecycle_state of this CreateJobExecutionDetails.
parent_key Gets the parent_key of this CreateJobExecutionDetails.
process_key Gets the process_key of this CreateJobExecutionDetails.
properties Gets the properties of this CreateJobExecutionDetails.
schedule_instance_key Gets the schedule_instance_key of this CreateJobExecutionDetails.
sub_type Gets the sub_type of this CreateJobExecutionDetails.
time_ended Gets the time_ended of this CreateJobExecutionDetails.
time_started Gets the time_started of this CreateJobExecutionDetails.

Methods

__init__(**kwargs) Initializes a new CreateJobExecutionDetails object with values from keyword arguments.
JOB_TYPE_EXPORT = 'EXPORT'

A constant which can be used with the job_type property of a CreateJobExecutionDetails. 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 CreateJobExecutionDetails. 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 CreateJobExecutionDetails. This constant has a value of “HARVEST”

JOB_TYPE_IMMEDIATE = 'IMMEDIATE'

A constant which can be used with the job_type property of a CreateJobExecutionDetails. 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 CreateJobExecutionDetails. 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 CreateJobExecutionDetails. This constant has a value of “IMPORT”

JOB_TYPE_IMPORT_GLOSSARY = 'IMPORT_GLOSSARY'

A constant which can be used with the job_type property of a CreateJobExecutionDetails. 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 CreateJobExecutionDetails. This constant has a value of “INTERNAL”

JOB_TYPE_PREVIEW = 'PREVIEW'

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

JOB_TYPE_PROFILING = 'PROFILING'

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

JOB_TYPE_PURGE = 'PURGE'

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

JOB_TYPE_SAMPLING = 'SAMPLING'

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

JOB_TYPE_SCHEDULED = 'SCHEDULED'

A constant which can be used with the job_type property of a CreateJobExecutionDetails. 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 CreateJobExecutionDetails. 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 CreateJobExecutionDetails. 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 CreateJobExecutionDetails. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CREATED = 'CREATED'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a CreateJobExecutionDetails. 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 CreateJobExecutionDetails. 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 CreateJobExecutionDetails. This constant has a value of “SUCCEEDED”

__init__(**kwargs)

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

Parameters:
  • sub_type (str) – The value to assign to the sub_type property of this CreateJobExecutionDetails.
  • job_type (str) – The value to assign to the job_type property of this CreateJobExecutionDetails. 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”
  • parent_key (str) – The value to assign to the parent_key property of this CreateJobExecutionDetails.
  • time_started (datetime) – The value to assign to the time_started property of this CreateJobExecutionDetails.
  • time_ended (datetime) – The value to assign to the time_ended property of this CreateJobExecutionDetails.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateJobExecutionDetails. Allowed values for this property are: “CREATED”, “IN_PROGRESS”, “INACTIVE”, “FAILED”, “SUCCEEDED”, “CANCELED”
  • error_code (str) – The value to assign to the error_code property of this CreateJobExecutionDetails.
  • error_message (str) – The value to assign to the error_message property of this CreateJobExecutionDetails.
  • schedule_instance_key (str) – The value to assign to the schedule_instance_key property of this CreateJobExecutionDetails.
  • process_key (str) – The value to assign to the process_key property of this CreateJobExecutionDetails.
  • external_url (str) – The value to assign to the external_url property of this CreateJobExecutionDetails.
  • event_key (str) – The value to assign to the event_key property of this CreateJobExecutionDetails.
  • data_entity_key (str) – The value to assign to the data_entity_key property of this CreateJobExecutionDetails.
  • properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CreateJobExecutionDetails.
data_entity_key

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

Returns:The data_entity_key of this CreateJobExecutionDetails.
Return type:str
error_code

Gets the error_code of this CreateJobExecutionDetails. 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 CreateJobExecutionDetails.
Return type:str
error_message

Gets the error_message of this CreateJobExecutionDetails. 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 CreateJobExecutionDetails.
Return type:str
event_key

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

Returns:The event_key of this CreateJobExecutionDetails.
Return type:str
external_url

Gets the external_url of this CreateJobExecutionDetails. 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 CreateJobExecutionDetails.
Return type:str
job_type

Gets the job_type of this CreateJobExecutionDetails. 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”

Returns:The job_type of this CreateJobExecutionDetails.
Return type:str
lifecycle_state

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

Allowed values for this property are: “CREATED”, “IN_PROGRESS”, “INACTIVE”, “FAILED”, “SUCCEEDED”, “CANCELED”

Returns:The lifecycle_state of this CreateJobExecutionDetails.
Return type:str
parent_key

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

Returns:The parent_key of this CreateJobExecutionDetails.
Return type:str
process_key

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

Returns:The process_key of this CreateJobExecutionDetails.
Return type:str
properties

Gets the properties of this CreateJobExecutionDetails. 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 CreateJobExecutionDetails.
Return type:dict(str, dict(str, str))
schedule_instance_key

Gets the schedule_instance_key of this CreateJobExecutionDetails. 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 CreateJobExecutionDetails.
Return type:str
sub_type

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

Returns:The sub_type of this CreateJobExecutionDetails.
Return type:str
time_ended

Gets the time_ended of this CreateJobExecutionDetails. 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 CreateJobExecutionDetails.
Return type:datetime
time_started

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

Returns:The time_started of this CreateJobExecutionDetails.
Return type:datetime