Criteria

JSON representation
StringArray
- JSON representation
IntRangeArray
- JSON representation
IntRange
- JSON representation
FloatRangeArray
- JSON representation
FloatRange
- JSON representation
GeoLocationArray
- JSON representation
CircleArea
- JSON representation
BoolValue
- JSON representation

Filter criteria applied to current search results.

JSON representation

JSON representation
{ "field" : string , "fetchMatchedAnnotations" : boolean , // Union field `value` can be only one of the following: "textArray" : { object ( `StringArray` ) } , "intRangeArray" : { object ( `IntRangeArray` ) } , "floatRangeArray" : { object ( `FloatRangeArray` ) } , "dateTimeRangeArray" : { object ( `DateTimeRangeArray` ) } , "geoLocationArray" : { object ( `GeoLocationArray` ) } , "boolValue" : { object ( `BoolValue` ) } // End of list of possible types for union field `value` . }

 { 
 "field" 
 : 
 string 
 , 
 "fetchMatchedAnnotations" 
 : 
 boolean 
 , 
 // Union field value 
can be only one of the following: 
 "textArray" 
 : 
 { 
 object (  StringArray 
 
) 
 } 
 , 
 "intRangeArray" 
 : 
 { 
 object (  IntRangeArray 
 
) 
 } 
 , 
 "floatRangeArray" 
 : 
 { 
 object (  FloatRangeArray 
 
) 
 } 
 , 
 "dateTimeRangeArray" 
 : 
 { 
 object (  DateTimeRangeArray 
 
) 
 } 
 , 
 "geoLocationArray" 
 : 
 { 
 object (  GeoLocationArray 
 
) 
 } 
 , 
 "boolValue" 
 : 
 { 
 object (  BoolValue 
 
) 
 } 
 // End of list of possible types for union field value 
. 
 }

Fields

field

string

The UGA field or ML field to apply filtering criteria.

fetchMatchedAnnotations

boolean

If true, return query matched annotations for this criteria. This option is only applicable for inclusion criteria, i.e., not exclusion criteria, with partition level annotations. It supports the following data types: - INTEGER - FLOAT - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) - BOOLEAN

Union field value .

value can be only one of the following:

textArray

object ( StringArray )

The text values associated with the field.

intRangeArray

object ( IntRangeArray )

The integer ranges associated with the field.

floatRangeArray

object ( FloatRangeArray )

The float ranges associated with the field.

dateTimeRangeArray

object ( DateTimeRangeArray )

The datetime ranges associated with the field.

geoLocationArray

object ( GeoLocationArray )

Geo Location array.

boolValue

object ( BoolValue )

A Boolean value.

StringArray

A list of string-type values.

JSON representation
{ "txtValues" : [ string ] }

Fields

Fields
`txtValues[]`	`string` String type values.

txtValues[]

string

String type values.

IntRangeArray

A list of integer range values.

JSON representation
{ "intRanges" : [ { object ( `IntRange` ) } ] }

Fields

Fields
`intRanges[]`	`object ( IntRange )` Int range values.

intRanges[]

object ( IntRange )

Int range values.

IntRange

Integer range type.

JSON representation
{ "start" : string , "end" : string }

Fields

Fields
`start`	`string ( int64 format)` Start of the int range.
`end`	`string ( int64 format)` End of the int range.

start

string ( int64 format)

Start of the int range.

end

string ( int64 format)

End of the int range.

FloatRangeArray

A list of float range values.

JSON representation
{ "floatRanges" : [ { object ( `FloatRange` ) } ] }

Fields

Fields
`floatRanges[]`	`object ( FloatRange )` Float range values.

floatRanges[]

object ( FloatRange )

Float range values.

FloatRange

Float range type.

JSON representation
{ "start" : number , "end" : number }

Fields

Fields
`start`	`number` Start of the float range.
`end`	`number` End of the float range.

start

number

Start of the float range.

end

number

End of the float range.

GeoLocationArray

A list of locations.

JSON representation
{ "circleAreas" : [ { object ( `CircleArea` ) } ] }

Fields

Fields
`circleAreas[]`	`object ( CircleArea )` A list of circle areas.

circleAreas[]

object ( CircleArea )

A list of circle areas.

CircleArea

Representation of a circle area.

JSON representation
{ "latitude" : number , "longitude" : number , "radiusMeter" : number }

Fields

Fields
`latitude`	`number` Latitude of circle area's center. Degrees [-90 .. 90]
`longitude`	`number` Longitude of circle area's center. Degrees [-180 .. 180]
`radiusMeter`	`number` Radius of the circle area in meters.

latitude

number

Latitude of circle area's center. Degrees [-90 .. 90]

longitude

number

Longitude of circle area's center. Degrees [-180 .. 180]

radiusMeter

number

Radius of the circle area in meters.

BoolValue

JSON representation
{ "value" : boolean }

Fields
`value`	`boolean`