class documentation

class SpaceAllocation(bb.Union): (source)

View In Hierarchy

Space is allocated differently based on the type of account. 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 IndividualSpaceAllocation SpaceAllocation.individual: The user's space allocation applies only to their individual account. :ivar TeamSpaceAllocation SpaceAllocation.team: The user shares space with other members of their team.

Class Method individual Create an instance of this class set to the ``individual`` tag with value ``val``.
Class Method team Create an instance of this class set to the ``team`` tag with value ``val``.
Method get_individual The user's space allocation applies only to their individual account.
Method get_team The user shares space with other members of their team.
Method is_individual Check if the union tag is ``individual``.
Method is_other Check if the union tag is ``other``.
Method is_team Check if the union tag is ``team``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def individual(cls, val): (source)

Create an instance of this class set to the ``individual`` tag with value ``val``. :param IndividualSpaceAllocation val: :rtype: SpaceAllocation

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

Create an instance of this class set to the ``team`` tag with value ``val``. :param TeamSpaceAllocation val: :rtype: SpaceAllocation

def get_individual(self): (source)

The user's space allocation applies only to their individual account. Only call this if :meth:`is_individual` is true. :rtype: IndividualSpaceAllocation

def get_team(self): (source)

The user shares space with other members of their team. Only call this if :meth:`is_team` is true. :rtype: TeamSpaceAllocation

def is_individual(self): (source)

Check if the union tag is ``individual``. :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

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented