GroupTaskSummary¶

class oci.batch.models.GroupTaskSummary(**kwargs)¶

Bases: oci.batch.models.batch_task_summary.BatchTaskSummary

Summary information about a group task.

Methods

`__init__`(**kwargs)	Initializes a new GroupTaskSummary object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

Attributes

`description`	Gets the description of this BatchTaskSummary.
`group_task_name`	Gets the group_task_name of this BatchTaskSummary.
`hierarchical_name`	Gets the hierarchical_name of this BatchTaskSummary.
`id`	[Required] Gets the id of this BatchTaskSummary.
`job_id`	[Required] Gets the job_id of this BatchTaskSummary.
`lifecycle_details`	Gets the lifecycle_details of this BatchTaskSummary.
`lifecycle_state`	Gets the lifecycle_state of this BatchTaskSummary.
`name`	[Required] Gets the name of this BatchTaskSummary.
`task_count`	Gets the task_count of this GroupTaskSummary.
`type`	[Required] Gets the type of this BatchTaskSummary.

__init__(**kwargs)¶

Initializes a new GroupTaskSummary object with values from keyword arguments. The default value of the type attribute of this class is GROUP and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this GroupTaskSummary.
job_id (str) – The value to assign to the job_id property of this GroupTaskSummary.
name (str) – The value to assign to the name property of this GroupTaskSummary.
hierarchical_name (str) – The value to assign to the hierarchical_name property of this GroupTaskSummary.
group_task_name (str) – The value to assign to the group_task_name property of this GroupTaskSummary.
description (str) – The value to assign to the description property of this GroupTaskSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this GroupTaskSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this GroupTaskSummary.
type (str) – The value to assign to the type property of this GroupTaskSummary.
task_count (int) – The value to assign to the task_count property of this GroupTaskSummary.

description¶

Gets the description of this BatchTaskSummary. An optional description that provides additional context next to the displayName.

Returns:	The description of this BatchTaskSummary.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

group_task_name¶

Gets the group_task_name of this BatchTaskSummary. The hierarchical name of the group task. Null for top-level tasks.

Returns:	The group_task_name of this BatchTaskSummary.
Return type:	str

hierarchical_name¶

Gets the hierarchical_name of this BatchTaskSummary. The hierarchical name of the task, which incorporates names of all parent group tasks, separated by “.” (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName

Returns:	The hierarchical_name of this BatchTaskSummary.
Return type:	str

id¶

[Required] Gets the id of this BatchTaskSummary. The UUID of batch task.

Returns:	The id of this BatchTaskSummary.
Return type:	str

job_id¶

[Required] Gets the job_id of this BatchTaskSummary. The OCID of the batch job to which this task belongs.

Returns:	The job_id of this BatchTaskSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this BatchTaskSummary. A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this BatchTaskSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this BatchTaskSummary. The current state of the batch task.

Returns:	The lifecycle_state of this BatchTaskSummary.
Return type:	str

name¶

[Required] Gets the name of this BatchTaskSummary. The name of the batch task. It must be unique within its parent batch job.

Returns:	The name of this BatchTaskSummary.
Return type:	str

task_count¶

Gets the task_count of this GroupTaskSummary. The count of tasks contained directly (non-recursively) within this group task.

Returns:	The task_count of this GroupTaskSummary.
Return type:	int

type¶

[Required] Gets the type of this BatchTaskSummary. Type of the batch task. Also serves as a discriminator for sub-entities.

Returns:	The type of this BatchTaskSummary.
Return type:	str