class documentation

class LookupError(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 file_properties.LookupError.not_found: There is nothing at the given path. :ivar file_properties.LookupError.not_file: We were expecting a file, but the given path refers to something that isn't a file. :ivar file_properties.LookupError.not_folder: We were expecting a folder, but the given path refers to something that isn't a folder. :ivar file_properties.LookupError.restricted_content: The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements.

Class Method malformed_path Create an instance of this class set to the ``malformed_path`` tag with value ``val``.
Method get_malformed_path Only call this if :meth:`is_malformed_path` is true.
Method is_malformed_path Check if the union tag is ``malformed_path``.
Method is_not_file Check if the union tag is ``not_file``.
Method is_not_folder Check if the union tag is ``not_folder``.
Method is_not_found Check if the union tag is ``not_found``.
Method is_other Check if the union tag is ``other``.
Method is_restricted_content Check if the union tag is ``restricted_content``.
Class Variable not_file Undocumented
Class Variable not_folder Undocumented
Class Variable not_found Undocumented
Class Variable other Undocumented
Class Variable restricted_content Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def malformed_path(cls, val): (source)

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

def get_malformed_path(self): (source)

Only call this if :meth:`is_malformed_path` is true. :rtype: str

def is_malformed_path(self): (source)

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

def is_not_file(self): (source)

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

def is_not_folder(self): (source)

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

def is_not_found(self): (source)

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

def is_other(self): (source)

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

def is_restricted_content(self): (source)

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

not_file = (source)

Undocumented

not_folder = (source)

Undocumented

not_found = (source)

Undocumented

Undocumented

restricted_content = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented