Share via

Schedule Class

Schedule model.

Constructor

Schedule(*args: Any, **kwargs: Any)

Variables

Name Description
id
str

Identifier of the schedule. Required.
display_name
str

Name of the schedule.
description
str

Description of the schedule.
enabled
bool

Enabled status of the schedule. Required.
provisioning_status
str or ScheduleProvisioningStatus

Provisioning status of the schedule. Known values are: "Creating", "Updating", "Deleting", "Succeeded", and "Failed".
trigger
Trigger

Trigger for the schedule. Required.
task
ScheduleTask

Task for the schedule. Required.
tags
dict[str, str]

Schedule's tags. Unlike properties, tags are fully mutable.
properties
dict[str, str]

Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
system_data
dict[str, str]

System metadata for the resource. Required.

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from D.
copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy 

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on D's values

Attributes

description

Description of the schedule.

description: str | None

display_name

Name of the schedule.

display_name: str | None

enabled

Enabled status of the schedule. Required.

enabled: bool

id

Identifier of the schedule. Required.

id: str

properties

Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

properties: dict[str, str] | None

provisioning_status

"Creating", "Updating", "Deleting", "Succeeded", and "Failed".

provisioning_status: str | _models.ScheduleProvisioningStatus | None

system_data

System metadata for the resource. Required.

system_data: dict[str, str]

tags

Schedule's tags. Unlike properties, tags are fully mutable.

tags: dict[str, str] | None

task

Task for the schedule. Required.

task: _models.ScheduleTask

trigger

Trigger for the schedule. Required.

trigger: _models.Trigger