BatchTaskEnvironment¶

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

Bases: object

A batch task environment resource defines the software that is used to execute tasks. It mainly contains a URL to a container image along with other configurations that are needed by the image.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a BatchTaskEnvironment.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a BatchTaskEnvironment.
`compartment_id`	[Required] Gets the compartment_id of this BatchTaskEnvironment.
`defined_tags`	[Required] Gets the defined_tags of this BatchTaskEnvironment.
`description`	Gets the description of this BatchTaskEnvironment.
`display_name`	[Required] Gets the display_name of this BatchTaskEnvironment.
`freeform_tags`	[Required] Gets the freeform_tags of this BatchTaskEnvironment.
`id`	[Required] Gets the id of this BatchTaskEnvironment.
`image_url`	[Required] Gets the image_url of this BatchTaskEnvironment.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BatchTaskEnvironment.
`security_context`	Gets the security_context of this BatchTaskEnvironment.
`system_tags`	[Required] Gets the system_tags of this BatchTaskEnvironment.
`time_created`	[Required] Gets the time_created of this BatchTaskEnvironment.
`time_updated`	Gets the time_updated of this BatchTaskEnvironment.
`volumes`	[Required] Gets the volumes of this BatchTaskEnvironment.
`working_directory`	Gets the working_directory of this BatchTaskEnvironment.

Methods

__init__(**kwargs) Initializes a new BatchTaskEnvironment object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a BatchTaskEnvironment. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a BatchTaskEnvironment. This constant has a value of “DELETED”

__init__(**kwargs)¶

Initializes a new BatchTaskEnvironment object with values from keyword arguments. 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 BatchTaskEnvironment.
compartment_id (str) – The value to assign to the compartment_id property of this BatchTaskEnvironment.
display_name (str) – The value to assign to the display_name property of this BatchTaskEnvironment.
description (str) – The value to assign to the description property of this BatchTaskEnvironment.
image_url (str) – The value to assign to the image_url property of this BatchTaskEnvironment.
security_context (oci.batch.models.SecurityContext) – The value to assign to the security_context property of this BatchTaskEnvironment.
working_directory (str) – The value to assign to the working_directory property of this BatchTaskEnvironment.
volumes (list[oci.batch.models.BatchTaskEnvironmentVolume]) – The value to assign to the volumes property of this BatchTaskEnvironment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BatchTaskEnvironment. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this BatchTaskEnvironment.
time_updated (datetime) – The value to assign to the time_updated property of this BatchTaskEnvironment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BatchTaskEnvironment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BatchTaskEnvironment.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BatchTaskEnvironment.

compartment_id¶

[Required] Gets the compartment_id of this BatchTaskEnvironment. The OCID of the compartment.

Returns:	The compartment_id of this BatchTaskEnvironment.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this BatchTaskEnvironment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this BatchTaskEnvironment.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this BatchTaskEnvironment. The batch task environment description.

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

display_name¶

[Required] Gets the display_name of this BatchTaskEnvironment. A user-friendly name. Does not have to be unique, and it’s changeable. If not specified or provided as null or empty string, it be generated as “<resourceType><timeCreated>”, where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.

Returns:	The display_name of this BatchTaskEnvironment.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this BatchTaskEnvironment. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this BatchTaskEnvironment.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this BatchTaskEnvironment. The OCID of the batch task environment.

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

image_url¶

[Required] Gets the image_url of this BatchTaskEnvironment. The URL of the ocir image.

Returns:	The image_url of this BatchTaskEnvironment.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this BatchTaskEnvironment. The current state of the batch task environment.

Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

security_context¶

Gets the security_context of this BatchTaskEnvironment.

Returns:	The security_context of this BatchTaskEnvironment.
Return type:	oci.batch.models.SecurityContext

system_tags¶

[Required] Gets the system_tags of this BatchTaskEnvironment. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this BatchTaskEnvironment.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this BatchTaskEnvironment. The date and time the batch task environment was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this BatchTaskEnvironment.
Return type:	datetime

time_updated¶

Gets the time_updated of this BatchTaskEnvironment. The date and time the batch task environment was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this BatchTaskEnvironment.
Return type:	datetime

volumes¶

[Required] Gets the volumes of this BatchTaskEnvironment. List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.

Returns:	The volumes of this BatchTaskEnvironment.
Return type:	list[oci.batch.models.BatchTaskEnvironmentVolume]

working_directory¶

Gets the working_directory of this BatchTaskEnvironment. Container’s working directory.

Returns:	The working_directory of this BatchTaskEnvironment.
Return type:	str