BatchNodeCounts Class

The number of Compute Nodes in each Compute Node state.

Constructor

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

Variables

Name	Description
creating	int The number of Compute Nodes in the creating state. Required.
idle	int The number of Compute Nodes in the idle state. Required.
offline	int The number of Compute Nodes in the offline state. Required.
preempted	int The number of Compute Nodes in the preempted state. Required.
rebooting	int The count of Compute Nodes in the rebooting state. Required.
reimaging	int The number of Compute Nodes in the reimaging state. Required.
running	int The number of Compute Nodes in the running state. Required.
starting	int The number of Compute Nodes in the starting state. Required.
start_task_failed	int The number of Compute Nodes in the startTaskFailed state. Required.
leaving_pool	int The number of Compute Nodes in the leavingPool state. Required.
unknown	int The number of Compute Nodes in the unknown state. Required.
unusable	int The number of Compute Nodes in the unusable state. Required.
waiting_for_start_task	int The number of Compute Nodes in the waitingForStartTask state. Required.
deallocated	int The number of Compute Nodes in the deallocated state. Required.
deallocating	int The number of Compute Nodes in the deallocating state. Required.
total	int The total number of Compute Nodes. Required.
upgrading_os	int The number of Compute Nodes in the upgradingOS state. 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

creating

The number of Compute Nodes in the creating state. Required.

creating: int

deallocated

The number of Compute Nodes in the deallocated state. Required.

deallocated: int

deallocating

The number of Compute Nodes in the deallocating state. Required.

deallocating: int

idle

The number of Compute Nodes in the idle state. Required.

idle: int

leaving_pool

The number of Compute Nodes in the leavingPool state. Required.

leaving_pool: int

offline

The number of Compute Nodes in the offline state. Required.

offline: int

preempted

The number of Compute Nodes in the preempted state. Required.

preempted: int

rebooting

The count of Compute Nodes in the rebooting state. Required.

rebooting: int

reimaging

The number of Compute Nodes in the reimaging state. Required.

reimaging: int

running

The number of Compute Nodes in the running state. Required.

running: int

start_task_failed

The number of Compute Nodes in the startTaskFailed state. Required.

start_task_failed: int

starting

The number of Compute Nodes in the starting state. Required.

starting: int

total

The total number of Compute Nodes. Required.

total: int

unknown

The number of Compute Nodes in the unknown state. Required.

unknown: int

unusable

The number of Compute Nodes in the unusable state. Required.

unusable: int

upgrading_os

The number of Compute Nodes in the upgradingOS state. Required.

upgrading_os: int

waiting_for_start_task

The number of Compute Nodes in the waitingForStartTask state. Required.

waiting_for_start_task: int

Feedback

Was this page helpful?