class documentation

class FileErrorResult(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 sharing.FileErrorResult.file_not_found_error: File specified by id was not found. :ivar str sharing.FileErrorResult.invalid_file_action_error: User does not have permission to take the specified action on the file. :ivar str sharing.FileErrorResult.permission_denied_error: User does not have permission to access file specified by file.Id.

Class Method file_not_found_error Create an instance of this class set to the ``file_not_found_error`` tag with value ``val``.
Class Method invalid_file_action_error Create an instance of this class set to the ``invalid_file_action_error`` tag with value ``val``.
Class Method permission_denied_error Create an instance of this class set to the ``permission_denied_error`` tag with value ``val``.
Method get_file_not_found_error File specified by id was not found.
Method get_invalid_file_action_error User does not have permission to take the specified action on the file.
Method get_permission_denied_error User does not have permission to access file specified by file.Id.
Method is_file_not_found_error Check if the union tag is ``file_not_found_error``.
Method is_invalid_file_action_error Check if the union tag is ``invalid_file_action_error``.
Method is_other Check if the union tag is ``other``.
Method is_permission_denied_error Check if the union tag is ``permission_denied_error``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def file_not_found_error(cls, val): (source)

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

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

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

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

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

def get_file_not_found_error(self): (source)

File specified by id was not found. Only call this if :meth:`is_file_not_found_error` is true. :rtype: str

def get_invalid_file_action_error(self): (source)

User does not have permission to take the specified action on the file. Only call this if :meth:`is_invalid_file_action_error` is true. :rtype: str

def get_permission_denied_error(self): (source)

User does not have permission to access file specified by file.Id. Only call this if :meth:`is_permission_denied_error` is true. :rtype: str

def is_file_not_found_error(self): (source)

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

def is_invalid_file_action_error(self): (source)

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

def is_other(self): (source)

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

def is_permission_denied_error(self): (source)

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

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented