models_v2.mongodb_params module¶
-
class
models_v2.mongodb_params.
MongodbParams
(search_string=None, mongo_db_object_types=None, source_ids=None)[source]¶ Bases:
object
Implementation of the ‘MongodbParams’ model.
Specifies the parameters which are specific for searching MongoDB objects.
- Attributes:
- mongo_db_object_types (list of MongoDBObjectTypeEnum): Specifies one
or more MongoDB object types be searched.
- search_string (string): Specifies the search string to search the
MongoDB Objects
- source_ids (list of long|int): Specifies a list of source ids. Only
objects found in these sources will be returned.
-
classmethod
from_dictionary
(dictionary)[source]¶ 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.