StreamJob¶

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

Bases: object

Job details for a stream analysis.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a StreamJob.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a StreamJob.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a StreamJob.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a StreamJob.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a StreamJob.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a StreamJob.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a StreamJob.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a StreamJob.
`agent_participant_id`	Gets the agent_participant_id of this StreamJob.
`compartment_id`	[Required] Gets the compartment_id of this StreamJob.
`defined_tags`	Gets the defined_tags of this StreamJob.
`display_name`	Gets the display_name of this StreamJob.
`features`	[Required] Gets the features of this StreamJob.
`freeform_tags`	Gets the freeform_tags of this StreamJob.
`id`	[Required] Gets the id of this StreamJob.
`lifecycle_details`	Gets the lifecycle_details of this StreamJob.
`lifecycle_state`	[Required] Gets the lifecycle_state of this StreamJob.
`stream_output_location`	Gets the stream_output_location of this StreamJob.
`stream_source_id`	[Required] Gets the stream_source_id of this StreamJob.
`system_tags`	Gets the system_tags of this StreamJob.
`time_created`	[Required] Gets the time_created of this StreamJob.
`time_updated`	Gets the time_updated of this StreamJob.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a StreamJob. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a StreamJob. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a StreamJob. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a StreamJob. This constant has a value of “DELETING”

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a StreamJob. 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 StreamJob. 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 StreamJob. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new StreamJob 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 StreamJob.
stream_source_id (str) – The value to assign to the stream_source_id property of this StreamJob.
compartment_id (str) – The value to assign to the compartment_id property of this StreamJob.
display_name (str) – The value to assign to the display_name property of this StreamJob.
features (list[oci.ai_vision.models.VideoStreamFeature]) – The value to assign to the features property of this StreamJob.
stream_output_location (oci.ai_vision.models.StreamOutputLocation) – The value to assign to the stream_output_location property of this StreamJob.
agent_participant_id (str) – The value to assign to the agent_participant_id property of this StreamJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this StreamJob. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, “NEEDS_ATTENTION”, ‘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 StreamJob.
time_created (datetime) – The value to assign to the time_created property of this StreamJob.
time_updated (datetime) – The value to assign to the time_updated property of this StreamJob.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this StreamJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this StreamJob.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this StreamJob.

agent_participant_id¶

Gets the agent_participant_id of this StreamJob. participant id of agent where results need to be sent

Returns:	The agent_participant_id of this StreamJob.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this StreamJob. OCID of compartment

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

defined_tags¶

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

display_name¶

Gets the display_name of this StreamJob. Stream job display name.

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

features¶

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

Returns:	The features of this StreamJob.
Return type:	list[oci.ai_vision.models.VideoStreamFeature]

freeform_tags¶

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

id¶

[Required] Gets the id of this StreamJob. OCID of the streamJob.

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

lifecycle_details¶

Gets the lifecycle_details of this StreamJob. Additional details about current state of streamJob

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this StreamJob. The current state of the Stream job.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

stream_output_location¶

Gets the stream_output_location of this StreamJob.

Returns:	The stream_output_location of this StreamJob.
Return type:	oci.ai_vision.models.StreamOutputLocation

stream_source_id¶

[Required] Gets the stream_source_id of this StreamJob. OCID of the streamSource

Returns:	The stream_source_id of this StreamJob.
Return type:	str

system_tags¶

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

time_created¶

[Required] Gets the time_created of this StreamJob. When the streamJob was created, as an RFC3339 datetime string.

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

time_updated¶

Gets the time_updated of this StreamJob. When the stream job was updated, as an RFC3339 datetime string.

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