BatchJobPool¶
- class oci.batch.models.BatchJobPool(**kwargs)¶
Bases:
objectA batch job pool represents an abstract group for jobs.
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:
A constant which can be used with the lifecycle_state property of a BatchJobPool.
A constant which can be used with the lifecycle_state property of a BatchJobPool.
A constant which can be used with the lifecycle_state property of a BatchJobPool.
A constant which can be used with the lifecycle_state property of a BatchJobPool.
A constant which can be used with the lifecycle_state property of a BatchJobPool.
[Required] Gets the batch_context_id of this BatchJobPool.
[Required] Gets the compartment_id of this BatchJobPool.
[Required] Gets the defined_tags of this BatchJobPool.
Gets the description of this BatchJobPool.
[Required] Gets the display_name of this BatchJobPool.
[Required] Gets the freeform_tags of this BatchJobPool.
[Required] Gets the id of this BatchJobPool.
[Required] Gets the lifecycle_state of this BatchJobPool.
[Required] Gets the system_tags of this BatchJobPool.
[Required] Gets the time_created of this BatchJobPool.
Gets the time_updated of this BatchJobPool.
Methods:
__init__(**kwargs)Initializes a new BatchJobPool object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a BatchJobPool. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a BatchJobPool. This constant has a value of “DELETED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a BatchJobPool. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a BatchJobPool. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a BatchJobPool. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new BatchJobPool 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 BatchJobPool.
display_name (str) – The value to assign to the display_name property of this BatchJobPool.
compartment_id (str) – The value to assign to the compartment_id property of this BatchJobPool.
batch_context_id (str) – The value to assign to the batch_context_id property of this BatchJobPool.
description (str) – The value to assign to the description property of this BatchJobPool.
time_created (datetime) – The value to assign to the time_created property of this BatchJobPool.
time_updated (datetime) – The value to assign to the time_updated property of this BatchJobPool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BatchJobPool. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “UPDATING”, “NEEDS_ATTENTION”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BatchJobPool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BatchJobPool.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BatchJobPool.
- property batch_context_id¶
[Required] Gets the batch_context_id of this BatchJobPool. The OCID of batch context.
- Returns
The batch_context_id of this BatchJobPool.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this BatchJobPool. The OCID of the compartment.
- Returns
The compartment_id of this BatchJobPool.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this BatchJobPool. 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 BatchJobPool.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this BatchJobPool. Summarized information about the batch job pool.
- Returns
The description of this BatchJobPool.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this BatchJobPool. A user-friendly name. Does not have to be unique, and it’s changeable.
- Returns
The display_name of this BatchJobPool.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this BatchJobPool. 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 BatchJobPool.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this BatchJobPool. The OCID of the batch job pool.
- Returns
The id of this BatchJobPool.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this BatchJobPool. The current state of the batch job pool.
Allowed values for this property are: “ACTIVE”, “INACTIVE”, “UPDATING”, “NEEDS_ATTENTION”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this BatchJobPool.
- Return type
str
- property system_tags¶
[Required] Gets the system_tags of this BatchJobPool. 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 BatchJobPool.
- Return type
dict(str, dict(str, object))