> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
> Use this file to discover all available pages before exploring further.

# filter_field

> sift/common/v1/filter_field.proto

<a name="sift_common_v1_filter_field-proto" />

<a name="sift_common_v1_filter_field-proto-services" />

## Services

*RPC methods exposed by this API.*

<a name="sift_common_v1_filter_field-proto-messages" />

## Messages

*Data models used across requests/responses.*

### FilterField

Describes a single field available for CEL filtering on a resource.

| Field         | Type                                | Label    | Description                                                                                                                                                                                                                                                                                                                                                                                                                            |
| :------------ | :---------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| field\_name   | string                              |          | The field name to use in CEL filter expressions (e.g., "run\_id", "created\_date").                                                                                                                                                                                                                                                                                                                                                    |
| type          | [FilterFieldType](#filterfieldtype) |          | The data type of the field. UUID and ENUM are first-class types, so no separate boolean flags are needed.                                                                                                                                                                                                                                                                                                                              |
| enum\_values  | string                              | repeated | If type is FILTER\_FIELD\_TYPE\_ENUM, these are the valid string values.                                                                                                                                                                                                                                                                                                                                                               |
| description   | string                              |          | Human-readable description of the field (e.g., "When the run was created").                                                                                                                                                                                                                                                                                                                                                            |
| display\_name | string                              |          | Human-friendly display name (e.g., "Asset Name" for field\_name "asset\_name").                                                                                                                                                                                                                                                                                                                                                        |
| operators     | string                              | repeated | CEL infix operator tokens valid for this field, e.g. "==", "in". Usually the default set for the field's type, but narrower when the field restricts it. Display copy for each token comes from FilterGrammarService.                                                                                                                                                                                                                  |
| functions     | string                              | repeated | CEL member function names valid for this field, e.g. "contains", "getFullYear". Display copy for each name comes from FilterGrammarService.                                                                                                                                                                                                                                                                                            |
| nullable      | bool                                | optional | Whether the field can compare against null. For a metadata key this is true: a key that is not set on an entity reads as null, so `field == null` matches entities missing the key and `field != null` matches those that have it. (There is no separate "set but null" state, since an assigned metadata value always holds a concrete value.) Optional so that an unset value means "unknown" rather than implicitly "not nullable". |

<a name="sift_common_v1_filter_field-proto-enums" />

## Enums

*Allowed constant values used in message fields.*

### FilterFieldType

Describes the type of a filter field.

| Name                             | Number | Description |
| :------------------------------- | :----- | :---------- |
| FILTER\_FIELD\_TYPE\_UNSPECIFIED | 0      |             |
| FILTER\_FIELD\_TYPE\_STRING      | 1      |             |
| FILTER\_FIELD\_TYPE\_TIMESTAMP   | 2      |             |
| FILTER\_FIELD\_TYPE\_INT         | 3      |             |
| FILTER\_FIELD\_TYPE\_BOOL        | 4      |             |
| FILTER\_FIELD\_TYPE\_DURATION    | 5      |             |
| FILTER\_FIELD\_TYPE\_DOUBLE      | 6      |             |
| FILTER\_FIELD\_TYPE\_ENUM        | 7      |             |
| FILTER\_FIELD\_TYPE\_UUID        | 8      |             |