BatchTaskSummary¶
- class oci.batch.models.BatchTaskSummary(**kwargs)¶
Bases:
objectSummary information about a batch task.
Methods:
__init__(**kwargs)Initializes a new BatchTaskSummary 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:
Gets the description of this BatchTaskSummary.
Gets the group_task_name of this BatchTaskSummary.
Gets the hierarchical_name of this BatchTaskSummary.
[Required] Gets the id of this BatchTaskSummary.
[Required] Gets the job_id of this BatchTaskSummary.
Gets the lifecycle_details of this BatchTaskSummary.
Gets the lifecycle_state of this BatchTaskSummary.
[Required] Gets the name of this BatchTaskSummary.
[Required] Gets the type of this BatchTaskSummary.
- __init__(**kwargs)¶
Initializes a new BatchTaskSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
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 BatchTaskSummary.
job_id (str) – The value to assign to the job_id property of this BatchTaskSummary.
name (str) – The value to assign to the name property of this BatchTaskSummary.
hierarchical_name (str) – The value to assign to the hierarchical_name property of this BatchTaskSummary.
group_task_name (str) – The value to assign to the group_task_name property of this BatchTaskSummary.
description (str) – The value to assign to the description property of this BatchTaskSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BatchTaskSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this BatchTaskSummary.
type (str) – The value to assign to the type property of this BatchTaskSummary.
- property 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.
- property 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
- property 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
- property id¶
[Required] Gets the id of this BatchTaskSummary. The UUID of batch task.
- Returns
The id of this BatchTaskSummary.
- Return type
str
- property 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
- property 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
- property 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
- property 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
- property 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