CreateBatchJobDetails¶

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

Bases: object

The data to create a batch job. 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 CreateBatchJobDetails object with values from keyword arguments.

Attributes

`batch_job_pool_id`	[Required] Gets the batch_job_pool_id of this CreateBatchJobDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateBatchJobDetails.
`defined_tags`	Gets the defined_tags of this CreateBatchJobDetails.
`description`	Gets the description of this CreateBatchJobDetails.
`display_name`	Gets the display_name of this CreateBatchJobDetails.
`environment_variables`	Gets the environment_variables of this CreateBatchJobDetails.
`freeform_tags`	Gets the freeform_tags of this CreateBatchJobDetails.
`tasks`	[Required] Gets the tasks of this CreateBatchJobDetails.

__init__(**kwargs)¶

Initializes a new CreateBatchJobDetails 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 CreateBatchJobDetails.
batch_job_pool_id (str) – The value to assign to the batch_job_pool_id property of this CreateBatchJobDetails.
display_name (str) – The value to assign to the display_name property of this CreateBatchJobDetails.
description (str) – The value to assign to the description property of this CreateBatchJobDetails.
environment_variables (list[oci.batch.models.EnvironmentVariable]) – The value to assign to the environment_variables property of this CreateBatchJobDetails.
tasks (list[oci.batch.models.CreateBatchTaskDetails]) – The value to assign to the tasks property of this CreateBatchJobDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateBatchJobDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateBatchJobDetails.

batch_job_pool_id¶

[Required] Gets the batch_job_pool_id of this CreateBatchJobDetails. The OCID of the parent batch job pool.

Returns:	The batch_job_pool_id of this CreateBatchJobDetails.
Return type:	str

compartment_id¶

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

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

defined_tags¶

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

description¶

Gets the description of this CreateBatchJobDetails. An optional description that provides additional context next to the displayName.

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

display_name¶

Gets the display_name of this CreateBatchJobDetails. 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 will 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: batchjob20250914115623.

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

environment_variables¶

Gets the environment_variables of this CreateBatchJobDetails. An environment variables to use for the job’s tasks (can be overridden by task’s environment variables).

Returns:	The environment_variables of this CreateBatchJobDetails.
Return type:	list[oci.batch.models.EnvironmentVariable]

freeform_tags¶

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

tasks¶

[Required] Gets the tasks of this CreateBatchJobDetails. A list of tasks to be executed within this job. Maximum number of tasks a job can have in total, across all nested levels, is 1000.

Returns:	The tasks of this CreateBatchJobDetails.
Return type:	list[oci.batch.models.CreateBatchTaskDetails]