JobDefinitionSummary

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

Bases: object

A list of job definition resources. 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 JobDefinitionSummary.
JOB_EXECUTION_STATE_CREATED A constant which can be used with the job_execution_state property of a JobDefinitionSummary.
JOB_EXECUTION_STATE_FAILED A constant which can be used with the job_execution_state property of a JobDefinitionSummary.
JOB_EXECUTION_STATE_INACTIVE A constant which can be used with the job_execution_state property of a JobDefinitionSummary.
JOB_EXECUTION_STATE_IN_PROGRESS A constant which can be used with the job_execution_state property of a JobDefinitionSummary.
JOB_EXECUTION_STATE_SUCCEEDED A constant which can be used with the job_execution_state property of a JobDefinitionSummary.
JOB_EXECUTION_STATE_SUCCEEDED_WITH_WARNINGS A constant which can be used with the job_execution_state property of a JobDefinitionSummary.
JOB_TYPE_ASYNC_DELETE A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_EXPORT A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_EXPORT_GLOSSARY A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_HARVEST A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_IMMEDIATE A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_IMMEDIATE_EXECUTION A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_IMPORT A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_IMPORT_GLOSSARY A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_INTERNAL A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_PREVIEW A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_PROFILING A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_PURGE A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_SAMPLING A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_SCHEDULED A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_SCHEDULED_EXECUTION A constant which can be used with the job_type property of a JobDefinitionSummary.
JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE A constant which can be used with the job_type property of a JobDefinitionSummary.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a JobDefinitionSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a JobDefinitionSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a JobDefinitionSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a JobDefinitionSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a JobDefinitionSummary.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a JobDefinitionSummary.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a JobDefinitionSummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a JobDefinitionSummary.
SCHEDULE_TYPE_IMMEDIATE A constant which can be used with the schedule_type property of a JobDefinitionSummary.
SCHEDULE_TYPE_SCHEDULED A constant which can be used with the schedule_type property of a JobDefinitionSummary.
catalog_id Gets the catalog_id of this JobDefinitionSummary.
connection_key Gets the connection_key of this JobDefinitionSummary.
description Gets the description of this JobDefinitionSummary.
display_name Gets the display_name of this JobDefinitionSummary.
is_sample_data_extracted Gets the is_sample_data_extracted of this JobDefinitionSummary.
job_execution_state Gets the job_execution_state of this JobDefinitionSummary.
job_type Gets the job_type of this JobDefinitionSummary.
key [Required] Gets the key of this JobDefinitionSummary.
lifecycle_state Gets the lifecycle_state of this JobDefinitionSummary.
schedule_type Gets the schedule_type of this JobDefinitionSummary.
time_created Gets the time_created of this JobDefinitionSummary.
time_latest_execution_ended Gets the time_latest_execution_ended of this JobDefinitionSummary.
time_latest_execution_started Gets the time_latest_execution_started of this JobDefinitionSummary.
uri Gets the uri of this JobDefinitionSummary.

Methods

__init__(**kwargs) Initializes a new JobDefinitionSummary 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. 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 JobDefinitionSummary. This constant has a value of “HARVEST”

JOB_TYPE_IMMEDIATE = 'IMMEDIATE'

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

JOB_TYPE_PREVIEW = 'PREVIEW'

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

JOB_TYPE_PROFILING = 'PROFILING'

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

JOB_TYPE_PURGE = 'PURGE'

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

JOB_TYPE_SAMPLING = 'SAMPLING'

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

JOB_TYPE_SCHEDULED = 'SCHEDULED'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SCHEDULE_TYPE_IMMEDIATE = 'IMMEDIATE'

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

SCHEDULE_TYPE_SCHEDULED = 'SCHEDULED'

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

__init__(**kwargs)

Initializes a new JobDefinitionSummary 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 JobDefinitionSummary.
  • display_name (str) – The value to assign to the display_name property of this JobDefinitionSummary.
  • description (str) – The value to assign to the description property of this JobDefinitionSummary.
  • catalog_id (str) – The value to assign to the catalog_id property of this JobDefinitionSummary.
  • uri (str) – The value to assign to the uri property of this JobDefinitionSummary.
  • job_type (str) – The value to assign to the job_type property of this JobDefinitionSummary. 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’.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this JobDefinitionSummary. 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’.
  • is_sample_data_extracted (bool) – The value to assign to the is_sample_data_extracted property of this JobDefinitionSummary.
  • time_created (datetime) – The value to assign to the time_created property of this JobDefinitionSummary.
  • connection_key (str) – The value to assign to the connection_key property of this JobDefinitionSummary.
  • time_latest_execution_started (datetime) – The value to assign to the time_latest_execution_started property of this JobDefinitionSummary.
  • time_latest_execution_ended (datetime) – The value to assign to the time_latest_execution_ended property of this JobDefinitionSummary.
  • job_execution_state (str) – The value to assign to the job_execution_state property of this JobDefinitionSummary. 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 JobDefinitionSummary. 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’.
catalog_id

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

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

Gets the connection_key of this JobDefinitionSummary. The key of the connection resource used in harvest, sampling, profiling jobs.

Returns:The connection_key of this JobDefinitionSummary.
Return type:str
description

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

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

Gets the display_name of this JobDefinitionSummary. 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 JobDefinitionSummary.
Return type:str
is_sample_data_extracted

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

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

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

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

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

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

Gets the lifecycle_state of this JobDefinitionSummary. 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 JobDefinitionSummary.
Return type:str
schedule_type

Gets the schedule_type of this JobDefinitionSummary. 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 JobDefinitionSummary.
Return type:str
time_created

Gets the time_created of this JobDefinitionSummary. 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 JobDefinitionSummary.
Return type:datetime
time_latest_execution_ended

Gets the time_latest_execution_ended of this JobDefinitionSummary. 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 JobDefinitionSummary.
Return type:datetime
time_latest_execution_started

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

Returns:The time_latest_execution_started of this JobDefinitionSummary.
Return type:datetime
uri

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

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