TaskSchedule¶

class oci.data_integration.models.TaskSchedule(**kwargs)¶

Bases: object

A model that holds Schedule and other information required for scheduling a task.

Attributes

`AUTH_MODE_OBO`	A constant which can be used with the auth_mode property of a TaskSchedule.
`AUTH_MODE_RESOURCE_PRINCIPAL`	A constant which can be used with the auth_mode property of a TaskSchedule.
`AUTH_MODE_USER_CERTIFICATE`	A constant which can be used with the auth_mode property of a TaskSchedule.
`EXPECTED_DURATION_UNIT_DAYS`	A constant which can be used with the expected_duration_unit property of a TaskSchedule.
`EXPECTED_DURATION_UNIT_HOURS`	A constant which can be used with the expected_duration_unit property of a TaskSchedule.
`EXPECTED_DURATION_UNIT_MINUTES`	A constant which can be used with the expected_duration_unit property of a TaskSchedule.
`EXPECTED_DURATION_UNIT_SECONDS`	A constant which can be used with the expected_duration_unit property of a TaskSchedule.
`RETRY_DELAY_UNIT_DAYS`	A constant which can be used with the retry_delay_unit property of a TaskSchedule.
`RETRY_DELAY_UNIT_HOURS`	A constant which can be used with the retry_delay_unit property of a TaskSchedule.
`RETRY_DELAY_UNIT_MINUTES`	A constant which can be used with the retry_delay_unit property of a TaskSchedule.
`RETRY_DELAY_UNIT_SECONDS`	A constant which can be used with the retry_delay_unit property of a TaskSchedule.
`auth_mode`	Gets the auth_mode of this TaskSchedule.
`config_provider_delegate`	Gets the config_provider_delegate of this TaskSchedule.
`description`	Gets the description of this TaskSchedule.
`end_time_millis`	Gets the end_time_millis of this TaskSchedule.
`expected_duration`	Gets the expected_duration of this TaskSchedule.
`expected_duration_unit`	Gets the expected_duration_unit of this TaskSchedule.
`identifier`	Gets the identifier of this TaskSchedule.
`is_backfill_enabled`	Gets the is_backfill_enabled of this TaskSchedule.
`is_concurrent_allowed`	Gets the is_concurrent_allowed of this TaskSchedule.
`is_enabled`	Gets the is_enabled of this TaskSchedule.
`key`	Gets the key of this TaskSchedule.
`last_run_details`	Gets the last_run_details of this TaskSchedule.
`metadata`	Gets the metadata of this TaskSchedule.
`model_type`	Gets the model_type of this TaskSchedule.
`model_version`	Gets the model_version of this TaskSchedule.
`name`	Gets the name of this TaskSchedule.
`object_status`	Gets the object_status of this TaskSchedule.
`object_version`	Gets the object_version of this TaskSchedule.
`parent_ref`	Gets the parent_ref of this TaskSchedule.
`retry_attempts`	Gets the retry_attempts of this TaskSchedule.
`retry_delay`	Gets the retry_delay of this TaskSchedule.
`retry_delay_unit`	Gets the retry_delay_unit of this TaskSchedule.
`schedule_ref`	Gets the schedule_ref of this TaskSchedule.
`start_time_millis`	Gets the start_time_millis of this TaskSchedule.

Methods

__init__(**kwargs) Initializes a new TaskSchedule object with values from keyword arguments.

AUTH_MODE_OBO = 'OBO'¶: A constant which can be used with the auth_mode property of a TaskSchedule. This constant has a value of “OBO”

AUTH_MODE_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'¶: A constant which can be used with the auth_mode property of a TaskSchedule. This constant has a value of “RESOURCE_PRINCIPAL”

AUTH_MODE_USER_CERTIFICATE = 'USER_CERTIFICATE'¶: A constant which can be used with the auth_mode property of a TaskSchedule. This constant has a value of “USER_CERTIFICATE”

EXPECTED_DURATION_UNIT_DAYS = 'DAYS'¶: A constant which can be used with the expected_duration_unit property of a TaskSchedule. This constant has a value of “DAYS”

EXPECTED_DURATION_UNIT_HOURS = 'HOURS'¶: A constant which can be used with the expected_duration_unit property of a TaskSchedule. This constant has a value of “HOURS”

EXPECTED_DURATION_UNIT_MINUTES = 'MINUTES'¶: A constant which can be used with the expected_duration_unit property of a TaskSchedule. This constant has a value of “MINUTES”

EXPECTED_DURATION_UNIT_SECONDS = 'SECONDS'¶: A constant which can be used with the expected_duration_unit property of a TaskSchedule. This constant has a value of “SECONDS”

RETRY_DELAY_UNIT_DAYS = 'DAYS'¶: A constant which can be used with the retry_delay_unit property of a TaskSchedule. This constant has a value of “DAYS”

RETRY_DELAY_UNIT_HOURS = 'HOURS'¶: A constant which can be used with the retry_delay_unit property of a TaskSchedule. This constant has a value of “HOURS”

RETRY_DELAY_UNIT_MINUTES = 'MINUTES'¶: A constant which can be used with the retry_delay_unit property of a TaskSchedule. This constant has a value of “MINUTES”

RETRY_DELAY_UNIT_SECONDS = 'SECONDS'¶: A constant which can be used with the retry_delay_unit property of a TaskSchedule. This constant has a value of “SECONDS”

__init__(**kwargs)¶

Initializes a new TaskSchedule 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 TaskSchedule.
model_version (str) – The value to assign to the model_version property of this TaskSchedule.
model_type (str) – The value to assign to the model_type property of this TaskSchedule.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this TaskSchedule.
name (str) – The value to assign to the name property of this TaskSchedule.
description (str) – The value to assign to the description property of this TaskSchedule.
object_version (int) – The value to assign to the object_version property of this TaskSchedule.
object_status (int) – The value to assign to the object_status property of this TaskSchedule.
identifier (str) – The value to assign to the identifier property of this TaskSchedule.
schedule_ref (oci.data_integration.models.Schedule) – The value to assign to the schedule_ref property of this TaskSchedule.
config_provider_delegate (oci.data_integration.models.ConfigProvider) – The value to assign to the config_provider_delegate property of this TaskSchedule.
is_enabled (bool) – The value to assign to the is_enabled property of this TaskSchedule.
retry_attempts (int) – The value to assign to the retry_attempts property of this TaskSchedule.
retry_delay_unit (str) – The value to assign to the retry_delay_unit property of this TaskSchedule. Allowed values for this property are: “SECONDS”, “MINUTES”, “HOURS”, “DAYS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
retry_delay (float) – The value to assign to the retry_delay property of this TaskSchedule.
start_time_millis (int) – The value to assign to the start_time_millis property of this TaskSchedule.
end_time_millis (int) – The value to assign to the end_time_millis property of this TaskSchedule.
is_concurrent_allowed (bool) – The value to assign to the is_concurrent_allowed property of this TaskSchedule.
is_backfill_enabled (bool) – The value to assign to the is_backfill_enabled property of this TaskSchedule.
auth_mode (str) – The value to assign to the auth_mode property of this TaskSchedule. Allowed values for this property are: “OBO”, “RESOURCE_PRINCIPAL”, “USER_CERTIFICATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
expected_duration (float) – The value to assign to the expected_duration property of this TaskSchedule.
expected_duration_unit (str) – The value to assign to the expected_duration_unit property of this TaskSchedule. Allowed values for this property are: “SECONDS”, “MINUTES”, “HOURS”, “DAYS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
last_run_details (oci.data_integration.models.LastRunDetails) – The value to assign to the last_run_details property of this TaskSchedule.
metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this TaskSchedule.

auth_mode¶

Gets the auth_mode of this TaskSchedule. The authorization mode for the task.

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

Returns:	The auth_mode of this TaskSchedule.
Return type:	str

config_provider_delegate¶

Gets the config_provider_delegate of this TaskSchedule.

Returns:	The config_provider_delegate of this TaskSchedule.
Return type:	oci.data_integration.models.ConfigProvider

description¶

Gets the description of this TaskSchedule. Detailed description for the object.

Returns:	The description of this TaskSchedule.
Return type:	str

end_time_millis¶

Gets the end_time_millis of this TaskSchedule. The end time in milliseconds.

Returns:	The end_time_millis of this TaskSchedule.
Return type:	int

expected_duration¶

Gets the expected_duration of this TaskSchedule. The expected duration of the task execution.

Returns:	The expected_duration of this TaskSchedule.
Return type:	float

expected_duration_unit¶

Gets the expected_duration_unit of this TaskSchedule. The expected duration unit of the task execution.

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

Returns:	The expected_duration_unit of this TaskSchedule.
Return type:	str

identifier¶

Gets the identifier of this TaskSchedule. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:	The identifier of this TaskSchedule.
Return type:	str

is_backfill_enabled¶

Gets the is_backfill_enabled of this TaskSchedule. Whether the backfill is enabled

Returns:	The is_backfill_enabled of this TaskSchedule.
Return type:	bool

is_concurrent_allowed¶

Gets the is_concurrent_allowed of this TaskSchedule. Whether the same task can be executed concurrently.

Returns:	The is_concurrent_allowed of this TaskSchedule.
Return type:	bool

is_enabled¶

Gets the is_enabled of this TaskSchedule. Whether the schedule is enabled.

Returns:	The is_enabled of this TaskSchedule.
Return type:	bool

key¶

Gets the key of this TaskSchedule. Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create.

Returns:	The key of this TaskSchedule.
Return type:	str

last_run_details¶

Gets the last_run_details of this TaskSchedule.

Returns:	The last_run_details of this TaskSchedule.
Return type:	oci.data_integration.models.LastRunDetails

metadata¶

Gets the metadata of this TaskSchedule.

Returns:	The metadata of this TaskSchedule.
Return type:	oci.data_integration.models.ObjectMetadata

model_type¶

Gets the model_type of this TaskSchedule. The type of the object.

Returns:	The model_type of this TaskSchedule.
Return type:	str

model_version¶

Gets the model_version of this TaskSchedule. This is a version number that is used by the service to upgrade objects if needed through releases of the service.

Returns:	The model_version of this TaskSchedule.
Return type:	str

name¶

Gets the name of this TaskSchedule. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:	The name of this TaskSchedule.
Return type:	str

object_status¶

Gets the object_status of this TaskSchedule. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:	The object_status of this TaskSchedule.
Return type:	int

object_version¶

Gets the object_version of this TaskSchedule. This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.

Returns:	The object_version of this TaskSchedule.
Return type:	int

parent_ref¶

Gets the parent_ref of this TaskSchedule.

Returns:	The parent_ref of this TaskSchedule.
Return type:	oci.data_integration.models.ParentReference

retry_attempts¶

Gets the retry_attempts of this TaskSchedule. The number of retry attempts.

Returns:	The retry_attempts of this TaskSchedule.
Return type:	int

retry_delay¶

Gets the retry_delay of this TaskSchedule. The retry delay, the unit for measurement is in the property retry delay unit.

Returns:	The retry_delay of this TaskSchedule.
Return type:	float

retry_delay_unit¶

Gets the retry_delay_unit of this TaskSchedule. The unit for the retry delay.

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

Returns:	The retry_delay_unit of this TaskSchedule.
Return type:	str

schedule_ref¶

Gets the schedule_ref of this TaskSchedule.

Returns:	The schedule_ref of this TaskSchedule.
Return type:	oci.data_integration.models.Schedule

start_time_millis¶

Gets the start_time_millis of this TaskSchedule. The start time in milliseconds.

Returns:	The start_time_millis of this TaskSchedule.
Return type:	int