Share via

Schedule Class

A Schedule to execute action.

Readonly variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

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

Variables

Name Description
name
str

Display name for the Schedule. Required.
type
str or ScheduledType

Supported type this scheduled task represents. Required. "StopDevBox"
frequency
str or ScheduledFrequency

The frequency of this scheduled task. Required. "Daily"
time
str

The target time to trigger the action. The format is HH:MM. Required.
time_zone
str

The IANA timezone id at which the schedule should execute. Required.

Methods

as_dict

Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify 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 

clear() -> None

copy 

copy() -> Model

get 

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

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

keys 

keys() -> KeysView[str]

pop 

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

Parameters

Name Description
key
Required
default

popitem 

popitem() -> Tuple[str, Any]

setdefault 

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

Parameters

Name Description
key
Required
default

update 

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

values 

values() -> ValuesView[Any]

Attributes

frequency

The frequency of this scheduled task. Required. "Daily"

frequency: str | _models.ScheduledFrequency

name

Display name for the Schedule. Required.

name: str

time

  1. Required.
time: str

time_zone

The IANA timezone id at which the schedule should execute. Required.

time_zone: str

type

Supported type this scheduled task represents. Required. "StopDevBox"

type: str | _models.ScheduledType