CreateBatchJobPoolDetails¶

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

Bases: object

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

Attributes:

`batch_context_id`	[Required] Gets the batch_context_id of this CreateBatchJobPoolDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateBatchJobPoolDetails.
`defined_tags`	Gets the defined_tags of this CreateBatchJobPoolDetails.
`description`	Gets the description of this CreateBatchJobPoolDetails.
`display_name`	Gets the display_name of this CreateBatchJobPoolDetails.
`freeform_tags`	Gets the freeform_tags of this CreateBatchJobPoolDetails.

__init__(**kwargs)¶

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

Parameters

display_name (str) – The value to assign to the display_name property of this CreateBatchJobPoolDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateBatchJobPoolDetails.
batch_context_id (str) – The value to assign to the batch_context_id property of this CreateBatchJobPoolDetails.
description (str) – The value to assign to the description property of this CreateBatchJobPoolDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateBatchJobPoolDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateBatchJobPoolDetails.

property batch_context_id¶

[Required] Gets the batch_context_id of this CreateBatchJobPoolDetails. The OCID of batch context.

Returns: The batch_context_id of this CreateBatchJobPoolDetails.
Return type: str

property compartment_id¶

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

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

property defined_tags¶

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

property description¶

Gets the description of this CreateBatchJobPoolDetails. Summarized information about the batch job pool.

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

property display_name¶

Gets the display_name of this CreateBatchJobPoolDetails. 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: batchjobpool20250914115623.

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

property freeform_tags¶

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