class documentation

class AssetLogInfo(bb.Union): (source)

View In Hierarchy

Asset details. This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar FileLogInfo AssetLogInfo.file: File's details. :ivar FolderLogInfo AssetLogInfo.folder: Folder's details. :ivar PaperDocumentLogInfo AssetLogInfo.paper_document: Paper document's details. :ivar PaperFolderLogInfo AssetLogInfo.paper_folder: Paper folder's details. :ivar ShowcaseDocumentLogInfo AssetLogInfo.showcase_document: Showcase document's details.

Class Method file Create an instance of this class set to the ``file`` tag with value ``val``.
Class Method folder Create an instance of this class set to the ``folder`` tag with value ``val``.
Class Method paper_document Create an instance of this class set to the ``paper_document`` tag with value ``val``.
Class Method paper_folder Create an instance of this class set to the ``paper_folder`` tag with value ``val``.
Class Method showcase_document Create an instance of this class set to the ``showcase_document`` tag with value ``val``.
Method get_file File's details.
Method get_folder Folder's details.
Method get_paper_document Paper document's details.
Method get_paper_folder Paper folder's details.
Method get_showcase_document Showcase document's details.
Method is_file Check if the union tag is ``file``.
Method is_folder Check if the union tag is ``folder``.
Method is_other Check if the union tag is ``other``.
Method is_paper_document Check if the union tag is ``paper_document``.
Method is_paper_folder Check if the union tag is ``paper_folder``.
Method is_showcase_document Check if the union tag is ``showcase_document``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def file(cls, val): (source)

Create an instance of this class set to the ``file`` tag with value ``val``. :param FileLogInfo val: :rtype: AssetLogInfo

@classmethod
def folder(cls, val): (source)

Create an instance of this class set to the ``folder`` tag with value ``val``. :param FolderLogInfo val: :rtype: AssetLogInfo

@classmethod
def paper_document(cls, val): (source)

Create an instance of this class set to the ``paper_document`` tag with value ``val``. :param PaperDocumentLogInfo val: :rtype: AssetLogInfo

@classmethod
def paper_folder(cls, val): (source)

Create an instance of this class set to the ``paper_folder`` tag with value ``val``. :param PaperFolderLogInfo val: :rtype: AssetLogInfo

@classmethod
def showcase_document(cls, val): (source)

Create an instance of this class set to the ``showcase_document`` tag with value ``val``. :param ShowcaseDocumentLogInfo val: :rtype: AssetLogInfo

def get_file(self): (source)

File's details. Only call this if :meth:`is_file` is true. :rtype: FileLogInfo

def get_folder(self): (source)

Folder's details. Only call this if :meth:`is_folder` is true. :rtype: FolderLogInfo

def get_paper_document(self): (source)

Paper document's details. Only call this if :meth:`is_paper_document` is true. :rtype: PaperDocumentLogInfo

def get_paper_folder(self): (source)

Paper folder's details. Only call this if :meth:`is_paper_folder` is true. :rtype: PaperFolderLogInfo

def get_showcase_document(self): (source)

Showcase document's details. Only call this if :meth:`is_showcase_document` is true. :rtype: ShowcaseDocumentLogInfo

def is_file(self): (source)

Check if the union tag is ``file``. :rtype: bool

def is_folder(self): (source)

Check if the union tag is ``folder``. :rtype: bool

def is_other(self): (source)

Check if the union tag is ``other``. :rtype: bool

def is_paper_document(self): (source)

Check if the union tag is ``paper_document``. :rtype: bool

def is_paper_folder(self): (source)

Check if the union tag is ``paper_folder``. :rtype: bool

def is_showcase_document(self): (source)

Check if the union tag is ``showcase_document``. :rtype: bool

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_catch_all: str = (source)

Undocumented