TaskScheduleSummary

class oci.data_integration.models.TaskScheduleSummary(**kwargs)

Bases: object

The tsk schedule summary information.

Attributes:

AUTH_MODE_OBO

A constant which can be used with the auth_mode property of a TaskScheduleSummary.

AUTH_MODE_RESOURCE_PRINCIPAL

A constant which can be used with the auth_mode property of a TaskScheduleSummary.

AUTH_MODE_USER_CERTIFICATE

A constant which can be used with the auth_mode property of a TaskScheduleSummary.

EXPECTED_DURATION_UNIT_DAYS

A constant which can be used with the expected_duration_unit property of a TaskScheduleSummary.

EXPECTED_DURATION_UNIT_HOURS

A constant which can be used with the expected_duration_unit property of a TaskScheduleSummary.

EXPECTED_DURATION_UNIT_MINUTES

A constant which can be used with the expected_duration_unit property of a TaskScheduleSummary.

EXPECTED_DURATION_UNIT_SECONDS

A constant which can be used with the expected_duration_unit property of a TaskScheduleSummary.

RETRY_DELAY_UNIT_DAYS

A constant which can be used with the retry_delay_unit property of a TaskScheduleSummary.

RETRY_DELAY_UNIT_HOURS

A constant which can be used with the retry_delay_unit property of a TaskScheduleSummary.

RETRY_DELAY_UNIT_MINUTES

A constant which can be used with the retry_delay_unit property of a TaskScheduleSummary.

RETRY_DELAY_UNIT_SECONDS

A constant which can be used with the retry_delay_unit property of a TaskScheduleSummary.

auth_mode

Gets the auth_mode of this TaskScheduleSummary.

config_provider_delegate

Gets the config_provider_delegate of this TaskScheduleSummary.

description

Gets the description of this TaskScheduleSummary.

end_time_millis

Gets the end_time_millis of this TaskScheduleSummary.

expected_duration

Gets the expected_duration of this TaskScheduleSummary.

expected_duration_unit

Gets the expected_duration_unit of this TaskScheduleSummary.

identifier

Gets the identifier of this TaskScheduleSummary.

is_backfill_enabled

Gets the is_backfill_enabled of this TaskScheduleSummary.

is_concurrent_allowed

Gets the is_concurrent_allowed of this TaskScheduleSummary.

is_enabled

Gets the is_enabled of this TaskScheduleSummary.

key

Gets the key of this TaskScheduleSummary.

last_run_details

Gets the last_run_details of this TaskScheduleSummary.

metadata

Gets the metadata of this TaskScheduleSummary.

model_type

Gets the model_type of this TaskScheduleSummary.

model_version

Gets the model_version of this TaskScheduleSummary.

name

Gets the name of this TaskScheduleSummary.

next_run_time_millis

Gets the next_run_time_millis of this TaskScheduleSummary.

number_of_retries

Gets the number_of_retries of this TaskScheduleSummary.

object_status

Gets the object_status of this TaskScheduleSummary.

object_version

Gets the object_version of this TaskScheduleSummary.

parent_ref

Gets the parent_ref of this TaskScheduleSummary.

retry_delay

Gets the retry_delay of this TaskScheduleSummary.

retry_delay_unit

Gets the retry_delay_unit of this TaskScheduleSummary.

schedule_ref

Gets the schedule_ref of this TaskScheduleSummary.

start_time_millis

Gets the start_time_millis of this TaskScheduleSummary.

Methods:

__init__(**kwargs)

Initializes a new TaskScheduleSummary object with values from keyword arguments.

AUTH_MODE_OBO = 'OBO'

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

__init__(**kwargs)

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

  • model_version (str) – The value to assign to the model_version property of this TaskScheduleSummary.

  • model_type (str) – The value to assign to the model_type property of this TaskScheduleSummary.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this TaskScheduleSummary.

  • name (str) – The value to assign to the name property of this TaskScheduleSummary.

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

  • object_version (int) – The value to assign to the object_version property of this TaskScheduleSummary.

  • object_status (int) – The value to assign to the object_status property of this TaskScheduleSummary.

  • identifier (str) – The value to assign to the identifier property of this TaskScheduleSummary.

  • schedule_ref (oci.data_integration.models.Schedule) – The value to assign to the schedule_ref property of this TaskScheduleSummary.

  • config_provider_delegate (oci.data_integration.models.ConfigProvider) – The value to assign to the config_provider_delegate property of this TaskScheduleSummary.

  • is_enabled (bool) – The value to assign to the is_enabled property of this TaskScheduleSummary.

  • number_of_retries (int) – The value to assign to the number_of_retries property of this TaskScheduleSummary.

  • retry_delay (float) – The value to assign to the retry_delay property of this TaskScheduleSummary.

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

  • start_time_millis (int) – The value to assign to the start_time_millis property of this TaskScheduleSummary.

  • end_time_millis (int) – The value to assign to the end_time_millis property of this TaskScheduleSummary.

  • is_concurrent_allowed (bool) – The value to assign to the is_concurrent_allowed property of this TaskScheduleSummary.

  • is_backfill_enabled (bool) – The value to assign to the is_backfill_enabled property of this TaskScheduleSummary.

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

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

  • next_run_time_millis (int) – The value to assign to the next_run_time_millis property of this TaskScheduleSummary.

  • last_run_details (oci.data_integration.models.LastRunDetails) – The value to assign to the last_run_details property of this TaskScheduleSummary.

  • metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this TaskScheduleSummary.

property auth_mode

Gets the auth_mode of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

str

property config_provider_delegate

Gets the config_provider_delegate of this TaskScheduleSummary.

Returns

The config_provider_delegate of this TaskScheduleSummary.

Return type

oci.data_integration.models.ConfigProvider

property description

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

Returns

The description of this TaskScheduleSummary.

Return type

str

property end_time_millis

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

Returns

The end_time_millis of this TaskScheduleSummary.

Return type

int

property expected_duration

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

Returns

The expected_duration of this TaskScheduleSummary.

Return type

float

property expected_duration_unit

Gets the expected_duration_unit of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

str

property identifier

Gets the identifier of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

str

property is_backfill_enabled

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

Returns

The is_backfill_enabled of this TaskScheduleSummary.

Return type

bool

property is_concurrent_allowed

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

Returns

The is_concurrent_allowed of this TaskScheduleSummary.

Return type

bool

property is_enabled

Gets the is_enabled of this TaskScheduleSummary. Whether the task schedule is enabled.

Returns

The is_enabled of this TaskScheduleSummary.

Return type

bool

property key

Gets the key of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

str

property last_run_details

Gets the last_run_details of this TaskScheduleSummary.

Returns

The last_run_details of this TaskScheduleSummary.

Return type

oci.data_integration.models.LastRunDetails

property metadata

Gets the metadata of this TaskScheduleSummary.

Returns

The metadata of this TaskScheduleSummary.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

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

Returns

The model_type of this TaskScheduleSummary.

Return type

str

property model_version

Gets the model_version of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

str

property name

Gets the name of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

str

property next_run_time_millis

Gets the next_run_time_millis of this TaskScheduleSummary. The time for next run in milliseconds.

Returns

The next_run_time_millis of this TaskScheduleSummary.

Return type

int

property number_of_retries

Gets the number_of_retries of this TaskScheduleSummary. The number of retries.

Returns

The number_of_retries of this TaskScheduleSummary.

Return type

int

property object_status

Gets the object_status of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

int

property object_version

Gets the object_version of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

int

property parent_ref

Gets the parent_ref of this TaskScheduleSummary.

Returns

The parent_ref of this TaskScheduleSummary.

Return type

oci.data_integration.models.ParentReference

property retry_delay

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

Returns

The retry_delay of this TaskScheduleSummary.

Return type

float

property retry_delay_unit

Gets the retry_delay_unit of this TaskScheduleSummary. 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 TaskScheduleSummary.

Return type

str

property schedule_ref

Gets the schedule_ref of this TaskScheduleSummary.

Returns

The schedule_ref of this TaskScheduleSummary.

Return type

oci.data_integration.models.Schedule

property start_time_millis

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

Returns

The start_time_millis of this TaskScheduleSummary.

Return type

int