StreamGroup¶
- class oci.ai_vision.models.StreamGroup(**kwargs)¶
Bases:
objectDetails for a Stream Group
Attributes:
A constant which can be used with the lifecycle_state property of a StreamGroup.
A constant which can be used with the lifecycle_state property of a StreamGroup.
A constant which can be used with the lifecycle_state property of a StreamGroup.
A constant which can be used with the lifecycle_state property of a StreamGroup.
A constant which can be used with the lifecycle_state property of a StreamGroup.
A constant which can be used with the lifecycle_state property of a StreamGroup.
[Required] Gets the compartment_id of this StreamGroup.
Gets the defined_tags of this StreamGroup.
Gets the display_name of this StreamGroup.
Gets the freeform_tags of this StreamGroup.
[Required] Gets the id of this StreamGroup.
Gets the is_enabled of this StreamGroup.
Gets the lifecycle_state of this StreamGroup.
Gets the stream_overlaps of this StreamGroup.
Gets the stream_source_ids of this StreamGroup.
Gets the system_tags of this StreamGroup.
Gets the time_created of this StreamGroup.
Gets the time_updated of this StreamGroup.
Methods:
__init__(**kwargs)Initializes a new StreamGroup object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a StreamGroup. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a StreamGroup. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a StreamGroup. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a StreamGroup. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a StreamGroup. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a StreamGroup. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new StreamGroup 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 StreamGroup.
compartment_id (str) – The value to assign to the compartment_id property of this StreamGroup.
display_name (str) – The value to assign to the display_name property of this StreamGroup.
time_created (datetime) – The value to assign to the time_created property of this StreamGroup.
time_updated (datetime) – The value to assign to the time_updated property of this StreamGroup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this StreamGroup. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_enabled (bool) – The value to assign to the is_enabled property of this StreamGroup.
stream_source_ids (list[str]) – The value to assign to the stream_source_ids property of this StreamGroup.
stream_overlaps (list[oci.ai_vision.models.StreamGroupOverlap]) – The value to assign to the stream_overlaps property of this StreamGroup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this StreamGroup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this StreamGroup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this StreamGroup.
- property compartment_id¶
[Required] Gets the compartment_id of this StreamGroup. OCID of compartment
- Returns
The compartment_id of this StreamGroup.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this StreamGroup. 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 StreamGroup.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this StreamGroup. A human-friendly name for the streamGroup.
- Returns
The display_name of this StreamGroup.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this StreamGroup. 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 StreamGroup.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this StreamGroup. OCID of the streamGroup.
- Returns
The id of this StreamGroup.
- Return type
str
- property is_enabled¶
Gets the is_enabled of this StreamGroup. Stream
- Returns
The is_enabled of this StreamGroup.
- Return type
bool
- property lifecycle_state¶
Gets the lifecycle_state of this StreamGroup. The current state of the streamGroup.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this StreamGroup.
- Return type
str
- property stream_overlaps¶
Gets the stream_overlaps of this StreamGroup. List of streamSource OCIDs where the streamSource overlaps in field of view.
- Returns
The stream_overlaps of this StreamGroup.
- Return type
- property stream_source_ids¶
Gets the stream_source_ids of this StreamGroup. List of streamSource OCIDs associated with the stream group
- Returns
The stream_source_ids of this StreamGroup.
- Return type
list[str]
- property system_tags¶
Gets the system_tags of this StreamGroup. 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 StreamGroup.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this StreamGroup. When the streamGroup was created, as an RFC3339 datetime string.
- Returns
The time_created of this StreamGroup.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this StreamGroup. When the streamGroup was updated, as an RFC3339 datetime string.
- Returns
The time_updated of this StreamGroup.
- Return type
datetime