ImageJob¶

class oci.ai_vision.models.ImageJob(**kwargs)¶

Bases: object

The job details for a batch image analysis.

Attributes

`LIFECYCLE_DETAILS_COMPLETELY_FAILED`	A constant which can be used with the lifecycle_details property of a ImageJob.
`LIFECYCLE_DETAILS_PARTIALLY_SUCCEEDED`	A constant which can be used with the lifecycle_details property of a ImageJob.
`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a ImageJob.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a ImageJob.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a ImageJob.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ImageJob.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a ImageJob.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a ImageJob.
`compartment_id`	[Required] Gets the compartment_id of this ImageJob.
`display_name`	Gets the display_name of this ImageJob.
`features`	[Required] Gets the features of this ImageJob.
`id`	[Required] Gets the id of this ImageJob.
`input_location`	Gets the input_location of this ImageJob.
`is_zip_output_enabled`	Gets the is_zip_output_enabled of this ImageJob.
`lifecycle_details`	Gets the lifecycle_details of this ImageJob.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ImageJob.
`output_location`	[Required] Gets the output_location of this ImageJob.
`percent_complete`	Gets the percent_complete of this ImageJob.
`time_accepted`	[Required] Gets the time_accepted of this ImageJob.
`time_finished`	Gets the time_finished of this ImageJob.
`time_started`	Gets the time_started of this ImageJob.

Methods

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

LIFECYCLE_DETAILS_COMPLETELY_FAILED = 'COMPLETELY_FAILED'¶: A constant which can be used with the lifecycle_details property of a ImageJob. This constant has a value of “COMPLETELY_FAILED”

LIFECYCLE_DETAILS_PARTIALLY_SUCCEEDED = 'PARTIALLY_SUCCEEDED'¶: A constant which can be used with the lifecycle_details property of a ImageJob. This constant has a value of “PARTIALLY_SUCCEEDED”

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a ImageJob. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a ImageJob. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a ImageJob. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ImageJob. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a ImageJob. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a ImageJob. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new ImageJob 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 ImageJob.
compartment_id (str) – The value to assign to the compartment_id property of this ImageJob.
display_name (str) – The value to assign to the display_name property of this ImageJob.
features (list[oci.ai_vision.models.ImageFeature]) – The value to assign to the features property of this ImageJob.
input_location (oci.ai_vision.models.InputLocation) – The value to assign to the input_location property of this ImageJob.
time_accepted (datetime) – The value to assign to the time_accepted property of this ImageJob.
time_started (datetime) – The value to assign to the time_started property of this ImageJob.
time_finished (datetime) – The value to assign to the time_finished property of this ImageJob.
percent_complete (float) – The value to assign to the percent_complete property of this ImageJob.
output_location (oci.ai_vision.models.OutputLocation) – The value to assign to the output_location property of this ImageJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ImageJob. Allowed values for this property are: “SUCCEEDED”, “FAILED”, “ACCEPTED”, “CANCELED”, “IN_PROGRESS”, “CANCELING”, ‘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 ImageJob. Allowed values for this property are: “PARTIALLY_SUCCEEDED”, “COMPLETELY_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_zip_output_enabled (bool) – The value to assign to the is_zip_output_enabled property of this ImageJob.

compartment_id¶

[Required] Gets the compartment_id of this ImageJob. The OCID of the compartment that starts the job.

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

display_name¶

Gets the display_name of this ImageJob. The image job display name.

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

features¶

[Required] Gets the features of this ImageJob. The list of requested document analysis types.

Returns:	The features of this ImageJob.
Return type:	list[oci.ai_vision.models.ImageFeature]

id¶

[Required] Gets the id of this ImageJob. The job id

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

input_location¶

Gets the input_location of this ImageJob.

Returns:	The input_location of this ImageJob.
Return type:	oci.ai_vision.models.InputLocation

is_zip_output_enabled¶

Gets the is_zip_output_enabled of this ImageJob. Whether or not to generate a ZIP file containing the results.

Returns:	The is_zip_output_enabled of this ImageJob.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this ImageJob. The detailed status of FAILED state.

Allowed values for this property are: “PARTIALLY_SUCCEEDED”, “COMPLETELY_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_details of this ImageJob.
Return type:	str

lifecycle_state¶

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

Allowed values for this property are: “SUCCEEDED”, “FAILED”, “ACCEPTED”, “CANCELED”, “IN_PROGRESS”, “CANCELING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

output_location¶

[Required] Gets the output_location of this ImageJob.

Returns:	The output_location of this ImageJob.
Return type:	oci.ai_vision.models.OutputLocation

percent_complete¶

Gets the percent_complete of this ImageJob. How much progress the operation has made, compared to the total amount of work to be performed.

Returns:	The percent_complete of this ImageJob.
Return type:	float

time_accepted¶

[Required] Gets the time_accepted of this ImageJob. The job acceptance time.

Returns:	The time_accepted of this ImageJob.
Return type:	datetime

time_finished¶

Gets the time_finished of this ImageJob. The job finish time.

Returns:	The time_finished of this ImageJob.
Return type:	datetime

time_started¶

Gets the time_started of this ImageJob. The job start time.

Returns:	The time_started of this ImageJob.
Return type:	datetime