JobSummary

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

Bases: object

Details of a job. Jobs are scheduled instances of a job definition.

Attributes:

JOB_TYPE_ASYNC_DELETE

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

JOB_TYPE_ASYNC_EXPORT_DATA_ASSET

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

JOB_TYPE_ASYNC_EXPORT_GLOSSARY

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

JOB_TYPE_CREATE_SCAN_PROXY

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

JOB_TYPE_EXPORT

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

JOB_TYPE_EXPORT_GLOSSARY

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

JOB_TYPE_HARVEST

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

JOB_TYPE_IMMEDIATE

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

JOB_TYPE_IMMEDIATE_EXECUTION

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

JOB_TYPE_IMPORT

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

JOB_TYPE_IMPORT_DATA_ASSET

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

JOB_TYPE_IMPORT_GLOSSARY

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

JOB_TYPE_INTERNAL

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

JOB_TYPE_PREVIEW

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

JOB_TYPE_PROFILING

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

JOB_TYPE_PURGE

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

JOB_TYPE_SAMPLING

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

JOB_TYPE_SCHEDULED

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

JOB_TYPE_SCHEDULED_EXECUTION

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

JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE

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

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_EXPIRED

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

LIFECYCLE_STATE_INACTIVE

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

catalog_id

Gets the catalog_id of this JobSummary.

created_by_id

Gets the created_by_id of this JobSummary.

data_asset_key

Gets the data_asset_key of this JobSummary.

description

Gets the description of this JobSummary.

display_name

Gets the display_name of this JobSummary.

error_code

Gets the error_code of this JobSummary.

error_message

Gets the error_message of this JobSummary.

execution_count

Gets the execution_count of this JobSummary.

executions

Gets the executions of this JobSummary.

glossary_key

Gets the glossary_key of this JobSummary.

job_definition_key

Gets the job_definition_key of this JobSummary.

job_definition_name

Gets the job_definition_name of this JobSummary.

job_type

Gets the job_type of this JobSummary.

key

[Required] Gets the key of this JobSummary.

lifecycle_state

Gets the lifecycle_state of this JobSummary.

schedule_cron_expression

Gets the schedule_cron_expression of this JobSummary.

schedule_type

Gets the schedule_type of this JobSummary.

time_created

Gets the time_created of this JobSummary.

time_of_latest_execution

Gets the time_of_latest_execution of this JobSummary.

time_schedule_begin

Gets the time_schedule_begin of this JobSummary.

time_updated

Gets the time_updated of this JobSummary.

updated_by_id

Gets the updated_by_id of this JobSummary.

uri

Gets the uri of this JobSummary.

Methods:

__init__(**kwargs)

Initializes a new JobSummary 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 JobSummary. 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 JobSummary. 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 JobSummary. 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 JobSummary. 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 JobSummary. 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 JobSummary. 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 JobSummary. This constant has a value of “HARVEST”

JOB_TYPE_IMMEDIATE = 'IMMEDIATE'

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

JOB_TYPE_PREVIEW = 'PREVIEW'

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

JOB_TYPE_PROFILING = 'PROFILING'

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

JOB_TYPE_PURGE = 'PURGE'

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

JOB_TYPE_SAMPLING = 'SAMPLING'

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

JOB_TYPE_SCHEDULED = 'SCHEDULED'

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

LIFECYCLE_STATE_EXPIRED = 'EXPIRED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

__init__(**kwargs)

Initializes a new JobSummary 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 JobSummary.

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

  • display_name (str) – The value to assign to the display_name property of this JobSummary.

  • catalog_id (str) – The value to assign to the catalog_id property of this JobSummary.

  • job_definition_key (str) – The value to assign to the job_definition_key property of this JobSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this JobSummary. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “EXPIRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • job_type (str) – The value to assign to the job_type property of this JobSummary. 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’.

  • schedule_type (str) – The value to assign to the schedule_type property of this JobSummary.

  • description (str) – The value to assign to the description property of this JobSummary.

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

  • time_updated (datetime) – The value to assign to the time_updated property of this JobSummary.

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

  • updated_by_id (str) – The value to assign to the updated_by_id property of this JobSummary.

  • schedule_cron_expression (str) – The value to assign to the schedule_cron_expression property of this JobSummary.

  • time_schedule_begin (datetime) – The value to assign to the time_schedule_begin property of this JobSummary.

  • execution_count (int) – The value to assign to the execution_count property of this JobSummary.

  • time_of_latest_execution (datetime) – The value to assign to the time_of_latest_execution property of this JobSummary.

  • job_definition_name (str) – The value to assign to the job_definition_name property of this JobSummary.

  • data_asset_key (str) – The value to assign to the data_asset_key property of this JobSummary.

  • glossary_key (str) – The value to assign to the glossary_key property of this JobSummary.

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

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

  • executions (list[oci.data_catalog.models.JobExecutionSummary]) – The value to assign to the executions property of this JobSummary.

property catalog_id

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

Returns

The catalog_id of this JobSummary.

Return type

str

property created_by_id

Gets the created_by_id of this JobSummary. OCID of the user who created this job.

Returns

The created_by_id of this JobSummary.

Return type

str

property data_asset_key

Gets the data_asset_key of this JobSummary. Unique key of the data asset to which this job applies, if the job involves a data asset.

Returns

The data_asset_key of this JobSummary.

Return type

str

property description

Gets the description of this JobSummary. Detailed description of the job.

Returns

The description of this JobSummary.

Return type

str

property display_name

Gets the display_name of this JobSummary. 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 JobSummary.

Return type

str

property error_code

Gets the error_code of this JobSummary. Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.

Returns

The error_code of this JobSummary.

Return type

str

property error_message

Gets the error_message of this JobSummary. Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.

Returns

The error_message of this JobSummary.

Return type

str

property execution_count

Gets the execution_count of this JobSummary. The total number of executions for this job schedule.

Returns

The execution_count of this JobSummary.

Return type

int

property executions

Gets the executions of this JobSummary. Array of the executions summary associated with this job.

Returns

The executions of this JobSummary.

Return type

list[oci.data_catalog.models.JobExecutionSummary]

property glossary_key

Gets the glossary_key of this JobSummary. Unique key of the glossary to which this job applies.

Returns

The glossary_key of this JobSummary.

Return type

str

property job_definition_key

Gets the job_definition_key of this JobSummary. The unique key of the job definition resource that defined the scope of this job.

Returns

The job_definition_key of this JobSummary.

Return type

str

property job_definition_name

Gets the job_definition_name of this JobSummary. The display name of the job definition resource that defined the scope of this job.

Returns

The job_definition_name of this JobSummary.

Return type

str

property job_type

Gets the job_type of this JobSummary. Type of the job.

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 JobSummary.

Return type

str

property key

[Required] Gets the key of this JobSummary. Unique key of the job.

Returns

The key of this JobSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this JobSummary. Lifecycle state of the job, such as running, paused, or completed.

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

Returns

The lifecycle_state of this JobSummary.

Return type

str

property schedule_cron_expression

Gets the schedule_cron_expression of this JobSummary. Interval on which the job will be run. Value is specified as a cron-supported time specification “nickname”. The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

Returns

The schedule_cron_expression of this JobSummary.

Return type

str

property schedule_type

Gets the schedule_type of this JobSummary. Type of job schedule that is inferred from the scheduling properties.

Returns

The schedule_type of this JobSummary.

Return type

str

property time_created

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

Returns

The time_created of this JobSummary.

Return type

datetime

property time_of_latest_execution

Gets the time_of_latest_execution of this JobSummary. The date and time of the most recent execution for this job, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns

The time_of_latest_execution of this JobSummary.

Return type

datetime

property time_schedule_begin

Gets the time_schedule_begin of this JobSummary. Date that the schedule should be operational. An RFC3339 formatted datetime string.

Returns

The time_schedule_begin of this JobSummary.

Return type

datetime

property time_updated

Gets the time_updated of this JobSummary. Time that this job was last updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this JobSummary.

Return type

datetime

property updated_by_id

Gets the updated_by_id of this JobSummary. OCID of the user who updated this job.

Returns

The updated_by_id of this JobSummary.

Return type

str

property uri

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

Returns

The uri of this JobSummary.

Return type

str