dropbox.sharing.GetFileMetadataIndividualResult

class documentation

class GetFileMetadataIndividualResult(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 SharedFileMetadata GetFileMetadataIndividualResult.metadata: The result for this file if it was successful. :ivar SharingFileAccessError GetFileMetadataIndividualResult.access_error: The result for this file if it was an error.

Class Method access_error Create an instance of this class set to the ``access_error`` tag with value ``val``.
Class Method metadata Create an instance of this class set to the ``metadata`` tag with value ``val``.
Method get_access_error The result for this file if it was an error.
Method get_metadata The result for this file if it was successful.
Method is_access_error Check if the union tag is ``access_error``.
Method is_metadata Check if the union tag is ``metadata``.
Method is_other Check if the union tag is ``other``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def access_error(cls, val): (source)

Create an instance of this class set to the ``access_error`` tag with value ``val``. :param SharingFileAccessError val: :rtype: GetFileMetadataIndividualResult

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

Create an instance of this class set to the ``metadata`` tag with value ``val``. :param SharedFileMetadata val: :rtype: GetFileMetadataIndividualResult

def get_access_error(self): (source)

The result for this file if it was an error. Only call this if :meth:`is_access_error` is true. :rtype: SharingFileAccessError

def get_metadata(self): (source)

The result for this file if it was successful. Only call this if :meth:`is_metadata` is true. :rtype: SharedFileMetadata

def is_access_error(self): (source)

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

def is_metadata(self): (source)

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

def is_other(self): (source)

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

other = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented