DevBoxAction Class

An action which will take place on a Dev Box.

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

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

Variables

Name	Description
name	str The name of the action. Required.
action_type	str or DevBoxActionType The action that will be taken. Required. "Stop"
source_id	str The id of the resource which triggered this action. Required.
suspended_until	datetime The earliest time that the action could occur (UTC).
next	DevBoxNextAction Details about the next run of this action.

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

action_type

The action that will be taken. Required. "Stop"

action_type: str | _models.DevBoxActionType

name

The name of the action. Required.

name: str

next

Details about the next run of this action.

next: _models.DevBoxNextAction | None

source_id

The id of the resource which triggered this action. Required.

source_id: str

suspended_until

The earliest time that the action could occur (UTC).

suspended_until: datetime | None