BatchJobStatistics Class

Resource usage statistics for a Job.

Constructor

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

Variables

Name	Description
url	str The URL of the statistics. Required.
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.
user_cpu_time	timedelta The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. The time duration is specified in ISO 8601 format. Required.
kernel_cpu_time	timedelta The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. The time duration is specified in ISO 8601 format. Required.
wall_clock_time	timedelta The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries. The time duration is specified in ISO 8601 format. Required.
read_iops	int The total number of disk read operations made by all Tasks in the Job. Required.
write_iops	int The total number of disk write operations made by all Tasks in the Job. Required.
read_io_gib	float The total amount of data in GiB read from disk by all Tasks in the Job. Required.
write_io_gib	float The total amount of data in GiB written to disk by all Tasks in the Job. Required.
succeeded_tasks_count	int The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0. Required.
failed_tasks_count	int The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0. Required.
task_retries_count	int The total number of retries on all the Tasks in the Job during the given time range. Required.
wait_time	timedelta The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. The time duration is specified in ISO 8601 format. 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

failed_tasks_count

The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0. Required.

failed_tasks_count: int

kernel_cpu_time

The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. The time duration is specified in ISO 8601 format. Required.

kernel_cpu_time: timedelta

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

read_io_gib

The total amount of data in GiB read from disk by all Tasks in the Job. Required.

read_io_gib: float

read_iops

The total number of disk read operations made by all Tasks in the Job. Required.

read_iops: int

start_time

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

start_time: datetime

succeeded_tasks_count

The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0. Required.

succeeded_tasks_count: int

task_retries_count

The total number of retries on all the Tasks in the Job during the given time range. Required.

task_retries_count: int

url

The URL of the statistics. Required.

url: str

user_cpu_time

The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. The time duration is specified in ISO 8601 format. Required.

user_cpu_time: timedelta

wait_time

The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. The time duration is specified in ISO 8601 format. Required.

wait_time: timedelta

wall_clock_time

The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries. The time duration is specified in ISO 8601 format. Required.

wall_clock_time: timedelta

write_io_gib

The total amount of data in GiB written to disk by all Tasks in the Job. Required.

write_io_gib: float

write_iops

The total number of disk write operations made by all Tasks in the Job. Required.

write_iops: int