filter

Filter

Bases: FilterMetadata

Filter object to interact with filter specific endpoints.

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

global_ class-attribute instance-attribute

global_ = Field(alias='global')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

client class-attribute instance-attribute

client = Field(..., exclude=True)

id instance-attribute

id

Id of Filter.

display_name instance-attribute

display_name

Display name of Filter.

pql instance-attribute

pql

PQL query of Filter.

knowledge_model_id instance-attribute

knowledge_model_id

Id of knowledge model where Filter is located.

from_transport classmethod

from_transport(
    client, knowledge_model_id, filter_transport
)

Creates high-level Filter object from given FilterMetadata.

Parameters:

• client (Client) –

  Client to use to make API calls for given filter.

• knowledge_model_id (str) –

  Id of knowledge model where filter is located.

• filter_transport (FilterMetadata) –

  FilterMetadata object containing properties of filter.

Returns:

• Filter –

  A Filter object with properties from transport and given client.

update

update()

Pushes local changes of filter to EMS and updates properties with response from EMS.

sync

sync()

Syncs filter properties with EMS.

delete

delete()

Deletes filter.