VideoJob

class oci.ai_vision.models.VideoJob(**kwargs)

Bases: object

Job details for a video analysis.

Attributes:

LIFECYCLE_DETAILS_COMPLETELY_FAILED

A constant which can be used with the lifecycle_details property of a VideoJob.

LIFECYCLE_DETAILS_PARTIALLY_SUCCEEDED

A constant which can be used with the lifecycle_details property of a VideoJob.

LIFECYCLE_STATE_ACCEPTED

A constant which can be used with the lifecycle_state property of a VideoJob.

LIFECYCLE_STATE_CANCELED

A constant which can be used with the lifecycle_state property of a VideoJob.

LIFECYCLE_STATE_CANCELING

A constant which can be used with the lifecycle_state property of a VideoJob.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a VideoJob.

LIFECYCLE_STATE_IN_PROGRESS

A constant which can be used with the lifecycle_state property of a VideoJob.

LIFECYCLE_STATE_SUCCEEDED

A constant which can be used with the lifecycle_state property of a VideoJob.

compartment_id

[Required] Gets the compartment_id of this VideoJob.

defined_tags

Gets the defined_tags of this VideoJob.

display_name

Gets the display_name of this VideoJob.

features

[Required] Gets the features of this VideoJob.

freeform_tags

Gets the freeform_tags of this VideoJob.

id

[Required] Gets the id of this VideoJob.

input_location

Gets the input_location of this VideoJob.

lifecycle_details

Gets the lifecycle_details of this VideoJob.

lifecycle_state

[Required] Gets the lifecycle_state of this VideoJob.

output_location

[Required] Gets the output_location of this VideoJob.

percent_complete

Gets the percent_complete of this VideoJob.

system_tags

Gets the system_tags of this VideoJob.

time_accepted

[Required] Gets the time_accepted of this VideoJob.

time_finished

Gets the time_finished of this VideoJob.

time_started

Gets the time_started of this VideoJob.

Methods:

__init__(**kwargs)

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

LIFECYCLE_STATE_CANCELED = 'CANCELED'

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

LIFECYCLE_STATE_CANCELING = 'CANCELING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

__init__(**kwargs)

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

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

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

  • features (list[oci.ai_vision.models.VideoFeature]) – The value to assign to the features property of this VideoJob.

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

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

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

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

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

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

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

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VideoJob.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VideoJob.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VideoJob.

property compartment_id

[Required] Gets the compartment_id of this VideoJob. The ocid of the compartment that starts the job.

Returns

The compartment_id of this VideoJob.

Return type

str

property defined_tags

Gets the defined_tags of this VideoJob. Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this VideoJob.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this VideoJob. Video job display name.

Returns

The display_name of this VideoJob.

Return type

str

property features

[Required] Gets the features of this VideoJob. a list of document analysis features.

Returns

The features of this VideoJob.

Return type

list[oci.ai_vision.models.VideoFeature]

property freeform_tags

Gets the freeform_tags of this VideoJob. A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {“bar-key”: “value”}

Returns

The freeform_tags of this VideoJob.

Return type

dict(str, str)

property id

[Required] Gets the id of this VideoJob. Id of the job.

Returns

The id of this VideoJob.

Return type

str

property input_location

Gets the input_location of this VideoJob.

Returns

The input_location of this VideoJob.

Return type

oci.ai_vision.models.InputLocation

property lifecycle_details

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

Return type

str

property lifecycle_state

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

Return type

str

property output_location

[Required] Gets the output_location of this VideoJob.

Returns

The output_location of this VideoJob.

Return type

oci.ai_vision.models.OutputLocation

property percent_complete

Gets the percent_complete of this VideoJob. How much progress the operation has made, vs the total amount of work that must be performed.

Returns

The percent_complete of this VideoJob.

Return type

float

property system_tags

Gets the system_tags of this VideoJob. Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this VideoJob.

Return type

dict(str, dict(str, object))

property time_accepted

[Required] Gets the time_accepted of this VideoJob. Job accepted time.

Returns

The time_accepted of this VideoJob.

Return type

datetime

property time_finished

Gets the time_finished of this VideoJob. Job finished time.

Returns

The time_finished of this VideoJob.

Return type

datetime

property time_started

Gets the time_started of this VideoJob. Job started time.

Returns

The time_started of this VideoJob.

Return type

datetime