models_v2.hive_params module

class models_v2.hive_params.HiveParams(hive_object_types=None, search_string=None, source_ids=None)

Bases: object

Implementation of the ‘HiveParams’ model.

Specifies the parameters which are specific for searching Hive objects.

Attributes:

hive_object_types (list of HiveObjectTypeEnum): Specifies one or more

Hive object types be searched.

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

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)

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.