Feedback Edit

ComponentPurgeBodyFilters Class

  • Reference

User-defined filters to return data which will be purged from the table.

Inheritance
Model
ComponentPurgeBodyFilters

Constructor

ComponentPurgeBodyFilters(*, column: Optional[str] = None, operator: Optional[str] = None, value=None, key: Optional[str] = None, **kwargs)

Parameters

column
str
Required

The column of the table over which the given query should run

operator
str
Required

A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query.

value
object
Required

the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values.

key
str
Required

When filtering over custom dimensions, this key will be used as the name of the custom dimension.