sams_client.schemas.assets
– Assets¶
-
class
AssetStates
(DRAFT: str, INTERNAL: str, PUBLIC: str)¶ Named tuple for Asset states
The state of an Asset defines the available actions on it. An Asset can be in any one of the following states:
-
ASSET_STATES
: sams_client.schemas.assets.AssetStates = AssetStates(DRAFT='draft', INTERNAL='internal', PUBLIC='public')¶ Asset states
-
class
IAssetTag
(_typename, _fields=None, /, **kwargs)¶ Tags that can be associated with an Asset
-
class
IAssetRenditionArgs
(_typename, _fields=None, /, **kwargs)¶ Arguments used when requesting a rendition to be created
New in version 0.3.0.
-
class
IAssetRendition
(_typename, _fields=None, /, **kwargs)¶ Asset rendition metadata
New in version 0.3.0.
-
params
: sams_client.schemas.assets.IAssetRenditionArgs¶ Parameters used when this rendition was created
-
versioncreated
: datetime.datetime¶ Date/time this rendition was created
-
-
class
IAsset
(_typename, _fields=None, /, **kwargs)¶ Asset metadata
-
_id
: Union[bson.objectid.ObjectId, str]¶ Globally unique id, generated automatically by the system
-
_media_id
: str¶ Globally unique id for the asset binary. This ID is generated by the StorageProvider
-
original_creator
: str¶ A field to store the id of the user who uploaded the asset
New in version 0.2.0.
-
version_creator
: str¶ A field to store the id of the user who updated the asset
New in version 0.2.0.
-
firstcreated
: datetime.datetime¶ A field to store time, when asset is created
New in version 0.2.0.
-
versioncreated
: datetime.datetime¶ A field to store time, when asset is updated
New in version 0.2.0.
-
set_id
: bson.objectid.ObjectId¶ The ID of the Set where the Asset is to be stored
-
parent_id
: bson.objectid.ObjectId¶ An optional ID of a parent Asset
A list of code/name combinations so Assets can be grouped together through tags
-
binary
: bson.objectid.ObjectId¶ A special case attribute containing the actual binary data to be uploaded. This attribute will be removed from the metadata document before saving/updating
-
lock_session
: str¶ If locked, ID of the exernal user session who locked this asset
New in version 0.2.0.
-
lock_action
: str¶ If locked, name of the action that for this lock (i.e.
edit
)New in version 0.2.0.
-
lock_time
: datetime.datetime¶ If locked, the date and time this asset was locked
New in version 0.2.0.
-
renditions
: List[sams_client.schemas.assets.IAssetRendition]¶ The list of renditions for this Asset (if it is an image)
New in version 0.3.0.
-