BatchTaskEnvironmentSummary¶

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

Bases: object

Summary information about a batch task environment.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this BatchTaskEnvironmentSummary.
`defined_tags`	[Required] Gets the defined_tags of this BatchTaskEnvironmentSummary.
`description`	Gets the description of this BatchTaskEnvironmentSummary.
`display_name`	[Required] Gets the display_name of this BatchTaskEnvironmentSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this BatchTaskEnvironmentSummary.
`id`	[Required] Gets the id of this BatchTaskEnvironmentSummary.
`image_url`	[Required] Gets the image_url of this BatchTaskEnvironmentSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BatchTaskEnvironmentSummary.
`security_context`	Gets the security_context of this BatchTaskEnvironmentSummary.
`system_tags`	[Required] Gets the system_tags of this BatchTaskEnvironmentSummary.
`time_created`	[Required] Gets the time_created of this BatchTaskEnvironmentSummary.
`time_updated`	Gets the time_updated of this BatchTaskEnvironmentSummary.
`working_directory`	Gets the working_directory of this BatchTaskEnvironmentSummary.

__init__(**kwargs)¶

Initializes a new BatchTaskEnvironmentSummary 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 BatchTaskEnvironmentSummary.
compartment_id (str) – The value to assign to the compartment_id property of this BatchTaskEnvironmentSummary.
display_name (str) – The value to assign to the display_name property of this BatchTaskEnvironmentSummary.
description (str) – The value to assign to the description property of this BatchTaskEnvironmentSummary.
image_url (str) – The value to assign to the image_url property of this BatchTaskEnvironmentSummary.
security_context (oci.batch.models.SecurityContext) – The value to assign to the security_context property of this BatchTaskEnvironmentSummary.
working_directory (str) – The value to assign to the working_directory property of this BatchTaskEnvironmentSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BatchTaskEnvironmentSummary.
time_created (datetime) – The value to assign to the time_created property of this BatchTaskEnvironmentSummary.
time_updated (datetime) – The value to assign to the time_updated property of this BatchTaskEnvironmentSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BatchTaskEnvironmentSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BatchTaskEnvironmentSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BatchTaskEnvironmentSummary.

compartment_id¶

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

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

defined_tags¶

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

description¶

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

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

display_name¶

[Required] Gets the display_name of this BatchTaskEnvironmentSummary. 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 BatchTaskEnvironmentSummary.
Return type:	str

freeform_tags¶

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

id¶

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

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

image_url¶

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

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

lifecycle_state¶

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

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

security_context¶

Gets the security_context of this BatchTaskEnvironmentSummary.

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

system_tags¶

[Required] Gets the system_tags of this BatchTaskEnvironmentSummary. 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 BatchTaskEnvironmentSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this BatchTaskEnvironmentSummary. 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 BatchTaskEnvironmentSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this BatchTaskEnvironmentSummary. 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 BatchTaskEnvironmentSummary.
Return type:	datetime

working_directory¶

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

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