class documentation

class GroupSelector(bb.Union): (source)

View In Hierarchy

Argument for selecting a single group, either by group_id or by external group ID. 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 str team.GroupSelector.group_id: Group ID. :ivar str team.GroupSelector.group_external_id: External ID of the group.

Class Method group_external_id Create an instance of this class set to the ``group_external_id`` tag with value ``val``.
Class Method group_id Create an instance of this class set to the ``group_id`` tag with value ``val``.
Method get_group_external_id External ID of the group.
Method get_group_id Group ID.
Method is_group_external_id Check if the union tag is ``group_external_id``.
Method is_group_id Check if the union tag is ``group_id``.
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def group_external_id(cls, val): (source)

Create an instance of this class set to the ``group_external_id`` tag with value ``val``. :param str val: :rtype: GroupSelector

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

Create an instance of this class set to the ``group_id`` tag with value ``val``. :param str val: :rtype: GroupSelector

def get_group_external_id(self): (source)

External ID of the group. Only call this if :meth:`is_group_external_id` is true. :rtype: str

def get_group_id(self): (source)

Group ID. Only call this if :meth:`is_group_id` is true. :rtype: str

def is_group_external_id(self): (source)

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

def is_group_id(self): (source)

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

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

Undocumented

_catch_all = (source)

Undocumented