class documentation

class GroupsSelector(bb.Union): (source)

View In Hierarchy

Argument for selecting a list of groups, either by group_ids, or external group IDs. 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 list of [str] team.GroupsSelector.group_ids: List of group IDs. :ivar list of [str] team.GroupsSelector.group_external_ids: List of external IDs of groups.

Class Method group_external_ids Create an instance of this class set to the ``group_external_ids`` tag with value ``val``.
Class Method group_ids Create an instance of this class set to the ``group_ids`` tag with value ``val``.
Method get_group_external_ids List of external IDs of groups.
Method get_group_ids List of group IDs.
Method is_group_external_ids Check if the union tag is ``group_external_ids``.
Method is_group_ids Check if the union tag is ``group_ids``.
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def group_external_ids(cls, val): (source)

Create an instance of this class set to the ``group_external_ids`` tag with value ``val``. :param list of [str] val: :rtype: GroupsSelector

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

Create an instance of this class set to the ``group_ids`` tag with value ``val``. :param list of [str] val: :rtype: GroupsSelector

def get_group_external_ids(self): (source)

List of external IDs of groups. Only call this if :meth:`is_group_external_ids` is true. :rtype: list of [str]

def get_group_ids(self): (source)

List of group IDs. Only call this if :meth:`is_group_ids` is true. :rtype: list of [str]

def is_group_external_ids(self): (source)

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

def is_group_ids(self): (source)

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

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

Undocumented

_catch_all = (source)

Undocumented