class documentation

class AccessMethodLogInfo(bb.Union): (source)

View In Hierarchy

Indicates the method in which the action was performed. 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 WebSessionLogInfo AccessMethodLogInfo.admin_console: Admin console session details. :ivar ApiSessionLogInfo AccessMethodLogInfo.api: Api session details. :ivar WebSessionLogInfo AccessMethodLogInfo.content_manager: Content manager session details. :ivar SessionLogInfo AccessMethodLogInfo.end_user: End user session details. :ivar WebSessionLogInfo AccessMethodLogInfo.enterprise_console: Enterprise console session details. :ivar WebSessionLogInfo AccessMethodLogInfo.sign_in_as: Sign in as session details.

Class Method admin_console Create an instance of this class set to the ``admin_console`` tag with value ``val``.
Class Method api Create an instance of this class set to the ``api`` tag with value ``val``.
Class Method content_manager Create an instance of this class set to the ``content_manager`` tag with value ``val``.
Class Method end_user Create an instance of this class set to the ``end_user`` tag with value ``val``.
Class Method enterprise_console Create an instance of this class set to the ``enterprise_console`` tag with value ``val``.
Class Method sign_in_as Create an instance of this class set to the ``sign_in_as`` tag with value ``val``.
Method get_admin_console Admin console session details.
Method get_api Api session details.
Method get_content_manager Content manager session details.
Method get_end_user End user session details.
Method get_enterprise_console Enterprise console session details.
Method get_sign_in_as Sign in as session details.
Method is_admin_console Check if the union tag is ``admin_console``.
Method is_api Check if the union tag is ``api``.
Method is_content_manager Check if the union tag is ``content_manager``.
Method is_end_user Check if the union tag is ``end_user``.
Method is_enterprise_console Check if the union tag is ``enterprise_console``.
Method is_other Check if the union tag is ``other``.
Method is_sign_in_as Check if the union tag is ``sign_in_as``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def admin_console(cls, val): (source)

Create an instance of this class set to the ``admin_console`` tag with value ``val``. :param WebSessionLogInfo val: :rtype: AccessMethodLogInfo

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

Create an instance of this class set to the ``api`` tag with value ``val``. :param ApiSessionLogInfo val: :rtype: AccessMethodLogInfo

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

Create an instance of this class set to the ``content_manager`` tag with value ``val``. :param WebSessionLogInfo val: :rtype: AccessMethodLogInfo

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

Create an instance of this class set to the ``end_user`` tag with value ``val``. :param SessionLogInfo val: :rtype: AccessMethodLogInfo

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

Create an instance of this class set to the ``enterprise_console`` tag with value ``val``. :param WebSessionLogInfo val: :rtype: AccessMethodLogInfo

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

Create an instance of this class set to the ``sign_in_as`` tag with value ``val``. :param WebSessionLogInfo val: :rtype: AccessMethodLogInfo

def get_admin_console(self): (source)

Admin console session details. Only call this if :meth:`is_admin_console` is true. :rtype: WebSessionLogInfo

def get_api(self): (source)

Api session details. Only call this if :meth:`is_api` is true. :rtype: ApiSessionLogInfo

def get_content_manager(self): (source)

Content manager session details. Only call this if :meth:`is_content_manager` is true. :rtype: WebSessionLogInfo

def get_end_user(self): (source)

End user session details. Only call this if :meth:`is_end_user` is true. :rtype: SessionLogInfo

def get_enterprise_console(self): (source)

Enterprise console session details. Only call this if :meth:`is_enterprise_console` is true. :rtype: WebSessionLogInfo

def get_sign_in_as(self): (source)

Sign in as session details. Only call this if :meth:`is_sign_in_as` is true. :rtype: WebSessionLogInfo

def is_admin_console(self): (source)

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

def is_api(self): (source)

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

def is_content_manager(self): (source)

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

def is_end_user(self): (source)

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

def is_enterprise_console(self): (source)

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

def is_other(self): (source)

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

def is_sign_in_as(self): (source)

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

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented