class documentation

class ContextLogInfo(bb.Union): (source)

View In Hierarchy

The primary entity on which the action was done. 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 team_log.ContextLogInfo.anonymous: Anonymous context. :ivar NonTeamMemberLogInfo ContextLogInfo.non_team_member: Action was done on behalf of a non team member. :ivar TeamLogInfo ContextLogInfo.organization_team: Action was done on behalf of a team that's part of an organization. :ivar team_log.ContextLogInfo.team: Action was done on behalf of the team. :ivar TeamMemberLogInfo ContextLogInfo.team_member: Action was done on behalf of a team member. :ivar TrustedNonTeamMemberLogInfo ContextLogInfo.trusted_non_team_member: Action was done on behalf of a trusted non team member.

Class Method non_team_member Create an instance of this class set to the ``non_team_member`` tag with value ``val``.
Class Method organization_team Create an instance of this class set to the ``organization_team`` tag with value ``val``.
Class Method team_member Create an instance of this class set to the ``team_member`` tag with value ``val``.
Class Method trusted_non_team_member Create an instance of this class set to the ``trusted_non_team_member`` tag with value ``val``.
Method get_non_team_member Action was done on behalf of a non team member.
Method get_organization_team Action was done on behalf of a team that's part of an organization.
Method get_team_member Action was done on behalf of a team member.
Method get_trusted_non_team_member Action was done on behalf of a trusted non team member.
Method is_anonymous Check if the union tag is ``anonymous``.
Method is_non_team_member Check if the union tag is ``non_team_member``.
Method is_organization_team Check if the union tag is ``organization_team``.
Method is_other Check if the union tag is ``other``.
Method is_team Check if the union tag is ``team``.
Method is_team_member Check if the union tag is ``team_member``.
Method is_trusted_non_team_member Check if the union tag is ``trusted_non_team_member``.
Class Variable anonymous Undocumented
Class Variable other Undocumented
Class Variable team Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def non_team_member(cls, val): (source)

Create an instance of this class set to the ``non_team_member`` tag with value ``val``. :param NonTeamMemberLogInfo val: :rtype: ContextLogInfo

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

Create an instance of this class set to the ``organization_team`` tag with value ``val``. :param TeamLogInfo val: :rtype: ContextLogInfo

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

Create an instance of this class set to the ``team_member`` tag with value ``val``. :param TeamMemberLogInfo val: :rtype: ContextLogInfo

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

Create an instance of this class set to the ``trusted_non_team_member`` tag with value ``val``. :param TrustedNonTeamMemberLogInfo val: :rtype: ContextLogInfo

def get_non_team_member(self): (source)

Action was done on behalf of a non team member. Only call this if :meth:`is_non_team_member` is true. :rtype: NonTeamMemberLogInfo

def get_organization_team(self): (source)

Action was done on behalf of a team that's part of an organization. Only call this if :meth:`is_organization_team` is true. :rtype: TeamLogInfo

def get_team_member(self): (source)

Action was done on behalf of a team member. Only call this if :meth:`is_team_member` is true. :rtype: TeamMemberLogInfo

def get_trusted_non_team_member(self): (source)

Action was done on behalf of a trusted non team member. Only call this if :meth:`is_trusted_non_team_member` is true. :rtype: TrustedNonTeamMemberLogInfo

def is_anonymous(self): (source)

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

def is_non_team_member(self): (source)

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

def is_organization_team(self): (source)

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

def is_other(self): (source)

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

def is_team(self): (source)

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

def is_team_member(self): (source)

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

def is_trusted_non_team_member(self): (source)

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

anonymous = (source)

Undocumented

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented