models.file_search_results module

class models.file_search_results.FileSearchResults(files=None, pagination_cookie=None, total_count=None)

Bases: object

Implementation of the ‘FileSearchResults’ model.

Specifies an array of found files and folders. In addition, a count is provided to indicate if additional requests must be made to get the full result.

Attributes:

files (list of FileSearchResult): Array of Files and Folders.

Specifies the list of files and folders returned by this request that match the specified search and filter criteria. The number of files returned is limited by the pageCount field.

pagination_cookie (string): Specifies cookie for resuming search if

pagination is being used. For Librarian queries only.

total_count (long|int): Specifies the total number of files and

folders that match the filter and search criteria. Use this value to determine how many additional requests are required to get the full result.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.