BatchPoolResourceStatistics Class

Statistics related to resource consumption by Compute Nodes in a Pool.

Constructor

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

Variables

Name	Description
start_time	datetime The start time of the time range covered by the statistics. Required.
last_update_time	datetime The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. Required.
avg_cpu_percentage	float The average CPU usage across all Compute Nodes in the Pool (percentage per node). Required.
avg_memory_gib	float The average memory usage in GiB across all Compute Nodes in the Pool. Required.
peak_memory_gib	float The peak memory usage in GiB across all Compute Nodes in the Pool. Required.
avg_disk_gib	float The average used disk space in GiB across all Compute Nodes in the Pool. Required.
peak_disk_gib	float The peak used disk space in GiB across all Compute Nodes in the Pool. Required.
disk_read_iops	int The total number of disk read operations across all Compute Nodes in the Pool. Required.
disk_write_iops	int The total number of disk write operations across all Compute Nodes in the Pool. Required.
disk_read_gib	float The total amount of data in GiB of disk reads across all Compute Nodes in the Pool. Required.
disk_write_gib	float The total amount of data in GiB of disk writes across all Compute Nodes in the Pool. Required.
network_read_gib	float The total amount of data in GiB of network reads across all Compute Nodes in the Pool. Required.
network_write_gib	float The total amount of data in GiB of network writes across all Compute Nodes in the Pool. 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

avg_cpu_percentage

The average CPU usage across all Compute Nodes in the Pool (percentage per node). Required.

avg_cpu_percentage: float

avg_disk_gib

The average used disk space in GiB across all Compute Nodes in the Pool. Required.

avg_disk_gib: float

avg_memory_gib

The average memory usage in GiB across all Compute Nodes in the Pool. Required.

avg_memory_gib: float

disk_read_gib

The total amount of data in GiB of disk reads across all Compute Nodes in the Pool. Required.

disk_read_gib: float

disk_read_iops

The total number of disk read operations across all Compute Nodes in the Pool. Required.

disk_read_iops: int

disk_write_gib

The total amount of data in GiB of disk writes across all Compute Nodes in the Pool. Required.

disk_write_gib: float

disk_write_iops

The total number of disk write operations across all Compute Nodes in the Pool. Required.

disk_write_iops: int

last_update_time

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. Required.

last_update_time: datetime

network_read_gib

The total amount of data in GiB of network reads across all Compute Nodes in the Pool. Required.

network_read_gib: float

network_write_gib

The total amount of data in GiB of network writes across all Compute Nodes in the Pool. Required.

network_write_gib: float

peak_disk_gib

The peak used disk space in GiB across all Compute Nodes in the Pool. Required.

peak_disk_gib: float

peak_memory_gib

The peak memory usage in GiB across all Compute Nodes in the Pool. Required.

peak_memory_gib: float

start_time

The start time of the time range covered by the statistics. Required.

start_time: datetime

Feedback

Was this page helpful?