BatchJobSummary¶

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

Bases: object

Summary information about a batch job.

Methods

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

Attributes

`batch_context_id`	[Required] Gets the batch_context_id of this BatchJobSummary.
`batch_job_pool_id`	[Required] Gets the batch_job_pool_id of this BatchJobSummary.
`compartment_id`	[Required] Gets the compartment_id of this BatchJobSummary.
`defined_tags`	[Required] Gets the defined_tags of this BatchJobSummary.
`description`	Gets the description of this BatchJobSummary.
`display_name`	[Required] Gets the display_name of this BatchJobSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this BatchJobSummary.
`id`	[Required] Gets the id of this BatchJobSummary.
`lifecycle_details`	Gets the lifecycle_details of this BatchJobSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BatchJobSummary.
`priority`	Gets the priority of this BatchJobSummary.
`progress_details`	Gets the progress_details of this BatchJobSummary.
`progress_percentage`	Gets the progress_percentage of this BatchJobSummary.
`system_tags`	[Required] Gets the system_tags of this BatchJobSummary.
`time_created`	[Required] Gets the time_created of this BatchJobSummary.
`time_updated`	Gets the time_updated of this BatchJobSummary.

__init__(**kwargs)¶

Initializes a new BatchJobSummary 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 BatchJobSummary.
compartment_id (str) – The value to assign to the compartment_id property of this BatchJobSummary.
batch_job_pool_id (str) – The value to assign to the batch_job_pool_id property of this BatchJobSummary.
batch_context_id (str) – The value to assign to the batch_context_id property of this BatchJobSummary.
display_name (str) – The value to assign to the display_name property of this BatchJobSummary.
description (str) – The value to assign to the description property of this BatchJobSummary.
priority (int) – The value to assign to the priority property of this BatchJobSummary.
progress_percentage (int) – The value to assign to the progress_percentage property of this BatchJobSummary.
progress_details (str) – The value to assign to the progress_details property of this BatchJobSummary.
time_created (datetime) – The value to assign to the time_created property of this BatchJobSummary.
time_updated (datetime) – The value to assign to the time_updated property of this BatchJobSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BatchJobSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this BatchJobSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BatchJobSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BatchJobSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BatchJobSummary.

batch_context_id¶

[Required] Gets the batch_context_id of this BatchJobSummary. The OCID of the parent batch context of the parent job pool.

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

batch_job_pool_id¶

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

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

compartment_id¶

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

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

defined_tags¶

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

description¶

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

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

display_name¶

[Required] Gets the display_name of this BatchJobSummary. A user-friendly name. Does not have to be unique, and it’s changeable.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this BatchJobSummary. The OCID of the batch job.

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

lifecycle_details¶

Gets the lifecycle_details of this BatchJobSummary. A message that describes the current state of the batch job 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 BatchJobSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this BatchJobSummary. The current state of the batch job.

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

priority¶

Gets the priority of this BatchJobSummary. A value calculated by the system based on the priority tags.

Returns:	The priority of this BatchJobSummary.
Return type:	int

progress_details¶

Gets the progress_details of this BatchJobSummary. A more detailed textual representation of the job completion.

Returns:	The progress_details of this BatchJobSummary.
Return type:	str

progress_percentage¶

Gets the progress_percentage of this BatchJobSummary. A percentage value (0..100) of the job completion.

Returns:	The progress_percentage of this BatchJobSummary.
Return type:	int

system_tags¶

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

time_created¶

[Required] Gets the time_created of this BatchJobSummary. The date and time the batch job was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this BatchJobSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this BatchJobSummary. The date and time the batch job was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this BatchJobSummary.
Return type:	datetime