StreamJobSummary¶

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

Bases: object

Job details for a stream analysis.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this StreamJobSummary.
`defined_tags`	Gets the defined_tags of this StreamJobSummary.
`display_name`	Gets the display_name of this StreamJobSummary.
`features`	[Required] Gets the features of this StreamJobSummary.
`freeform_tags`	Gets the freeform_tags of this StreamJobSummary.
`id`	[Required] Gets the id of this StreamJobSummary.
`lifecycle_details`	[Required] Gets the lifecycle_details of this StreamJobSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this StreamJobSummary.
`stream_output_location`	Gets the stream_output_location of this StreamJobSummary.
`stream_source_id`	[Required] Gets the stream_source_id of this StreamJobSummary.
`system_tags`	Gets the system_tags of this StreamJobSummary.
`time_created`	[Required] Gets the time_created of this StreamJobSummary.
`time_updated`	Gets the time_updated of this StreamJobSummary.

__init__(**kwargs)¶

Initializes a new StreamJobSummary 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 StreamJobSummary.
stream_source_id (str) – The value to assign to the stream_source_id property of this StreamJobSummary.
compartment_id (str) – The value to assign to the compartment_id property of this StreamJobSummary.
display_name (str) – The value to assign to the display_name property of this StreamJobSummary.
features (list[oci.ai_vision.models.VideoStreamFeature]) – The value to assign to the features property of this StreamJobSummary.
stream_output_location (oci.ai_vision.models.StreamOutputLocation) – The value to assign to the stream_output_location property of this StreamJobSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this StreamJobSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this StreamJobSummary.
time_created (datetime) – The value to assign to the time_created property of this StreamJobSummary.
time_updated (datetime) – The value to assign to the time_updated property of this StreamJobSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this StreamJobSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this StreamJobSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this StreamJobSummary.

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

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

features¶

[Required] Gets the features of this StreamJobSummary. List of document analysis features.

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

freeform_tags¶

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

id¶

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

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

lifecycle_details¶

[Required] Gets the lifecycle_details of this StreamJobSummary. Additional Details of the state of streamJob

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

lifecycle_state¶

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

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

stream_output_location¶

Gets the stream_output_location of this StreamJobSummary.

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

stream_source_id¶

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

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

system_tags¶

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

time_created¶

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

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

time_updated¶

Gets the time_updated of this StreamJobSummary. When the streamJob was updated, as an RFC3339 datetime string.

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