The types of filters used to restrict the resources returned from a query. Value is one of:
TYPE: Filter by resource type.
ID: Filter by resource identifier.
PROPERTY: Filter by condition on a resource model property value.
COMPOSITE: A composition of multiple filters.

Optional. It is only relevant when filter_type has value TYPE. This field is optional and it is only relevant when the value of filter_type is TYPE.

Optional. It is only relevant when filter_type has value ID. This field is optional and it is only relevant when the value of filter_type is ID.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.

For instance, it could be used to match all com.acme.Person resources which have property name starting with John or property gender equal to male.

Optional. It is only relevant when filter_type has value PROPERTY. This field is optional and it is only relevant when the value of filter_type is PROPERTY.

Each property specification begins with the fully-qualified name of the resource model that declares the property, followed by the name of the property. The property name could be either a single property name, in case of an immediate property of the resource model or a property path, i.e. chain of property names, separated with / symbol to indicate a child property, e.g. com.acme.PersonModel/relatives/father.

In case the property filter needs to be defined on a property of a related resource, the path should be equal to the -> separated concatenation of the following:

1. Specification of the property that holds the identifier (id) of the related resource in the target resource model.
2. Specification of the desired property to compare in the related resource model.

In case the property of a related entity of a related entity (i.e. multi-hop relationship) should be compared, another path could be added and so on. For instance: com.acme.PersonModel/relatives/father->com.acme.PersonModel/relatives/mother->com.acme.PersonModel/name.

Defines the possible operators to use when comparing the values of individual resource model properties.

When comparing values of different types, one of the values can be promoted from one type to another (if needed in order to perform correct comparison) according to the following rules:

• When comparing numeric values, a comparable of type long could be promoted (converted) to type double. The result value will be the same as the original value.
• When comparing to a boolean value, a comparable of type string can be promoted to boolean if the value is parsable to boolean, i.e. either false or true in lower case.

For instance, the comparable value powered will match property whose value is poweredOn or poweredOff, but it will not match isPoweredOn.

For instance, the comparable value On will match property whose value is poweredOn, but it will not match poweredOff.

For instance, a property with value isPoweredOn will be matched by comparable values like powered, On or isPoweredOn.

The types of properties that can be used for comparison in a property filter. Value is one of:
LONG: Property value of long type.
DOUBLE: Property value of double type.
BOOLEAN: Property value of boolean type.
STRING: Property value of string type.
ID: Property value which represents a resource identifier

Optional. It is only relevant when comparable_type has value LONG. This field is optional and it is only relevant when the value of comparable_type is LONG.

Optional. It is only relevant when comparable_type has value DOUBLE. This field is optional and it is only relevant when the value of comparable_type is DOUBLE.

Optional. It is only relevant when comparable_type has value BOOLEAN. This field is optional and it is only relevant when the value of comparable_type is BOOLEAN.

Optional. It is only relevant when comparable_type has value STRING. This field is optional and it is only relevant when the value of comparable_type is STRING.

Optional. It is only relevant when comparable_type has value ID. This field is optional and it is only relevant when the value of comparable_type is ID.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.

Optional. It is only relevant when filter_type has value COMPOSITE. This field is optional and it is only relevant when the value of filter_type is COMPOSITE.

Defines the possible operators that can be used to combine multiple resource filters. Value is one of:
INTERSECT: Intersects the resource sets identified by the constituent filters.
UNION: Unions the resource sets identified by the constituent filters.

Each property specification begins with the fully-qualified name of the resource model that declares the property, followed by the name of the property. The property name could be either a single property name, in case of an immediate property of the resource model or a property path, i.e. chain of property names, separated with / symbol to indicate a child property, e.g. com.acme.PersonModel/relatives/father.

Optional. If unset, no properties will be returned but only the identifiers of the matched resources.

Optional. If unset, no sorting will be applied.

Each property specification begins with the fully-qualified name of the resource model that declares the property, followed by the name of the property. The property name could be either a single property name, in case of an immediate property of the resource model or a property path, i.e. chain of property names, separated with / symbol to indicate a child property, e.g. com.acme.PersonModel/relatives/father.

Optional. If unset, defaults to ASCENDING.

If the offset is N then items from N to N + limit - 1 will be returned.

Optional. If unset, defaults to 0.

Note that the service defines its own default limit that cannot be overriden here. If the specified value here is above that limit, an vapi.std.errors.invalid_argument error will be thrown for the particular query in order to indicate this violation.

Optional. If unset, a default limit will be automatically assigned.

NOTE: Use this with particular caution and only when it's absolutely needed as the computation of this value could have noticeable performance overhead.

Optional. If unset, defaults to false.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.

Optional. Will be returned only if explicitly specified in the query.