models_v2.filter module

class models_v2.filter.Filter(filter_string=None, is_regular_expression=False)

Bases: object

Implementation of the ‘Filter’ model.

Specifies the filter details.

Attributes:

filter_string (string): Specifies the filter string using wildcard

supported strings or regular expressions.

is_regular_expression (bool): Specifies whether the provided filter

string is a regular expression or not. This need to be explicitly set to true if user is trying to filter by regular expressions. Not providing this value in case of regular expression can result in unintended results. The default value is assumed to be false.

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.