BatchJobReleaseTaskExecutionInfo Class

Contains information about the execution of a Job Release Task on a Compute Node.

Constructor

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

Variables

Name Description
start_time

The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running. Required.

end_time

The time at which the Job Release Task completed. This property is set only if the Task is in the Completed state.

state

The current state of the Job Release Task on the Compute Node. Required. Known values are: "running" and "completed".

task_root_directory
str

The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files.

task_root_directory_url
str

The URL to the root directory of the Job Release Task on the Compute Node.

exit_code
int

The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated.

container_info

Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.

failure_info

Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.

result

The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Known values are: "success" and "failure".

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

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

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

set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type Description

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

an object providing a view on D's values

Attributes

container_info

Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.

container_info: _models.BatchTaskContainerExecutionInfo | None

end_time

The time at which the Job Release Task completed. This property is set only if the Task is in the Completed state.

end_time: datetime | None

exit_code

The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated.

exit_code: int | None

failure_info

Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.

failure_info: _models.BatchTaskFailureInfo | None

result

The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Known values are: "success" and "failure".

result: str | _models.BatchTaskExecutionResult | None

start_time

The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running. Required.

start_time: datetime

state

The current state of the Job Release Task on the Compute Node. Required. Known values are: "running" and "completed".

state: str | _models.BatchJobReleaseTaskState

task_root_directory

The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files.

task_root_directory: str | None

task_root_directory_url

The URL to the root directory of the Job Release Task on the Compute Node.

task_root_directory_url: str | None