JobDefinition

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

Bases: object

Representation of a job definition resource. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.

Attributes

JOB_EXECUTION_STATE_CANCELED A constant which can be used with the job_execution_state property of a JobDefinition.
JOB_EXECUTION_STATE_CREATED A constant which can be used with the job_execution_state property of a JobDefinition.
JOB_EXECUTION_STATE_FAILED A constant which can be used with the job_execution_state property of a JobDefinition.
JOB_EXECUTION_STATE_INACTIVE A constant which can be used with the job_execution_state property of a JobDefinition.
JOB_EXECUTION_STATE_IN_PROGRESS A constant which can be used with the job_execution_state property of a JobDefinition.
JOB_EXECUTION_STATE_SUCCEEDED A constant which can be used with the job_execution_state property of a JobDefinition.
JOB_EXECUTION_STATE_SUCCEEDED_WITH_WARNINGS A constant which can be used with the job_execution_state property of a JobDefinition.
JOB_TYPE_ASYNC_DELETE A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_EXPORT A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_EXPORT_GLOSSARY A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_HARVEST A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_IMMEDIATE A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_IMMEDIATE_EXECUTION A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_IMPORT A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_IMPORT_GLOSSARY A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_INTERNAL A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_PREVIEW A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_PROFILING A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_PURGE A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_SAMPLING A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_SCHEDULED A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_SCHEDULED_EXECUTION A constant which can be used with the job_type property of a JobDefinition.
JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE A constant which can be used with the job_type property of a JobDefinition.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a JobDefinition.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a JobDefinition.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a JobDefinition.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a JobDefinition.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a JobDefinition.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a JobDefinition.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a JobDefinition.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a JobDefinition.
SCHEDULE_TYPE_IMMEDIATE A constant which can be used with the schedule_type property of a JobDefinition.
SCHEDULE_TYPE_SCHEDULED A constant which can be used with the schedule_type property of a JobDefinition.
catalog_id Gets the catalog_id of this JobDefinition.
connection_key Gets the connection_key of this JobDefinition.
created_by_id Gets the created_by_id of this JobDefinition.
data_asset_key Gets the data_asset_key of this JobDefinition.
description Gets the description of this JobDefinition.
display_name Gets the display_name of this JobDefinition.
internal_version Gets the internal_version of this JobDefinition.
is_incremental Gets the is_incremental of this JobDefinition.
is_sample_data_extracted Gets the is_sample_data_extracted of this JobDefinition.
job_execution_state Gets the job_execution_state of this JobDefinition.
job_type Gets the job_type of this JobDefinition.
key [Required] Gets the key of this JobDefinition.
lifecycle_state Gets the lifecycle_state of this JobDefinition.
properties Gets the properties of this JobDefinition.
sample_data_size_in_mbs Gets the sample_data_size_in_mbs of this JobDefinition.
schedule_type Gets the schedule_type of this JobDefinition.
time_created Gets the time_created of this JobDefinition.
time_latest_execution_ended Gets the time_latest_execution_ended of this JobDefinition.
time_latest_execution_started Gets the time_latest_execution_started of this JobDefinition.
time_updated Gets the time_updated of this JobDefinition.
updated_by_id Gets the updated_by_id of this JobDefinition.
uri Gets the uri of this JobDefinition.

Methods

__init__(**kwargs) Initializes a new JobDefinition object with values from keyword arguments.
JOB_EXECUTION_STATE_CANCELED = 'CANCELED'

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

JOB_EXECUTION_STATE_CREATED = 'CREATED'

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

JOB_EXECUTION_STATE_FAILED = 'FAILED'

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

JOB_EXECUTION_STATE_INACTIVE = 'INACTIVE'

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

JOB_EXECUTION_STATE_IN_PROGRESS = 'IN_PROGRESS'

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

JOB_EXECUTION_STATE_SUCCEEDED = 'SUCCEEDED'

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

JOB_EXECUTION_STATE_SUCCEEDED_WITH_WARNINGS = 'SUCCEEDED_WITH_WARNINGS'

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

JOB_TYPE_ASYNC_DELETE = 'ASYNC_DELETE'

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

JOB_TYPE_EXPORT = 'EXPORT'

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

JOB_TYPE_IMMEDIATE = 'IMMEDIATE'

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

JOB_TYPE_PREVIEW = 'PREVIEW'

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

JOB_TYPE_PROFILING = 'PROFILING'

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

JOB_TYPE_PURGE = 'PURGE'

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

JOB_TYPE_SAMPLING = 'SAMPLING'

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

JOB_TYPE_SCHEDULED = 'SCHEDULED'

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SCHEDULE_TYPE_IMMEDIATE = 'IMMEDIATE'

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

SCHEDULE_TYPE_SCHEDULED = 'SCHEDULED'

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

__init__(**kwargs)

Initializes a new JobDefinition 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 JobDefinition.
  • display_name (str) – The value to assign to the display_name property of this JobDefinition.
  • catalog_id (str) – The value to assign to the catalog_id property of this JobDefinition.
  • job_type (str) – The value to assign to the job_type property of this JobDefinition. 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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • is_incremental (bool) – The value to assign to the is_incremental property of this JobDefinition.
  • data_asset_key (str) – The value to assign to the data_asset_key property of this JobDefinition.
  • description (str) – The value to assign to the description property of this JobDefinition.
  • connection_key (str) – The value to assign to the connection_key property of this JobDefinition.
  • internal_version (str) – The value to assign to the internal_version property of this JobDefinition.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this JobDefinition. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘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 JobDefinition.
  • time_updated (datetime) – The value to assign to the time_updated property of this JobDefinition.
  • created_by_id (str) – The value to assign to the created_by_id property of this JobDefinition.
  • updated_by_id (str) – The value to assign to the updated_by_id property of this JobDefinition.
  • uri (str) – The value to assign to the uri property of this JobDefinition.
  • is_sample_data_extracted (bool) – The value to assign to the is_sample_data_extracted property of this JobDefinition.
  • sample_data_size_in_mbs (int) – The value to assign to the sample_data_size_in_mbs property of this JobDefinition.
  • time_latest_execution_started (datetime) – The value to assign to the time_latest_execution_started property of this JobDefinition.
  • time_latest_execution_ended (datetime) – The value to assign to the time_latest_execution_ended property of this JobDefinition.
  • job_execution_state (str) – The value to assign to the job_execution_state property of this JobDefinition. 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’.
  • schedule_type (str) – The value to assign to the schedule_type property of this JobDefinition. Allowed values for this property are: “SCHEDULED”, “IMMEDIATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • properties (dict(str, dict(str, str))) – The value to assign to the properties property of this JobDefinition.
catalog_id

Gets the catalog_id of this JobDefinition. The data catalog’s OCID.

Returns:The catalog_id of this JobDefinition.
Return type:str
connection_key

Gets the connection_key of this JobDefinition. The key of the default connection resource to be used for harvest, sampling, profiling jobs. This may be overridden in each job instance.

Returns:The connection_key of this JobDefinition.
Return type:str
created_by_id

Gets the created_by_id of this JobDefinition. OCID of the user who created this job definition.

Returns:The created_by_id of this JobDefinition.
Return type:str
data_asset_key

Gets the data_asset_key of this JobDefinition. The key of the data asset for which the job is defined.

Returns:The data_asset_key of this JobDefinition.
Return type:str
description

Gets the description of this JobDefinition. Detailed description of the job definition.

Returns:The description of this JobDefinition.
Return type:str
display_name

Gets the display_name of this JobDefinition. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:The display_name of this JobDefinition.
Return type:str
internal_version

Gets the internal_version of this JobDefinition. Version of the job definition object. Used internally but can be visible to users.

Returns:The internal_version of this JobDefinition.
Return type:str
is_incremental

Gets the is_incremental of this JobDefinition. Specifies if the job definition is incremental or full.

Returns:The is_incremental of this JobDefinition.
Return type:bool
is_sample_data_extracted

Gets the is_sample_data_extracted of this JobDefinition. Specify if sample data to be extracted as part of this harvest.

Returns:The is_sample_data_extracted of this JobDefinition.
Return type:bool
job_execution_state

Gets the job_execution_state of this JobDefinition. Status of the latest 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 job_execution_state of this JobDefinition.
Return type:str
job_type

Gets the job_type of this JobDefinition. Type of the job definition.

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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The job_type of this JobDefinition.
Return type:str
key

[Required] Gets the key of this JobDefinition. Unique key of the job definition resource that is immutable.

Returns:The key of this JobDefinition.
Return type:str
lifecycle_state

Gets the lifecycle_state of this JobDefinition. Lifecycle state of the job definition.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this JobDefinition.
Return type:str
properties

Gets the properties of this JobDefinition. A map of maps that contains the properties which are specific to the job type. Each job type definition 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 definitions have required properties within the “default” category. Example: {“properties”: { “default”: { “host”: “host1”, “port”: “1521”, “database”: “orcl”}}}

Returns:The properties of this JobDefinition.
Return type:dict(str, dict(str, str))
sample_data_size_in_mbs

Gets the sample_data_size_in_mbs of this JobDefinition. Specify the sample data size in MB, specified as number of rows, for this metadata harvest.

Returns:The sample_data_size_in_mbs of this JobDefinition.
Return type:int
schedule_type

Gets the schedule_type of this JobDefinition. Type of job schedule for the latest job executed.

Allowed values for this property are: “SCHEDULED”, “IMMEDIATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The schedule_type of this JobDefinition.
Return type:str
time_created

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

Returns:The time_created of this JobDefinition.
Return type:datetime
time_latest_execution_ended

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

Returns:The time_latest_execution_ended of this JobDefinition.
Return type:datetime
time_latest_execution_started

Gets the time_latest_execution_started of this JobDefinition. Time that the latest job execution started. An RFC3339 formatted datetime string.

Returns:The time_latest_execution_started of this JobDefinition.
Return type:datetime
time_updated

Gets the time_updated of this JobDefinition. The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

Returns:The time_updated of this JobDefinition.
Return type:datetime
updated_by_id

Gets the updated_by_id of this JobDefinition. OCID of the user who updated this job definition.

Returns:The updated_by_id of this JobDefinition.
Return type:str
uri

Gets the uri of this JobDefinition. URI to the job definition instance in the API.

Returns:The uri of this JobDefinition.
Return type:str