BatchContext¶
- class oci.batch.models.BatchContext(**kwargs)¶
Bases:
objectRepresentation of a batch context and its configurations.
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 BatchContext.
A constant which can be used with the lifecycle_state property of a BatchContext.
A constant which can be used with the lifecycle_state property of a BatchContext.
A constant which can be used with the lifecycle_state property of a BatchContext.
A constant which can be used with the lifecycle_state property of a BatchContext.
A constant which can be used with the lifecycle_state property of a BatchContext.
A constant which can be used with the lifecycle_state property of a BatchContext.
A constant which can be used with the lifecycle_state property of a BatchContext.
[Required] Gets the compartment_id of this BatchContext.
[Required] Gets the defined_tags of this BatchContext.
Gets the description of this BatchContext.
[Required] Gets the display_name of this BatchContext.
[Required] Gets the entitlements of this BatchContext.
[Required] Gets the fleets of this BatchContext.
[Required] Gets the freeform_tags of this BatchContext.
[Required] Gets the id of this BatchContext.
[Required] Gets the job_priority_configurations of this BatchContext.
Gets the lifecycle_details of this BatchContext.
[Required] Gets the lifecycle_state of this BatchContext.
Gets the logging_configuration of this BatchContext.
[Required] Gets the network of this BatchContext.
[Required] Gets the system_tags of this BatchContext.
[Required] Gets the time_created of this BatchContext.
Gets the time_updated of this BatchContext.
Methods:
__init__(**kwargs)Initializes a new BatchContext object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a BatchContext. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a BatchContext. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a BatchContext. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a BatchContext. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a BatchContext. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a BatchContext. 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 BatchContext. 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 BatchContext. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new BatchContext 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 BatchContext.
compartment_id (str) – The value to assign to the compartment_id property of this BatchContext.
display_name (str) – The value to assign to the display_name property of this BatchContext.
description (str) – The value to assign to the description property of this BatchContext.
time_created (datetime) – The value to assign to the time_created property of this BatchContext.
time_updated (datetime) – The value to assign to the time_updated property of this BatchContext.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BatchContext. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this BatchContext.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BatchContext.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BatchContext.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BatchContext.
job_priority_configurations (list[oci.batch.models.JobPriorityConfiguration]) – The value to assign to the job_priority_configurations property of this BatchContext.
network (oci.batch.models.Network) – The value to assign to the network property of this BatchContext.
fleets (list[oci.batch.models.Fleet]) – The value to assign to the fleets property of this BatchContext.
entitlements (dict(str, int)) – The value to assign to the entitlements property of this BatchContext.
logging_configuration (oci.batch.models.LoggingConfiguration) – The value to assign to the logging_configuration property of this BatchContext.
- property compartment_id¶
[Required] Gets the compartment_id of this BatchContext. The OCID of the compartment.
- Returns
The compartment_id of this BatchContext.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this BatchContext. 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 BatchContext.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this BatchContext. Summarized information about the batch context.
- Returns
The description of this BatchContext.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this BatchContext. A user-friendly name. Does not have to be unique, and it’s changeable.
- Returns
The display_name of this BatchContext.
- Return type
str
- property entitlements¶
[Required] Gets the entitlements of this BatchContext. Mapping of concurrent/shared resources used in job tasks to their limits.
- Returns
The entitlements of this BatchContext.
- Return type
dict(str, int)
- property fleets¶
[Required] Gets the fleets of this BatchContext. List of fleet configurations related to the batch context.
- Returns
The fleets of this BatchContext.
- Return type
list[oci.batch.models.Fleet]
- property freeform_tags¶
[Required] Gets the freeform_tags of this BatchContext. 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 BatchContext.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this BatchContext. The OCID of the batch context.
- Returns
The id of this BatchContext.
- Return type
str
- property job_priority_configurations¶
[Required] Gets the job_priority_configurations of this BatchContext. List of job priority configurations related to the batch context.
- Returns
The job_priority_configurations of this BatchContext.
- Return type
- property lifecycle_details¶
Gets the lifecycle_details of this BatchContext. A message that describes the current state in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- Returns
The lifecycle_details of this BatchContext.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this BatchContext. The current state of the batch context.
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this BatchContext.
- Return type
str
- property logging_configuration¶
Gets the logging_configuration of this BatchContext.
- Returns
The logging_configuration of this BatchContext.
- Return type
- property network¶
[Required] Gets the network of this BatchContext.
- Returns
The network of this BatchContext.
- Return type
- property system_tags¶
[Required] Gets the system_tags of this BatchContext. 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 BatchContext.
- Return type
dict(str, dict(str, object))