class documentation

class SearchMatchTypeV2(bb.Union): (source)

View In Hierarchy

Indicates what type of match was found for a given item. 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 files.SearchMatchTypeV2.filename: This item was matched on its file or folder name. :ivar files.SearchMatchTypeV2.file_content: This item was matched based on its file contents. :ivar files.SearchMatchTypeV2.filename_and_content: This item was matched based on both its contents and its file name. :ivar files.SearchMatchTypeV2.image_content: This item was matched on image content.

Method is_file_content Check if the union tag is ``file_content``.
Method is_filename Check if the union tag is ``filename``.
Method is_filename_and_content Check if the union tag is ``filename_and_content``.
Method is_image_content Check if the union tag is ``image_content``.
Method is_other Check if the union tag is ``other``.
Class Variable file_content Undocumented
Class Variable filename Undocumented
Class Variable filename_and_content Undocumented
Class Variable image_content Undocumented
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_file_content(self): (source)

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

def is_filename(self): (source)

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

def is_filename_and_content(self): (source)

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

def is_image_content(self): (source)

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

def is_other(self): (source)

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

file_content = (source)

Undocumented

filename = (source)

Undocumented

filename_and_content = (source)

Undocumented

image_content = (source)

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented