CreateBatchTaskEnvironmentDetails¶

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

Bases: object

The data to create a batch task environment. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. “[]” or “{}” in json notation. This applies to nested collections as well.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateBatchTaskEnvironmentDetails.
`defined_tags`	Gets the defined_tags of this CreateBatchTaskEnvironmentDetails.
`description`	Gets the description of this CreateBatchTaskEnvironmentDetails.
`display_name`	Gets the display_name of this CreateBatchTaskEnvironmentDetails.
`freeform_tags`	Gets the freeform_tags of this CreateBatchTaskEnvironmentDetails.
`image_url`	[Required] Gets the image_url of this CreateBatchTaskEnvironmentDetails.
`security_context`	Gets the security_context of this CreateBatchTaskEnvironmentDetails.
`volumes`	Gets the volumes of this CreateBatchTaskEnvironmentDetails.
`working_directory`	Gets the working_directory of this CreateBatchTaskEnvironmentDetails.

__init__(**kwargs)¶

Initializes a new CreateBatchTaskEnvironmentDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateBatchTaskEnvironmentDetails.
display_name (str) – The value to assign to the display_name property of this CreateBatchTaskEnvironmentDetails.
description (str) – The value to assign to the description property of this CreateBatchTaskEnvironmentDetails.
image_url (str) – The value to assign to the image_url property of this CreateBatchTaskEnvironmentDetails.
security_context (oci.batch.models.SecurityContext) – The value to assign to the security_context property of this CreateBatchTaskEnvironmentDetails.
working_directory (str) – The value to assign to the working_directory property of this CreateBatchTaskEnvironmentDetails.
volumes (list[oci.batch.models.BatchTaskEnvironmentVolume]) – The value to assign to the volumes property of this CreateBatchTaskEnvironmentDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateBatchTaskEnvironmentDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateBatchTaskEnvironmentDetails.

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this CreateBatchTaskEnvironmentDetails. 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 CreateBatchTaskEnvironmentDetails.
Return type:	dict(str, dict(str, object))

description¶

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

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

display_name¶

Gets the display_name of this CreateBatchTaskEnvironmentDetails. 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 CreateBatchTaskEnvironmentDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateBatchTaskEnvironmentDetails. 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 CreateBatchTaskEnvironmentDetails.
Return type:	dict(str, str)

image_url¶

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

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

security_context¶

Gets the security_context of this CreateBatchTaskEnvironmentDetails.

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

volumes¶

Gets the volumes of this CreateBatchTaskEnvironmentDetails. 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 CreateBatchTaskEnvironmentDetails.
Return type:	list[oci.batch.models.BatchTaskEnvironmentVolume]

working_directory¶

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

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