ProcessorJob

class oci.ai_document.models.ProcessorJob(**kwargs)

Bases: object

Details of a processor job.

Attributes:

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

Methods:

__init__(**kwargs)

Initializes a new ProcessorJob 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 ProcessorJob. 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 ProcessorJob. 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 ProcessorJob. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'

A constant which can be used with the lifecycle_state property of a ProcessorJob. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'

A constant which can be used with the lifecycle_state property of a ProcessorJob. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ProcessorJob. 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 ProcessorJob. 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 ProcessorJob. This constant has a value of “SUCCEEDED”

__init__(**kwargs)

Initializes a new ProcessorJob 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 ProcessorJob.

• compartment_id (str) – The value to assign to the compartment_id property of this ProcessorJob.

• display_name (str) – The value to assign to the display_name property of this ProcessorJob.

• processor_config (oci.ai_document.models.ProcessorConfig) – The value to assign to the processor_config property of this ProcessorJob.

• input_location (oci.ai_document.models.InputLocation) – The value to assign to the input_location property of this ProcessorJob.

• time_accepted (datetime) – The value to assign to the time_accepted property of this ProcessorJob.

• time_started (datetime) – The value to assign to the time_started property of this ProcessorJob.

• time_finished (datetime) – The value to assign to the time_finished property of this ProcessorJob.

• percent_complete (float) – The value to assign to the percent_complete property of this ProcessorJob.

• output_location (oci.ai_document.models.OutputLocation) – The value to assign to the output_location property of this ProcessorJob.

• lifecycle_state (str) – The value to assign to the lifecycle_state property of this ProcessorJob. 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 ProcessorJob. 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’.

property compartment_id

[Required] Gets the compartment_id of this ProcessorJob. The compartment identifier.

Returns

The compartment_id of this ProcessorJob.

Return type

str

property display_name

Gets the display_name of this ProcessorJob. The display name of the processor job.

Returns

The display_name of this ProcessorJob.

Return type

str

property id

[Required] Gets the id of this ProcessorJob. The id of the processor job.

Returns

The id of this ProcessorJob.

Return type

str

property input_location

Gets the input_location of this ProcessorJob.

Returns

The input_location of this ProcessorJob.

Return type

oci.ai_document.models.InputLocation

property lifecycle_details

Gets the lifecycle_details of this ProcessorJob. 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 ProcessorJob.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this ProcessorJob. The current state of the processor 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 ProcessorJob.

Return type

str

property output_location

[Required] Gets the output_location of this ProcessorJob.

Returns

The output_location of this ProcessorJob.

Return type

oci.ai_document.models.OutputLocation

property percent_complete

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

Returns

The percent_complete of this ProcessorJob.

Return type

float

property processor_config

[Required] Gets the processor_config of this ProcessorJob.

Returns

The processor_config of this ProcessorJob.

Return type

oci.ai_document.models.ProcessorConfig

property time_accepted

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

Returns

The time_accepted of this ProcessorJob.

Return type

datetime

property time_finished

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

Returns

The time_finished of this ProcessorJob.

Return type

datetime

property time_started

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

Returns

The time_started of this ProcessorJob.

Return type

datetime