CreateJobDetails

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

Bases: object

Properties used to create a job.

Methods:

__init__(**kwargs)

Initializes a new CreateJobDetails object with values from keyword arguments.

Attributes:

connection_key

Gets the connection_key of this CreateJobDetails.

description

Gets the description of this CreateJobDetails.

display_name

[Required] Gets the display_name of this CreateJobDetails.

job_definition_key

[Required] Gets the job_definition_key of this CreateJobDetails.

schedule_cron_expression

Gets the schedule_cron_expression of this CreateJobDetails.

time_schedule_begin

Gets the time_schedule_begin of this CreateJobDetails.

time_schedule_end

Gets the time_schedule_end of this CreateJobDetails.

__init__(**kwargs)

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

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

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

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

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

  • time_schedule_end (datetime) – The value to assign to the time_schedule_end property of this CreateJobDetails.

  • connection_key (str) – The value to assign to the connection_key property of this CreateJobDetails.

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

property connection_key

Gets the connection_key of this CreateJobDetails. The key of the connection used by the job. This connection will override the default connection specified in the associated job definition. All executions will use this connection.

Returns

The connection_key of this CreateJobDetails.

Return type

str

property description

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

Returns

The description of this CreateJobDetails.

Return type

str

property display_name

[Required] Gets the display_name of this CreateJobDetails. 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 CreateJobDetails.

Return type

str

property job_definition_key

[Required] Gets the job_definition_key of this CreateJobDetails. The unique key of the job definition that defined the scope of this job.

Returns

The job_definition_key of this CreateJobDetails.

Return type

str

property schedule_cron_expression

Gets the schedule_cron_expression of this CreateJobDetails. 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 CreateJobDetails.

Return type

str

property time_schedule_begin

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

Returns

The time_schedule_begin of this CreateJobDetails.

Return type

datetime

property time_schedule_end

Gets the time_schedule_end of this CreateJobDetails. Date that the schedule should end from being operational. An RFC3339 formatted datetime string.

Returns

The time_schedule_end of this CreateJobDetails.

Return type

datetime