class documentation

class SharingAllowlistAddError(bb.Union): (source)

View In Hierarchy

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.SharingAllowlistAddError.malformed_entry: One of provided values is not valid. :ivar team.SharingAllowlistAddError.no_entries_provided: Neither single domain nor email provided. :ivar team.SharingAllowlistAddError.too_many_entries_provided: Too many entries provided within one call. :ivar team.SharingAllowlistAddError.team_limit_reached: Team entries limit reached. :ivar team.SharingAllowlistAddError.unknown_error: Unknown error. :ivar str team.SharingAllowlistAddError.entries_already_exist: Entries already exists.

Class Method entries_already_exist Create an instance of this class set to the ``entries_already_exist`` tag with value ``val``.
Class Method malformed_entry Create an instance of this class set to the ``malformed_entry`` tag with value ``val``.
Method get_entries_already_exist Entries already exists.
Method get_malformed_entry One of provided values is not valid.
Method is_entries_already_exist Check if the union tag is ``entries_already_exist``.
Method is_malformed_entry Check if the union tag is ``malformed_entry``.
Method is_no_entries_provided Check if the union tag is ``no_entries_provided``.
Method is_other Check if the union tag is ``other``.
Method is_team_limit_reached Check if the union tag is ``team_limit_reached``.
Method is_too_many_entries_provided Check if the union tag is ``too_many_entries_provided``.
Method is_unknown_error Check if the union tag is ``unknown_error``.
Class Variable no_entries_provided Undocumented
Class Variable other Undocumented
Class Variable team_limit_reached Undocumented
Class Variable too_many_entries_provided Undocumented
Class Variable unknown_error Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def entries_already_exist(cls, val): (source)

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

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

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

def get_entries_already_exist(self): (source)

Entries already exists. Only call this if :meth:`is_entries_already_exist` is true. :rtype: str

def get_malformed_entry(self): (source)

One of provided values is not valid. Only call this if :meth:`is_malformed_entry` is true. :rtype: str

def is_entries_already_exist(self): (source)

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

def is_malformed_entry(self): (source)

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

def is_no_entries_provided(self): (source)

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

def is_other(self): (source)

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

def is_team_limit_reached(self): (source)

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

def is_too_many_entries_provided(self): (source)

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

def is_unknown_error(self): (source)

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

no_entries_provided = (source)

Undocumented

Undocumented

team_limit_reached = (source)

Undocumented

too_many_entries_provided = (source)

Undocumented

unknown_error = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented