MediaAsset¶
- class oci.media_services.models.MediaAsset(**kwargs)¶
Bases:
objectRepresents the metadata associated with an asset that has been either produced by or registered with Media Services.
Attributes:
A constant which can be used with the lifecycle_state property of a MediaAsset.
A constant which can be used with the lifecycle_state property of a MediaAsset.
A constant which can be used with the lifecycle_state property of a MediaAsset.
A constant which can be used with the lifecycle_state property of a MediaAsset.
A constant which can be used with the lifecycle_state property of a MediaAsset.
A constant which can be used with the lifecycle_state property of a MediaAsset.
A constant which can be used with the type property of a MediaAsset.
A constant which can be used with the type property of a MediaAsset.
A constant which can be used with the type property of a MediaAsset.
A constant which can be used with the type property of a MediaAsset.
A constant which can be used with the type property of a MediaAsset.
A constant which can be used with the type property of a MediaAsset.
Gets the bucket_name of this MediaAsset.
[Required] Gets the compartment_id of this MediaAsset.
Gets the defined_tags of this MediaAsset.
Gets the display_name of this MediaAsset.
Gets the freeform_tags of this MediaAsset.
[Required] Gets the id of this MediaAsset.
[Required] Gets the lifecycle_state of this MediaAsset.
Gets the locks of this MediaAsset.
Gets the master_media_asset_id of this MediaAsset.
Gets the media_asset_tags of this MediaAsset.
Gets the media_workflow_job_id of this MediaAsset.
Gets the metadata of this MediaAsset.
Gets the namespace_name of this MediaAsset.
Gets the object_etag of this MediaAsset.
Gets the object_name of this MediaAsset.
Gets the parent_media_asset_id of this MediaAsset.
Gets the segment_range_end_index of this MediaAsset.
Gets the segment_range_start_index of this MediaAsset.
Gets the source_media_workflow_id of this MediaAsset.
Gets the source_media_workflow_version of this MediaAsset.
Gets the system_tags of this MediaAsset.
Gets the time_created of this MediaAsset.
Gets the time_updated of this MediaAsset.
[Required] Gets the type of this MediaAsset.
Methods:
__init__(**kwargs)Initializes a new MediaAsset object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a MediaAsset. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a MediaAsset. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a MediaAsset. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a MediaAsset. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a MediaAsset. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a MediaAsset. This constant has a value of “UPDATING”
- TYPE_AUDIO = 'AUDIO'¶
A constant which can be used with the type property of a MediaAsset. This constant has a value of “AUDIO”
- TYPE_CAPTION_FILE = 'CAPTION_FILE'¶
A constant which can be used with the type property of a MediaAsset. This constant has a value of “CAPTION_FILE”
- TYPE_IMAGE = 'IMAGE'¶
A constant which can be used with the type property of a MediaAsset. This constant has a value of “IMAGE”
- TYPE_PLAYLIST = 'PLAYLIST'¶
A constant which can be used with the type property of a MediaAsset. This constant has a value of “PLAYLIST”
- TYPE_UNKNOWN = 'UNKNOWN'¶
A constant which can be used with the type property of a MediaAsset. This constant has a value of “UNKNOWN”
- TYPE_VIDEO = 'VIDEO'¶
A constant which can be used with the type property of a MediaAsset. This constant has a value of “VIDEO”
- __init__(**kwargs)¶
Initializes a new MediaAsset 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 MediaAsset.
compartment_id (str) – The value to assign to the compartment_id property of this MediaAsset.
source_media_workflow_id (str) – The value to assign to the source_media_workflow_id property of this MediaAsset.
media_workflow_job_id (str) – The value to assign to the media_workflow_job_id property of this MediaAsset.
source_media_workflow_version (int) – The value to assign to the source_media_workflow_version property of this MediaAsset.
display_name (str) – The value to assign to the display_name property of this MediaAsset.
time_created (datetime) – The value to assign to the time_created property of this MediaAsset.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MediaAsset. 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’.
type (str) – The value to assign to the type property of this MediaAsset. Allowed values for this property are: “AUDIO”, “VIDEO”, “PLAYLIST”, “IMAGE”, “CAPTION_FILE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
parent_media_asset_id (str) – The value to assign to the parent_media_asset_id property of this MediaAsset.
master_media_asset_id (str) – The value to assign to the master_media_asset_id property of this MediaAsset.
bucket_name (str) – The value to assign to the bucket_name property of this MediaAsset.
namespace_name (str) – The value to assign to the namespace_name property of this MediaAsset.
object_name (str) – The value to assign to the object_name property of this MediaAsset.
object_etag (str) – The value to assign to the object_etag property of this MediaAsset.
time_updated (datetime) – The value to assign to the time_updated property of this MediaAsset.
segment_range_start_index (int) – The value to assign to the segment_range_start_index property of this MediaAsset.
segment_range_end_index (int) – The value to assign to the segment_range_end_index property of this MediaAsset.
metadata (list[oci.media_services.models.Metadata]) – The value to assign to the metadata property of this MediaAsset.
media_asset_tags (list[oci.media_services.models.MediaAssetTag]) – The value to assign to the media_asset_tags property of this MediaAsset.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MediaAsset.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MediaAsset.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MediaAsset.
locks (list[oci.media_services.models.ResourceLock]) – The value to assign to the locks property of this MediaAsset.
- property bucket_name¶
Gets the bucket_name of this MediaAsset. The name of the object storage bucket where this represented asset is located.
- Returns
The bucket_name of this MediaAsset.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this MediaAsset. The ID of the compartment containing the MediaAsset.
- Returns
The compartment_id of this MediaAsset.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this MediaAsset. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this MediaAsset.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this MediaAsset. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this MediaAsset.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this MediaAsset. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this MediaAsset.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this MediaAsset. Unique identifier that is immutable on creation.
- Returns
The id of this MediaAsset.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this MediaAsset. The current state of the MediaAsset.
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 MediaAsset.
- Return type
str
- property locks¶
Gets the locks of this MediaAsset. Locks associated with this resource.
- Returns
The locks of this MediaAsset.
- Return type
- property master_media_asset_id¶
Gets the master_media_asset_id of this MediaAsset. The ID of the senior most asset from which this asset is derived.
- Returns
The master_media_asset_id of this MediaAsset.
- Return type
str
- property media_asset_tags¶
Gets the media_asset_tags of this MediaAsset. List of tags for the MediaAsset.
- Returns
The media_asset_tags of this MediaAsset.
- Return type
- property media_workflow_job_id¶
Gets the media_workflow_job_id of this MediaAsset. The ID of the MediaWorkflowJob used to produce this asset.
- Returns
The media_workflow_job_id of this MediaAsset.
- Return type
str
- property metadata¶
Gets the metadata of this MediaAsset. List of Metadata.
- Returns
The metadata of this MediaAsset.
- Return type
- property namespace_name¶
Gets the namespace_name of this MediaAsset. The object storage namespace where this asset is located.
- Returns
The namespace_name of this MediaAsset.
- Return type
str
- property object_etag¶
Gets the object_etag of this MediaAsset. eTag of the underlying object storage object.
- Returns
The object_etag of this MediaAsset.
- Return type
str
- property object_name¶
Gets the object_name of this MediaAsset. The object storage object name that identifies this asset.
- Returns
The object_name of this MediaAsset.
- Return type
str
- property parent_media_asset_id¶
Gets the parent_media_asset_id of this MediaAsset. The ID of the parent asset from which this asset is derived.
- Returns
The parent_media_asset_id of this MediaAsset.
- Return type
str
- property segment_range_end_index¶
Gets the segment_range_end_index of this MediaAsset. The end index of video segment files.
- Returns
The segment_range_end_index of this MediaAsset.
- Return type
int
- property segment_range_start_index¶
Gets the segment_range_start_index of this MediaAsset. The start index for video segment files.
- Returns
The segment_range_start_index of this MediaAsset.
- Return type
int
- property source_media_workflow_id¶
Gets the source_media_workflow_id of this MediaAsset. The ID of the MediaWorkflow used to produce this asset.
- Returns
The source_media_workflow_id of this MediaAsset.
- Return type
str
- property source_media_workflow_version¶
Gets the source_media_workflow_version of this MediaAsset. The version of the MediaWorkflow used to produce this asset.
- Returns
The source_media_workflow_version of this MediaAsset.
- Return type
int
- property system_tags¶
Gets the system_tags of this MediaAsset. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this MediaAsset.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this MediaAsset. The time when the MediaAsset was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this MediaAsset.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this MediaAsset. The time when the MediaAsset was updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this MediaAsset.
- Return type
datetime
- property type¶
[Required] Gets the type of this MediaAsset. The type of the media asset.
Allowed values for this property are: “AUDIO”, “VIDEO”, “PLAYLIST”, “IMAGE”, “CAPTION_FILE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this MediaAsset.
- Return type
str