CreateBatchTaskDetails¶
- class oci.batch.models.CreateBatchTaskDetails(**kwargs)¶
Bases:
objectA batch task contains common properties for all types of job tasks.
Attributes:
A constant which can be used with the type property of a CreateBatchTaskDetails.
A constant which can be used with the type property of a CreateBatchTaskDetails.
Gets the dependencies of this CreateBatchTaskDetails.
Gets the description of this CreateBatchTaskDetails.
Gets the entitlement_claims of this CreateBatchTaskDetails.
Gets the environment_variables of this CreateBatchTaskDetails.
[Required] Gets the name of this CreateBatchTaskDetails.
[Required] Gets the type of this CreateBatchTaskDetails.
Methods:
__init__(**kwargs)Initializes a new CreateBatchTaskDetails 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.
- TYPE_COMPUTE = 'COMPUTE'¶
A constant which can be used with the type property of a CreateBatchTaskDetails. This constant has a value of “COMPUTE”
- TYPE_GROUP = 'GROUP'¶
A constant which can be used with the type property of a CreateBatchTaskDetails. This constant has a value of “GROUP”
- __init__(**kwargs)¶
Initializes a new CreateBatchTaskDetails 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
name (str) – The value to assign to the name property of this CreateBatchTaskDetails.
description (str) – The value to assign to the description property of this CreateBatchTaskDetails.
type (str) – The value to assign to the type property of this CreateBatchTaskDetails. Allowed values for this property are: “COMPUTE”, “GROUP”
entitlement_claims (list[str]) – The value to assign to the entitlement_claims property of this CreateBatchTaskDetails.
dependencies (list[str]) – The value to assign to the dependencies property of this CreateBatchTaskDetails.
environment_variables (list[oci.batch.models.EnvironmentVariable]) – The value to assign to the environment_variables property of this CreateBatchTaskDetails.
- property dependencies¶
Gets the dependencies of this CreateBatchTaskDetails. A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task.
- Returns
The dependencies of this CreateBatchTaskDetails.
- Return type
list[str]
- property description¶
Gets the description of this CreateBatchTaskDetails. An optional description that provides additional context next to the displayName.
- Returns
The description of this CreateBatchTaskDetails.
- Return type
str
- property entitlement_claims¶
Gets the entitlement_claims of this CreateBatchTaskDetails. A list of resources (for example licences) this task needs for its execution.
- Returns
The entitlement_claims of this CreateBatchTaskDetails.
- Return type
list[str]
- property environment_variables¶
Gets the environment_variables of this CreateBatchTaskDetails. Environment variables to use for the task execution.
- Returns
The environment_variables of this CreateBatchTaskDetails.
- Return type
- 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 name¶
[Required] Gets the name of this CreateBatchTaskDetails. The name of the batch task. It must be unique within its parent batch job.
- Returns
The name of this CreateBatchTaskDetails.
- Return type
str
- property type¶
[Required] Gets the type of this CreateBatchTaskDetails. Type of the batch task. Also serves as a discriminator for sub-entities.
Allowed values for this property are: “COMPUTE”, “GROUP”
- Returns
The type of this CreateBatchTaskDetails.
- Return type
str