models_v2.search_files_request_params module

class models_v2.search_files_request_params.SearchFilesRequestParams(search_string=None, types=None, source_environments=None, source_ids=None, object_ids=None)

Bases: object

Implementation of the ‘Search files request params.’ model.

Specifies the request parameters to search for files and file folders.

Attributes:

search_string (string): Specifies the search string to filter the

files. User can specify a wildcard character ‘*’ as a suffix to a string where all files name are matched with the prefix string.

types (list of Type30Enum): Specifies a list of file types. Only files

within the given types will be returned.

source_environments (list of SourceEnvironment1Enum): Specifies a list

of the source environments. Only files from these types of source will be returned.

source_ids (list of long|int): Specifies a list of source ids. Only

files found in these sources will be returned.

object_ids (list of long|int): Specifies a list of object ids. Only

files found in these objects will be returned.

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.