Package com.google.cloud.firestore.pipeline.expressions

Class Field

java.lang.Object

com.google.cloud.firestore.pipeline.expressions.Expression

com.google.cloud.firestore.pipeline.expressions.Field

All Implemented Interfaces:

Selectable

public final class Field
extends Expression
implements Selectable

Represents a reference to a field in a Firestore document.

Field references are used to access document field values in expressions and to specify fields for sorting, filtering, and projecting data in Firestore pipelines.

You can create a `Field` instance using the static Expression.field(String) method:

 // Create a Field instance for the 'name' field
 Field nameField = Field.of("name");

 // Create a Field instance for a nested field 'address.city'
 Field cityField = Field.of("address.city");
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOCUMENT_ID

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Expression	geoDistance(GeoPoint location)	Evaluates to the distance in meters between the location specified by this field and the query location.
FieldPath	getPath()
int	hashCode()
static Field	ofServerPath(String path)
static Field	ofUserPath(String path)	Creates a Field instance representing the field at the given path.
Value	toProto()

Methods inherited from class com.google.cloud.firestore.pipeline.expressions.Expression

abs, abs, abs, add, add, add, add, add, and, array, array, arrayAgg, arrayAggDistinct, arrayConcat, arrayConcat, arrayConcat, arrayContains, arrayContains, arrayContains, arrayContains, arrayContains, arrayContainsAll, arrayContainsAll, arrayContainsAll, arrayContainsAll, arrayContainsAll, arrayContainsAll, arrayContainsAny, arrayContainsAny, arrayContainsAny, arrayContainsAny, arrayContainsAny, arrayContainsAny, arrayFilter, arrayFilter, arrayFilter, arrayFirst, arrayFirst, arrayFirst, arrayFirstN, arrayFirstN, arrayFirstN, arrayFirstN, arrayFirstN, arrayFirstN, arrayGet, arrayGet, arrayGet, arrayGet, arrayGet, arrayGet, arrayIndexOf, arrayIndexOf, arrayIndexOf, arrayIndexOf, arrayIndexOf, arrayIndexOf, arrayIndexOfAll, arrayIndexOfAll, arrayIndexOfAll, arrayIndexOfAll, arrayIndexOfAll, arrayIndexOfAll, arrayLast, arrayLast, arrayLast, arrayLastIndexOf, arrayLastIndexOf, arrayLastIndexOf, arrayLastIndexOf, arrayLastIndexOf, arrayLastIndexOf, arrayLastN, arrayLastN, arrayLastN, arrayLastN, arrayLastN, arrayLastN, arrayLength, arrayLength, arrayLength, arrayMaximum, arrayMaximum, arrayMaximum, arrayMaximumN, arrayMaximumN, arrayMaximumN, arrayMaximumN, arrayMaximumN, arrayMaximumN, arrayMinimum, arrayMinimum, arrayMinimum, arrayMinimumN, arrayMinimumN, arrayMinimumN, arrayMinimumN, arrayMinimumN, arrayMinimumN, arrayReverse, arrayReverse, arrayReverse, arraySlice, arraySlice, arraySlice, arraySlice, arraySlice, arraySlice, arraySliceToEnd, arraySliceToEnd, arraySliceToEnd, arraySliceToEnd, arraySliceToEnd, arraySliceToEnd, arraySum, arraySum, arraySum, arrayTransform, arrayTransform, arrayTransform, arrayTransformWithIndex, arrayTransformWithIndex, arrayTransformWithIndex, as, ascending, average, between, between, byteLength, byteLength, byteLength, ceil, ceil, ceil, charLength, charLength, charLength, coalesce, coalesce, coalesce, collectionId, collectionId, collectionId, concat, concat, concat, conditional, conditional, constant, constant, constant, constant, constant, constant, constant, constant, constant, constant, cosineDistance, cosineDistance, cosineDistance, cosineDistance, cosineDistance, cosineDistance, count, countDistinct, currentDocument, currentTimestamp, descending, divide, divide, divide, divide, divide, documentId, documentId, documentId, documentId, documentMatches, dotProduct, dotProduct, dotProduct, dotProduct, dotProduct, dotProduct, endsWith, endsWith, endsWith, endsWith, endsWith, equal, equal, equal, equal, equal, equalAny, equalAny, equalAny, equalAny, equalAny, euclideanDistance, euclideanDistance, euclideanDistance, euclideanDistance, euclideanDistance, euclideanDistance, exists, exists, exists, exp, exp, exp, field, field, first, floor, floor, floor, geoDistance, geoDistance, getField, getField, getField, getField, getField, getField, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThanOrEqual, greaterThanOrEqual, greaterThanOrEqual, greaterThanOrEqual, greaterThanOrEqual, ifAbsent, ifAbsent, ifAbsent, ifAbsent, ifAbsent, ifError, ifError, ifError, ifError, ifError, ifNull, ifNull, ifNull, ifNull, ifNull, isAbsent, isAbsent, isAbsent, isError, isError, isNaN, isNotNaN, isNotNaN, isNotNaN, isNotNull, isNull, isType, isType, isType, join, join, join, join, join, join, last, length, length, length, lessThan, lessThan, lessThan, lessThan, lessThan, lessThanOrEqual, lessThanOrEqual, lessThanOrEqual, lessThanOrEqual, lessThanOrEqual, like, like, like, like, like, ln, ln, ln, log, log, log, log, log10, log10, log10, logicalMaximum, logicalMaximum, logicalMaximum, logicalMinimum, logicalMinimum, logicalMinimum, ltrim, ltrim, ltrim, ltrimValue, ltrimValue, ltrimValue, ltrimValue, ltrimValue, ltrimValue, map, mapEntries, mapEntries, mapEntries, mapGet, mapGet, mapGet, mapGet, mapGet, mapKeys, mapKeys, mapKeys, mapMerge, mapMerge, mapMerge, mapMerge, mapMerge, mapRemove, mapRemove, mapRemove, mapRemove, mapRemove, mapRemove, mapSet, mapSet, mapSet, mapSet, mapSet, mapSet, mapValues, mapValues, mapValues, maximum, minimum, mod, mod, mod, mod, mod, multiply, multiply, multiply, multiply, multiply, nor, not, notEqual, notEqual, notEqual, notEqual, notEqual, notEqualAny, notEqualAny, notEqualAny, notEqualAny, notEqualAny, nullValue, or, parent, parent, parent, parent, pow, pow, pow, pow, pow, pow, rand, rawExpression, regexContains, regexContains, regexContains, regexContains, regexContains, regexFind, regexFind, regexFind, regexFind, regexFind, regexFindAll, regexFindAll, regexFindAll, regexFindAll, regexFindAll, regexMatch, regexMatch, regexMatch, regexMatch, regexMatch, reverse, reverse, reverse, round, round, round, roundToPrecision, roundToPrecision, roundToPrecision, roundToPrecision, roundToPrecision, roundToPrecision, rtrim, rtrim, rtrim, rtrimValue, rtrimValue, rtrimValue, rtrimValue, rtrimValue, rtrimValue, score, split, split, split, split, split, split, sqrt, sqrt, sqrt, startsWith, startsWith, startsWith, startsWith, startsWith, stringConcat, stringConcat, stringConcat, stringConcat, stringContains, stringContains, stringContains, stringContains, stringContains, stringIndexOf, stringIndexOf, stringIndexOf, stringIndexOf, stringIndexOf, stringIndexOf, stringRepeat, stringRepeat, stringRepeat, stringRepeat, stringRepeat, stringRepeat, stringReplaceAll, stringReplaceAll, stringReplaceAll, stringReplaceAll, stringReplaceAll, stringReplaceAll, stringReplaceOne, stringReplaceOne, stringReplaceOne, stringReplaceOne, stringReplaceOne, stringReplaceOne, substring, substring, substring, subtract, subtract, subtract, subtract, subtract, sum, switchOn, timestampAdd, timestampAdd, timestampAdd, timestampAdd, timestampAdd, timestampAdd, timestampDiff, timestampDiff, timestampDiff, timestampDiff, timestampDiff, timestampDiff, timestampDiff, timestampDiff, timestampExtract, timestampExtract, timestampExtract, timestampExtract, timestampExtract, timestampExtract, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampExtractWithTimezone, timestampSubtract, timestampSubtract, timestampSubtract, timestampSubtract, timestampSubtract, timestampSubtract, timestampToUnixMicros, timestampToUnixMicros, timestampToUnixMicros, timestampToUnixMillis, timestampToUnixMillis, timestampToUnixMillis, timestampToUnixSeconds, timestampToUnixSeconds, timestampToUnixSeconds, timestampTruncate, timestampTruncate, timestampTruncate, timestampTruncate, timestampTruncate, timestampTruncate, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, timestampTruncateWithTimezone, toLower, toLower, toLower, toUpper, toUpper, toUpper, trim, trim, trim, trimValue, trimValue, trimValue, trimValue, trimValue, trimValue, trunc, trunc, trunc, truncToPrecision, truncToPrecision, truncToPrecision, truncToPrecision, truncToPrecision, truncToPrecision, type, type, type, unixMicrosToTimestamp, unixMicrosToTimestamp, unixMicrosToTimestamp, unixMillisToTimestamp, unixMillisToTimestamp, unixMillisToTimestamp, unixSecondsToTimestamp, unixSecondsToTimestamp, unixSecondsToTimestamp, variable, vectorLength, vectorLength, vectorLength, xor

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

DOCUMENT_ID

public static final String DOCUMENT_ID

See Also:

• Constant Field Values

Method Details

ofUserPath

@InternalApi
public static Field ofUserPath(String path)

Creates a Field instance representing the field at the given path.

The path can be a simple field name (e.g., "name") or a dot-separated path to a nested field (e.g., "address.city").

Example:

 // Create a Field instance for the 'title' field
 Field titleField = Field.of("title");

 // Create a Field instance for a nested field 'author.firstName'
 Field authorFirstNameField = Field.of("author.firstName");
 

Parameters:

path - The path to the field.

Returns:

A new Field instance representing the specified field.

ofServerPath

@InternalApi
public static Field ofServerPath(String path)

toProto

@InternalApi
public Value toProto()

geoDistance

@BetaApi
public Expression geoDistance(GeoPoint location)

Evaluates to the distance in meters between the location specified by this field and the query location.

This Expression can only be used within a Search stage.

Parameters:

location - Compute distance to this GeoPoint.

Returns:

A new Expression representing the geoDistance operation.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getPath

@InternalApi
public FieldPath getPath()