Uses of Class
com.google.cloud.firestore.pipeline.expressions.Expression

Packages that use Expression

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

Uses of Expression in com.google.cloud.firestore

Methods in com.google.cloud.firestore that return types with arguments of type Expression

Modifier and Type	Method	Description
static Map<String,Expression>	PipelineUtils.fieldNamesToMap(String... fields)
static Map<String,Expression>	PipelineUtils.selectablesToMap(Selectable... selectables)

Methods in com.google.cloud.firestore with parameters of type Expression

Modifier and Type	Method	Description
static Value	PipelineUtils.encodeValue(Expression value)
Pipeline	Pipeline.findNearest(Expression property, double[] vector, FindNearest.DistanceMeasure distanceMeasure, FindNearestOptions options)	Performs vector distance (similarity) search with given parameters to the stage inputs.
Pipeline	Pipeline.replaceWith(Expression expr)	Fully overwrites all fields in a document with those coming from a nested map.

Uses of Expression in com.google.cloud.firestore.pipeline.expressions

Subclasses of Expression in com.google.cloud.firestore.pipeline.expressions

Modifier and Type	Class	Description
class	BooleanExpression
final class	Field	Represents a reference to a field in a Firestore document.
class	FunctionExpression

Methods in com.google.cloud.firestore.pipeline.expressions that return Expression

Modifier and Type	Method	Description
final Expression	Expression.abs()	Creates an expression that returns the absolute value of this numeric expression.
static Expression	Expression.abs(Expression numericExpr)	Creates an expression that returns the absolute value of numericExpr.
static Expression	Expression.abs(String numericField)	Creates an expression that returns the absolute value of numericField.
static Expression	Expression.add(Expression first, Expression second)	Creates an expression that adds numeric expressions.
static Expression	Expression.add(Expression first, Number second)	Creates an expression that adds numeric expressions with a constant.
final Expression	Expression.add(Object other)	Creates an expression that adds this numeric expression to another numeric expression.
static Expression	Expression.add(String fieldName, Expression second)	Creates an expression that adds a numeric field with a numeric expression.
static Expression	Expression.add(String fieldName, Number second)	Creates an expression that adds a numeric field with constant.
static Expression	Expression.array(Object... elements)	Creates an expression that creates a Firestore array value from an input object.
static Expression	Expression.array(List<Object> elements)	Creates an expression that creates a Firestore array value from an input object.
final Expression	Expression.arrayConcat(Expression... otherArrays)	Creates an expression that concatenates a field's array value with other arrays.
static Expression	Expression.arrayConcat(Expression firstArray, Object... otherArrays)	Creates an expression that concatenates multiple arrays into a single array.
static Expression	Expression.arrayConcat(String firstArrayField, Object... otherArrays)	Creates an expression that concatenates multiple arrays into a single array.
final Expression	Expression.arrayFirst()	Returns the first element of an array.
static Expression	Expression.arrayFirst(Expression array)	Creates an expression that returns the first element of an array.
static Expression	Expression.arrayFirst(String arrayFieldName)	Creates an expression that returns the first element of an array.
final Expression	Expression.arrayFirstN(int n)	Returns the first n elements of an array.
final Expression	Expression.arrayFirstN(Expression n)	Returns the first n elements of an array.
static Expression	Expression.arrayFirstN(Expression array, int n)	Creates an expression that returns the first n elements of an array.
static Expression	Expression.arrayFirstN(Expression array, Expression n)	Creates an expression that returns the first n elements of an array.
static Expression	Expression.arrayFirstN(String arrayFieldName, int n)	Creates an expression that returns the first n elements of an array.
static Expression	Expression.arrayFirstN(String arrayFieldName, Expression n)	Creates an expression that returns the first n elements of an array.
final Expression	Expression.arrayGet(int offset)	Creates an expression that indexes into an array from the beginning or end and return the element.
final Expression	Expression.arrayGet(Expression offset)	Creates an expression that indexes into an array from the beginning or end and return the element.
static Expression	Expression.arrayGet(Expression array, int offset)	Creates an expression that returns an element from an array at a specified index.
static Expression	Expression.arrayGet(Expression array, Expression offset)	Creates an expression that returns an element from an array at a specified index.
static Expression	Expression.arrayGet(String arrayFieldName, int offset)	Creates an expression that returns an element from an array at a specified index.
static Expression	Expression.arrayGet(String arrayFieldName, Expression offset)	Creates an expression that returns an element from an array at a specified index.
final Expression	Expression.arrayIndexOf(Expression value)	Returns the index of the first occurrence of a value in an array.
static Expression	Expression.arrayIndexOf(Expression array, Expression value)	Creates an expression that returns the index of the first occurrence of a value in an array.
static Expression	Expression.arrayIndexOf(Expression array, Object value)	Creates an expression that returns the index of the first occurrence of a value in an array.
final Expression	Expression.arrayIndexOf(Object value)	Returns the index of the first occurrence of a value in an array.
static Expression	Expression.arrayIndexOf(String arrayFieldName, Expression value)	Creates an expression that returns the index of the first occurrence of a value in an array.
static Expression	Expression.arrayIndexOf(String arrayFieldName, Object value)	Creates an expression that returns the index of the first occurrence of a value in an array.
final Expression	Expression.arrayIndexOfAll(Expression value)	Returns all indices of a value in an array.
static Expression	Expression.arrayIndexOfAll(Expression array, Expression value)	Creates an expression that returns all indices of a value in an array.
static Expression	Expression.arrayIndexOfAll(Expression array, Object value)	Creates an expression that returns all indices of a value in an array.
final Expression	Expression.arrayIndexOfAll(Object value)	Returns all indices of a value in an array.
static Expression	Expression.arrayIndexOfAll(String arrayFieldName, Expression value)	Creates an expression that returns all indices of a value in an array.
static Expression	Expression.arrayIndexOfAll(String arrayFieldName, Object value)	Creates an expression that returns all indices of a value in an array.
final Expression	Expression.arrayLast()	Returns the last element of an array.
static Expression	Expression.arrayLast(Expression array)	Creates an expression that returns the last element of an array.
static Expression	Expression.arrayLast(String arrayFieldName)	Creates an expression that returns the last element of an array.
final Expression	Expression.arrayLastIndexOf(Expression value)	Returns the index of the last occurrence of a value in an array.
static Expression	Expression.arrayLastIndexOf(Expression array, Expression value)	Creates an expression that returns the index of the last occurrence of a value in an array.
static Expression	Expression.arrayLastIndexOf(Expression array, Object value)	Creates an expression that returns the index of the last occurrence of a value in an array.
final Expression	Expression.arrayLastIndexOf(Object value)	Returns the index of the last occurrence of a value in an array.
static Expression	Expression.arrayLastIndexOf(String arrayFieldName, Expression value)	Creates an expression that returns the index of the last occurrence of a value in an array.
static Expression	Expression.arrayLastIndexOf(String arrayFieldName, Object value)	Creates an expression that returns the index of the last occurrence of a value in an array.
final Expression	Expression.arrayLastN(int n)	Returns the last n elements of an array.
final Expression	Expression.arrayLastN(Expression n)	Returns the last n elements of an array.
static Expression	Expression.arrayLastN(Expression array, int n)	Creates an expression that returns the last n elements of an array.
static Expression	Expression.arrayLastN(Expression array, Expression n)	Creates an expression that returns the last n elements of an array.
static Expression	Expression.arrayLastN(String arrayFieldName, int n)	Creates an expression that returns the last n elements of an array.
static Expression	Expression.arrayLastN(String arrayFieldName, Expression n)	Creates an expression that returns the last n elements of an array.
final Expression	Expression.arrayLength()	Creates an expression that calculates the length of an array expression.
static Expression	Expression.arrayLength(Expression array)	Creates an expression that returns the length of an array.
static Expression	Expression.arrayLength(String arrayFieldName)	Creates an expression that returns the length of an array.
final Expression	Expression.arrayMaximum()	Returns the maximum value of an array.
static Expression	Expression.arrayMaximum(Expression array)	Creates an expression that returns the maximum value of an array.
static Expression	Expression.arrayMaximum(String arrayFieldName)	Creates an expression that returns the maximum value of an array.
final Expression	Expression.arrayMaximumN(int n)	Returns the n maximum values of an array.
final Expression	Expression.arrayMaximumN(Expression n)	Returns the n maximum values of an array.
static Expression	Expression.arrayMaximumN(Expression array, int n)	Creates an expression that returns the n maximum values of an array.
static Expression	Expression.arrayMaximumN(Expression array, Expression n)	Creates an expression that returns the n maximum values of an array.
static Expression	Expression.arrayMaximumN(String arrayFieldName, int n)	Creates an expression that returns the n maximum values of an array.
static Expression	Expression.arrayMaximumN(String arrayFieldName, Expression n)	Creates an expression that returns the n maximum values of an array.
final Expression	Expression.arrayMinimum()	Returns the minimum value of an array.
static Expression	Expression.arrayMinimum(Expression array)	Creates an expression that returns the minimum value of an array.
static Expression	Expression.arrayMinimum(String arrayFieldName)	Creates an expression that returns the minimum value of an array.
final Expression	Expression.arrayMinimumN(int n)	Returns the n minimum values of an array.
final Expression	Expression.arrayMinimumN(Expression n)	Returns the n minimum values of an array.
static Expression	Expression.arrayMinimumN(Expression array, int n)	Creates an expression that returns the n minimum values of an array.
static Expression	Expression.arrayMinimumN(Expression array, Expression n)	Creates an expression that returns the n minimum values of an array.
static Expression	Expression.arrayMinimumN(String arrayFieldName, int n)	Creates an expression that returns the n minimum values of an array.
static Expression	Expression.arrayMinimumN(String arrayFieldName, Expression n)	Creates an expression that returns the n minimum values of an array.
final Expression	Expression.arrayReverse()	Reverses the order of elements in the array.
static Expression	Expression.arrayReverse(Expression array)	Creates an expression that reverses an array.
static Expression	Expression.arrayReverse(String arrayFieldName)	Creates an expression that reverses an array.
Expression	Expression.arraySum()	Creates an expression that returns the sum of the elements of this array expression.
static Expression	Expression.arraySum(Expression array)	Creates an expression that returns the sum of the elements of an array.
static Expression	Expression.arraySum(String arrayFieldName)	Creates an expression that returns the sum of the elements of an array.
final Expression	Expression.byteLength()	Creates an expression that calculates the length of a string in UTF-8 bytes, or just the length of a Blob.
static Expression	Expression.byteLength(Expression string)	Creates an expression that calculates the length of a string in UTF-8 bytes, or just the length of a Blob.
static Expression	Expression.byteLength(String fieldName)	Creates an expression that calculates the length of a string represented by a field in UTF-8 bytes, or just the length of a Blob.
final Expression	Expression.ceil()	Creates an expression that returns the smallest integer that isn't less than this numeric expression.
static Expression	Expression.ceil(Expression numericExpr)	Creates an expression that returns the smallest integer that isn't less than numericExpr.
static Expression	Expression.ceil(String numericField)	Creates an expression that returns the smallest integer that isn't less than numericField.
final Expression	Expression.charLength()	Creates an expression that calculates the character length of this string expression in UTF8.
static Expression	Expression.charLength(Expression string)	Creates an expression that calculates the character length of a string expression in UTF8.
static Expression	Expression.charLength(String fieldName)	Creates an expression that calculates the character length of a string field in UTF8.
final Expression	Expression.collectionId()	Creates an expression that returns the collection ID from this path expression.
static Expression	Expression.collectionId(Expression path)	Creates an expression that returns the collection ID from a path.
static Expression	Expression.collectionId(String pathFieldName)	Creates an expression that returns the collection ID from a path.
static Expression	Expression.concat(Expression first, Object... others)	Creates an expression that concatenates expressions together.
Expression	Expression.concat(Object... others)	Creates an expression that concatenates this expression with other values.
static Expression	Expression.concat(String fieldName, Object... others)	Creates an expression that concatenates expressions together.
final Expression	BooleanExpression.conditional(Expression thenExpr, Expression elseExpr)	Creates a conditional expression that evaluates to a thenExpr expression if this condition is true or an elseExpr expression if the condition is false.
final Expression	BooleanExpression.conditional(Object thenValue, Object elseValue)	Creates a conditional expression that evaluates to a thenValue if this condition is true or an elseValue if the condition is false.
static Expression	Expression.conditional(BooleanExpression condition, Expression thenExpr, Expression elseExpr)	Creates a conditional expression that evaluates to a thenExpr expression if a condition is true or an elseExpr expression if the condition is false.
static Expression	Expression.conditional(BooleanExpression condition, Object thenValue, Object elseValue)	Creates a conditional expression that evaluates to a thenValue if a condition is true or an elseValue if the condition is false.
static Expression	Expression.constant(byte[] value)	Create a constant for a bytes value.
static Expression	Expression.constant(Blob value)	Create a constant for a Blob value.
static Expression	Expression.constant(DocumentReference value)	Create a constant for a DocumentReference value.
static Expression	Expression.constant(GeoPoint value)	Create a constant for a GeoPoint value.
static Expression	Expression.constant(VectorValue value)	Create a constant for a VectorValue value.
static Expression	Expression.constant(com.google.cloud.Timestamp value)	Create a constant for a Timestamp value.
static Expression	Expression.constant(Number value)	Create a constant for a Number value.
static Expression	Expression.constant(String value)	Create a constant for a String value.
static Expression	Expression.constant(Date value)	Create a constant for a Date value.
final Expression	Expression.cosineDistance(double[] vector)	Calculates the Cosine distance between this vector expression and a vector literal.
final Expression	Expression.cosineDistance(Expression vector)	Calculates the Cosine distance between this and another vector expressions.
static Expression	Expression.cosineDistance(Expression vector1, double[] vector2)	Creates an expression that calculates the cosine distance between two vectors.
static Expression	Expression.cosineDistance(Expression vector1, Expression vector2)	Creates an expression that calculates the cosine distance between two vectors.
static Expression	Expression.cosineDistance(String vectorFieldName, double[] vector)	Creates an expression that calculates the cosine distance between two vectors.
static Expression	Expression.cosineDistance(String vectorFieldName, Expression vector)	Creates an expression that calculates the cosine distance between two vectors.
static Expression	Expression.currentTimestamp()	Creates an expression that returns the current timestamp.
static Expression	Expression.divide(Expression dividend, Expression divisor)	Creates an expression that divides two numeric expressions.
static Expression	Expression.divide(Expression dividend, Number divisor)	Creates an expression that divides a numeric expression by a constant.
final Expression	Expression.divide(Object other)	Creates an expression that divides this numeric expression by another numeric expression.
static Expression	Expression.divide(String fieldName, Expression divisor)	Creates an expression that divides numeric field by a numeric expression.
static Expression	Expression.divide(String fieldName, Number divisor)	Creates an expression that divides a numeric field by a constant.
final Expression	Expression.documentId()	Creates an expression that returns the document ID from this path expression.
static Expression	Expression.documentId(DocumentReference docRef)	Creates an expression that returns the document ID from a DocumentReference.
static Expression	Expression.documentId(Expression documentPath)	Creates an expression that returns the document ID from a path.
static Expression	Expression.documentId(String documentPath)	Creates an expression that returns the document ID from a path.
final Expression	Expression.dotProduct(double[] vector)	Calculates the dot product distance between this vector expression and a vector literal.
final Expression	Expression.dotProduct(Expression vector)	Calculates the dot product distance between this and another vector expression.
static Expression	Expression.dotProduct(Expression vector1, double[] vector2)	Creates an expression that calculates the dot product of two vectors.
static Expression	Expression.dotProduct(Expression vector1, Expression vector2)	Creates an expression that calculates the dot product of two vectors.
static Expression	Expression.dotProduct(String vectorFieldName, double[] vector)	Creates an expression that calculates the dot product of two vectors.
static Expression	Expression.dotProduct(String vectorFieldName, Expression vector)	Creates an expression that calculates the dot product of two vectors.
final Expression	Expression.euclideanDistance(double[] vector)	Calculates the Euclidean distance between this vector expression and a vector literal.
final Expression	Expression.euclideanDistance(Expression vector)	Calculates the Euclidean distance between this and another vector expression.
static Expression	Expression.euclideanDistance(Expression vector1, double[] vector2)	Creates an expression that calculates the Euclidean distance between two vectors.
static Expression	Expression.euclideanDistance(Expression vector1, Expression vector2)	Creates an expression that calculates the Euclidean distance between two vectors.
static Expression	Expression.euclideanDistance(String vectorFieldName, double[] vector)	Creates an expression that calculates the Euclidean distance between two vectors.
static Expression	Expression.euclideanDistance(String vectorFieldName, Expression vector)	Creates an expression that calculates the Euclidean distance between two vectors.
final Expression	Expression.exp()	Creates an expression that returns Euler's number e raised to the power of this numeric expression.
static Expression	Expression.exp(Expression numericExpr)	Creates an expression that returns Euler's number e raised to the power of numericExpr.
static Expression	Expression.exp(String numericField)	Creates an expression that returns Euler's number e raised to the power of numericField.
final Expression	Expression.floor()	Creates an expression that returns the largest integer that isn't less than this numeric expression.
static Expression	Expression.floor(Expression numericExpr)	Creates an expression that returns the largest integer that isn't less than numericExpr.
static Expression	Expression.floor(String numericField)	Creates an expression that returns the largest integer that isn't less than numericField.
Expression	AliasedExpression.getExpr()
Expression	Ordering.getExpr()
static Expression	Expression.ifAbsent(Expression ifExpr, Expression elseExpr)	Creates an expression that returns a default value if an expression evaluates to an absent value.
static Expression	Expression.ifAbsent(Expression ifExpr, Object elseValue)	Creates an expression that returns a default value if an expression evaluates to an absent value.
Expression	Expression.ifAbsent(Object elseValue)	Creates an expression that returns a default value if this expression evaluates to an absent value.
static Expression	Expression.ifAbsent(String ifFieldName, Expression elseExpr)	Creates an expression that returns a default value if a field is absent.
static Expression	Expression.ifAbsent(String ifFieldName, Object elseValue)	Creates an expression that returns a default value if a field is absent.
final Expression	Expression.ifError(Expression catchExpr)	Creates an expression that returns the catchExpr argument if there is an error, else return the result of this expression.
static Expression	Expression.ifError(Expression tryExpr, Expression catchExpr)	Creates an expression that returns the catchExpr argument if there is an error, else return the result of the tryExpr argument evaluation.
static Expression	Expression.ifError(Expression tryExpr, Object catchValue)	Creates an expression that returns the catchValue argument if there is an error, else return the result of the tryExpr argument evaluation.
final Expression	Expression.ifError(Object catchValue)	Creates an expression that returns the catchValue argument if there is an error, else return the result of this expression.
Expression	Expression.join(Expression delimiter)	Creates an expression that joins the elements of this array expression into a string.
static Expression	Expression.join(Expression arrayExpression, Expression delimiterExpression)	Creates an expression that joins the elements of an array into a string.
static Expression	Expression.join(Expression arrayExpression, String delimiter)	Creates an expression that joins the elements of an array into a string.
Expression	Expression.join(String delimiter)	Creates an expression that joins the elements of this array expression into a string.
static Expression	Expression.join(String arrayFieldName, Expression delimiterExpression)	Creates an expression that joins the elements of an array into a string.
static Expression	Expression.join(String arrayFieldName, String delimiter)	Creates an expression that joins the elements of an array into a string.
final Expression	Expression.length()	Creates an expression that calculates the length of the expression if it is a string, array, map, or Blob.
static Expression	Expression.length(Expression string)	Creates an expression that calculates the length of string, array, map, vector, or Blob.
static Expression	Expression.length(String fieldName)	Creates an expression that calculates the length of string, array, map, vector, or Blob.
final Expression	Expression.ln()	Creates an expression that returns the natural logarithm (base e) of this numeric expression.
static Expression	Expression.ln(Expression numericExpr)	Creates an expression that returns the natural logarithm (base e) of numericExpr.
static Expression	Expression.ln(String numericField)	Creates an expression that returns the natural logarithm (base e) of numericField.
static Expression	Expression.log(Expression numericExpr, Expression base)	Creates an expression that returns the logarithm of numericExpr with a given base.
static Expression	Expression.log(Expression numericExpr, Number base)	Creates an expression that returns the logarithm of numericExpr with a given base.
static Expression	Expression.log(String numericField, Expression base)	Creates an expression that returns the logarithm of numericField with a given base.
static Expression	Expression.log(String numericField, Number base)	Creates an expression that returns the logarithm of numericField with a given base.
Expression	Expression.log10()	Creates an expression that returns the base 10 logarithm of this numeric expression.
static Expression	Expression.log10(Expression numericExpr)	Creates an expression that returns the base 10 logarithm of numericExpr.
static Expression	Expression.log10(String numericField)	Creates an expression that returns the base 10 logarithm of numericField.
static Expression	Expression.logicalMaximum(Expression expr, Object... others)	Creates an expression that returns the largest value between multiple input expressions or literal values.
final Expression	Expression.logicalMaximum(Object... others)	Creates an expression that returns the largest value between multiple input expressions or literal values.
static Expression	Expression.logicalMaximum(String fieldName, Object... others)	Creates an expression that returns the largest value between multiple input expressions or literal values.
static Expression	Expression.logicalMinimum(Expression expr, Object... others)	Creates an expression that returns the smallest value between multiple input expressions or literal values.
final Expression	Expression.logicalMinimum(Object... others)	Creates an expression that returns the smallest value between multiple input expressions or literal values.
static Expression	Expression.logicalMinimum(String fieldName, Object... others)	Creates an expression that returns the smallest value between multiple input expressions or literal values.
static Expression	Expression.map(Map<String,Object> elements)	Creates an expression that creates a Firestore map value from an input object.
static Expression	Expression.mapGet(Expression map, Expression key)	Accesses a value from a map (object) field using the provided keyExpression.
static Expression	Expression.mapGet(Expression map, String key)	Accesses a value from a map (object) field using the provided key.
final Expression	Expression.mapGet(Object key)	Accesses a map (object) value using the provided key.
static Expression	Expression.mapGet(String fieldName, Expression key)	Accesses a value from a map (object) field using the provided keyExpression.
static Expression	Expression.mapGet(String fieldName, String key)	Accesses a value from a map (object) field using the provided key.
static Expression	Expression.mapMerge(Expression firstMap, Expression secondMap)
final Expression	Expression.mapMerge(Expression secondMap, Expression... otherMaps)	Creates an expression that merges multiple maps into a single map.
static Expression	Expression.mapMerge(Expression firstMap, Expression secondMap, Expression... otherMaps)	Creates an expression that merges multiple maps into a single map.
static Expression	Expression.mapMerge(String firstMapFieldName, Expression secondMap)
static Expression	Expression.mapMerge(String firstMapFieldName, Expression secondMap, Expression... otherMaps)	Creates an expression that merges multiple maps into a single map.
final Expression	Expression.mapRemove(Expression key)	Creates an expression that removes a key from this map expression.
static Expression	Expression.mapRemove(Expression mapExpr, Expression key)	Creates an expression that removes a key from a map.
static Expression	Expression.mapRemove(Expression mapExpr, String key)	Creates an expression that removes a key from a map.
final Expression	Expression.mapRemove(String key)	Creates an expression that removes a key from this map expression.
static Expression	Expression.mapRemove(String mapField, Expression key)	Creates an expression that removes a key from a map.
static Expression	Expression.mapRemove(String mapField, String key)	Creates an expression that removes a key from a map.
static Expression	Expression.mod(Expression dividend, Expression divisor)	Creates an expression that calculates the modulo (remainder) of dividing two numeric expressions.
static Expression	Expression.mod(Expression dividend, Number divisor)	Creates an expression that calculates the modulo (remainder) of dividing a numeric expression by a constant.
final Expression	Expression.mod(Object other)	Creates an expression that calculates the modulo (remainder) of dividing this numeric expressions by another numeric expression.
static Expression	Expression.mod(String fieldName, Expression divisor)	Creates an expression that calculates the modulo (remainder) of dividing a numeric field by a constant.
static Expression	Expression.mod(String fieldName, Number divisor)	Creates an expression that calculates the modulo (remainder) of dividing a numeric field by a constant.
static Expression	Expression.multiply(Expression first, Expression second)	Creates an expression that multiplies numeric expressions.
static Expression	Expression.multiply(Expression first, Number second)	Creates an expression that multiplies numeric expressions with a constant.
final Expression	Expression.multiply(Object other)	Creates an expression that multiplies this numeric expression with another numeric expression.
static Expression	Expression.multiply(String fieldName, Expression second)	Creates an expression that multiplies a numeric field with a numeric expression.
static Expression	Expression.multiply(String fieldName, Number second)	Creates an expression that multiplies a numeric field with a constant.
static Expression	Expression.nullValue()	Constant for a null value.
final Expression	Expression.pow(Expression exponent)	Creates an expression that returns this numeric expression raised to the power of the exponent.
static Expression	Expression.pow(Expression numericExpr, Expression exponent)	Creates an expression that returns the numericExpr raised to the power of the exponent.
static Expression	Expression.pow(Expression numericExpr, Number exponent)	Creates an expression that returns the numericExpr raised to the power of the exponent.
final Expression	Expression.pow(Number exponent)	Creates an expression that returns this numeric expression raised to the power of the exponent.
static Expression	Expression.pow(String numericField, Expression exponent)	Creates an expression that returns the numericField raised to the power of the exponent.
static Expression	Expression.pow(String numericField, Number exponent)	Creates an expression that returns the numericField raised to the power of the exponent.
static Expression	Expression.rand()	Creates an expression that returns a random double between 0.0 and 1.0 but not including 1.0.
static Expression	Expression.rawExpression(String name, Expression... expr)	Creates a generic function expression that is not yet implemented.
static Expression	Expression.regexFind(Expression string, Expression pattern)	Creates an expression that returns the first substring of a string expression that matches a specified regular expression.
static Expression	Expression.regexFind(Expression string, String pattern)	Creates an expression that returns the first substring of a string expression that matches a specified regular expression.
final Expression	Expression.regexFind(Object pattern)	Creates an expression that returns the first substring of a string expression that matches a specified regular expression.
static Expression	Expression.regexFind(String fieldName, Expression pattern)	Creates an expression that returns the first substring of a string field that matches a specified regular expression.
static Expression	Expression.regexFind(String fieldName, String pattern)	Creates an expression that returns the first substring of a string field that matches a specified regular expression.
static Expression	Expression.regexFindAll(Expression string, Expression pattern)	Creates an expression that evaluates to a list of all substrings in a string expression that match a specified regular expression.
static Expression	Expression.regexFindAll(Expression string, String pattern)	Creates an expression that evaluates to a list of all substrings in a string expression that match a specified regular expression.
final Expression	Expression.regexFindAll(Object pattern)	Creates an expression that evaluates to a list of all substrings in a string expression that match a specified regular expression.
static Expression	Expression.regexFindAll(String fieldName, Expression pattern)	Creates an expression that evaluates to a list of all substrings in a string field that match a specified regular expression.
static Expression	Expression.regexFindAll(String fieldName, String pattern)	Creates an expression that evaluates to a list of all substrings in a string field that match a specified regular expression.
final Expression	Expression.reverse()	Creates an expression that reverses this expression, which must be a string, blob, or array.
static Expression	Expression.reverse(Expression expr)	Creates an expression that reverses a string, blob, or array.
static Expression	Expression.reverse(String fieldName)	Creates an expression that reverses the field value, which must be a string, blob, or array.
final Expression	Expression.round()	Creates an expression that rounds this numeric expression to nearest integer.
static Expression	Expression.round(Expression numericExpr)	Creates an expression that rounds numericExpr to nearest integer.
static Expression	Expression.round(String numericField)	Creates an expression that rounds numericField to nearest integer.
final Expression	Expression.roundToPrecision(int decimalPlace)	Creates an expression that rounds off this numeric expression to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
final Expression	Expression.roundToPrecision(Expression decimalPlace)	Creates an expression that rounds off this numeric expression to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.roundToPrecision(Expression numericExpr, int decimalPlace)	Creates an expression that rounds off numericExpr to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.roundToPrecision(Expression numericExpr, Expression decimalPlace)	Creates an expression that rounds off numericExpr to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.roundToPrecision(String numericField, int decimalPlace)	Creates an expression that rounds off numericField to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.roundToPrecision(String numericField, Expression decimalPlace)	Creates an expression that rounds off numericField to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
Expression	Expression.split(Expression delimiter)	Creates an expression that splits this string or blob expression by a delimiter.
static Expression	Expression.split(Expression value, Expression delimiter)	Creates an expression that splits a string or blob by a delimiter.
static Expression	Expression.split(Expression value, String delimiter)	Creates an expression that splits a string or blob by a delimiter.
Expression	Expression.split(String delimiter)	Creates an expression that splits this string or blob expression by a delimiter.
static Expression	Expression.split(String fieldName, Expression delimiter)	Creates an expression that splits a string or blob by a delimiter.
static Expression	Expression.split(String fieldName, String delimiter)	Creates an expression that splits a string or blob by a delimiter.
final Expression	Expression.sqrt()	Creates an expression that returns the square root of this numeric expression.
static Expression	Expression.sqrt(Expression numericExpr)	Creates an expression that returns the square root of numericExpr.
static Expression	Expression.sqrt(String numericField)	Creates an expression that returns the square root of numericField.
final Expression	Expression.stringConcat(Expression... others)	Creates an expression that concatenates string expressions together.
static Expression	Expression.stringConcat(Expression firstString, Object... otherStrings)	Creates an expression that concatenates string expressions together.
final Expression	Expression.stringConcat(String... others)	Creates an expression that concatenates string expressions and string constants together.
static Expression	Expression.stringConcat(String fieldName, Object... otherStrings)	Creates an expression that concatenates string expressions together.
static Expression	Expression.substring(Expression string, Expression index, Expression length)	Creates an expression that returns a substring of the given string.
final Expression	Expression.substring(Object index, Object length)	Creates an expression that returns a substring of the given string.
static Expression	Expression.substring(String fieldName, int index, int length)	Creates an expression that returns a substring of the given string.
static Expression	Expression.subtract(Expression minuend, Expression subtrahend)	Creates an expression that subtracts two expressions.
static Expression	Expression.subtract(Expression minuend, Number subtrahend)	Creates an expression that subtracts a constant value from a numeric expression.
final Expression	Expression.subtract(Object other)	Creates an expression that subtracts a numeric expressions from this numeric expression.
static Expression	Expression.subtract(String fieldName, Expression subtrahend)	Creates an expression that subtracts a numeric expressions from numeric field.
static Expression	Expression.subtract(String fieldName, Number subtrahend)	Creates an expression that subtracts a constant from numeric field.
final Expression	Expression.timestampAdd(Expression unit, Expression amount)	Creates an expression that adds a specified amount of time to this timestamp expression.
static Expression	Expression.timestampAdd(Expression timestamp, Expression unit, Expression amount)	Creates an expression that adds a specified amount of time to a timestamp.
static Expression	Expression.timestampAdd(Expression timestamp, String unit, long amount)	Creates an expression that adds a specified amount of time to a timestamp.
final Expression	Expression.timestampAdd(String unit, long amount)	Creates an expression that adds a specified amount of time to this timestamp expression.
static Expression	Expression.timestampAdd(String fieldName, Expression unit, Expression amount)	Creates an expression that adds a specified amount of time to a timestamp.
static Expression	Expression.timestampAdd(String fieldName, String unit, long amount)	Creates an expression that adds a specified amount of time to a timestamp.
final Expression	Expression.timestampSubtract(Expression unit, Expression amount)	Creates an expression that subtracts a specified amount of time to this timestamp expression.
static Expression	Expression.timestampSubtract(Expression timestamp, Expression unit, Expression amount)	Creates an expression that subtracts a specified amount of time to a timestamp.
static Expression	Expression.timestampSubtract(Expression timestamp, String unit, long amount)	Creates an expression that subtracts a specified amount of time to a timestamp.
final Expression	Expression.timestampSubtract(String unit, long amount)	Creates an expression that subtracts a specified amount of time to this timestamp expression.
static Expression	Expression.timestampSubtract(String fieldName, Expression unit, Expression amount)	Creates an expression that subtracts a specified amount of time to a timestamp.
static Expression	Expression.timestampSubtract(String fieldName, String unit, long amount)	Creates an expression that subtracts a specified amount of time to a timestamp.
final Expression	Expression.timestampToUnixMicros()	Creates an expression that converts this timestamp expression to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
static Expression	Expression.timestampToUnixMicros(Expression expr)	Creates an expression that converts a timestamp expression to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
static Expression	Expression.timestampToUnixMicros(String fieldName)	Creates an expression that converts a timestamp field to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
final Expression	Expression.timestampToUnixMillis()	Creates an expression that converts this timestamp expression to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
static Expression	Expression.timestampToUnixMillis(Expression expr)	Creates an expression that converts a timestamp expression to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
static Expression	Expression.timestampToUnixMillis(String fieldName)	Creates an expression that converts a timestamp field to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
final Expression	Expression.timestampToUnixSeconds()	Creates an expression that converts this timestamp expression to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC).
static Expression	Expression.timestampToUnixSeconds(Expression expr)	Creates an expression that converts a timestamp expression to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC).
static Expression	Expression.timestampToUnixSeconds(String fieldName)	Creates an expression that converts a timestamp field to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC).
final Expression	Expression.timestampTruncate(Expression granularity)	Creates an expression that truncates this timestamp expression to a specified granularity.
static Expression	Expression.timestampTruncate(Expression timestamp, Expression granularity)	Creates an expression that truncates a timestamp to a specified granularity.
static Expression	Expression.timestampTruncate(Expression timestamp, Expression granularity, String timezone)	Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
static Expression	Expression.timestampTruncate(Expression timestamp, String granularity)	Creates an expression that truncates a timestamp to a specified granularity.
static Expression	Expression.timestampTruncate(Expression timestamp, String granularity, String timezone)	Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
final Expression	Expression.timestampTruncate(String granularity)	Creates an expression that truncates this timestamp expression to a specified granularity.
static Expression	Expression.timestampTruncate(String fieldName, Expression granularity)	Creates an expression that truncates a timestamp to a specified granularity.
static Expression	Expression.timestampTruncate(String fieldName, Expression granularity, String timezone)	Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
static Expression	Expression.timestampTruncate(String fieldName, String granularity)	Creates an expression that truncates a timestamp to a specified granularity.
static Expression	Expression.timestampTruncate(String fieldName, String granularity, String timezone)	Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
final Expression	Expression.toLower()	Creates an expression that converts this string expression to lowercase.
static Expression	Expression.toLower(Expression string)	Creates an expression that converts a string expression to lowercase.
static Expression	Expression.toLower(String fieldName)	Creates an expression that converts a string field to lowercase.
final Expression	Expression.toUpper()	Creates an expression that converts this string expression to uppercase.
static Expression	Expression.toUpper(Expression string)	Creates an expression that converts a string expression to uppercase.
static Expression	Expression.toUpper(String fieldName)	Creates an expression that converts a string field to uppercase.
final Expression	Expression.trim()	Creates an expression that removes leading and trailing whitespace from this string expression.
static Expression	Expression.trim(Expression string)	Creates an expression that removes leading and trailing whitespace from a string expression.
static Expression	Expression.trim(String fieldName)	Creates an expression that removes leading and trailing whitespace from a string field.
Expression	Expression.trimValue(Expression characters)	Creates an expression that removes specified characters from the beginning and end of this string or blob expression.
static Expression	Expression.trimValue(Expression value, Expression characters)	Creates an expression that removes specified characters from the beginning and end of a string or blob.
static Expression	Expression.trimValue(Expression value, String characters)	Creates an expression that removes specified characters from the beginning and end of a string or blob.
Expression	Expression.trimValue(String characters)	Creates an expression that removes specified characters from the beginning and end of this string or blob expression.
static Expression	Expression.trimValue(String fieldName, Expression characters)	Creates an expression that removes specified characters from the beginning and end of a string or blob.
static Expression	Expression.trimValue(String fieldName, String characters)	Creates an expression that removes specified characters from the beginning and end of a string or blob.
final Expression	Expression.trunc()	Creates an expression that truncates this numeric expression to an integer.
static Expression	Expression.trunc(Expression numericExpr)	Creates an expression that truncates numericExpr to an integer.
static Expression	Expression.trunc(String numericField)	Creates an expression that truncates numericField to an integer.
final Expression	Expression.truncToPrecision(int decimalPlace)	Creates an expression that truncates this numeric expression to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
final Expression	Expression.truncToPrecision(Expression decimalPlace)	Creates an expression that truncates this numeric expression to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.truncToPrecision(Expression numericExpr, int decimalPlace)	Creates an expression that truncates numericExpr to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.truncToPrecision(Expression numericExpr, Expression decimalPlace)	Creates an expression that truncates numericExpr to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.truncToPrecision(String numericField, int decimalPlace)	Creates an expression that truncates numericField to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.truncToPrecision(String numericField, Expression decimalPlace)	Creates an expression that truncates numericField to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
final Expression	Expression.type()	Creates an expression that returns a string indicating the type of the value this expression evaluates to.
static Expression	Expression.type(Expression expr)	Creates an expression that returns a string indicating the type of the value this expression evaluates to.
static Expression	Expression.type(String fieldName)	Creates an expression that returns a string indicating the type of the value this field evaluates to.
final Expression	Expression.unixMicrosToTimestamp()	Creates an expression that interprets this expression as the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
static Expression	Expression.unixMicrosToTimestamp(Expression expr)	Creates an expression that converts a Unix timestamp in microseconds to a Firestore timestamp.
static Expression	Expression.unixMicrosToTimestamp(String fieldName)	Creates an expression that interprets a field's value as the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
final Expression	Expression.unixMillisToTimestamp()	Creates an expression that interprets this expression as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
static Expression	Expression.unixMillisToTimestamp(Expression expr)	Creates an expression that interprets an expression as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
static Expression	Expression.unixMillisToTimestamp(String fieldName)	Creates an expression that interprets a field's value as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
final Expression	Expression.unixSecondsToTimestamp()	Creates an expression that interprets this expression as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
static Expression	Expression.unixSecondsToTimestamp(Expression expr)	Creates an expression that interprets an expression as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
static Expression	Expression.unixSecondsToTimestamp(String fieldName)	Creates an expression that interprets a field's value as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
final Expression	Expression.vectorLength()	Creates an expression that calculates the length (dimension) of a Firestore Vector.
static Expression	Expression.vectorLength(Expression vectorExpression)	Creates an expression that calculates the length of a vector.
static Expression	Expression.vectorLength(String fieldName)	Creates an expression that calculates the length of a vector.

Methods in com.google.cloud.firestore.pipeline.expressions with parameters of type Expression

Modifier and Type	Method	Description
static Expression	Expression.abs(Expression numericExpr)	Creates an expression that returns the absolute value of numericExpr.
static Expression	Expression.add(Expression first, Expression second)	Creates an expression that adds numeric expressions.
static Expression	Expression.add(Expression first, Number second)	Creates an expression that adds numeric expressions with a constant.
static Expression	Expression.add(String fieldName, Expression second)	Creates an expression that adds a numeric field with a numeric expression.
static AggregateFunction	AggregateFunction.arrayAgg(Expression expression)	Creates an aggregation that collects all values of an expression across multiple stage inputs into an array.
static AggregateFunction	AggregateFunction.arrayAggDistinct(Expression expression)	Creates an aggregation that collects all distinct values of an expression across multiple stage inputs into an array.
final Expression	Expression.arrayConcat(Expression... otherArrays)	Creates an expression that concatenates a field's array value with other arrays.
static Expression	Expression.arrayConcat(Expression firstArray, Object... otherArrays)	Creates an expression that concatenates multiple arrays into a single array.
static BooleanExpression	Expression.arrayContains(Expression array, Expression element)	Creates an expression that checks if an array contains a specified element.
static BooleanExpression	Expression.arrayContains(Expression array, Object element)	Creates an expression that checks if an array contains a specified element.
static BooleanExpression	Expression.arrayContains(String arrayFieldName, Expression element)	Creates an expression that checks if an array contains a specified element.
final BooleanExpression	Expression.arrayContainsAll(Expression arrayExpression)	Creates an expression that checks if array contains all elements of arrayExpression.
static BooleanExpression	Expression.arrayContainsAll(Expression array, Expression arrayExpression)	Creates an expression that checks if an array contains all of the elements of another array.
static BooleanExpression	Expression.arrayContainsAll(Expression array, List<Object> values)	Creates an expression that checks if an array contains all of the provided values.
static BooleanExpression	Expression.arrayContainsAll(String arrayFieldName, Expression arrayExpression)	Creates an expression that checks if an array contains all of the elements of another array.
final BooleanExpression	Expression.arrayContainsAny(Expression arrayExpression)	Creates an expression that checks if array contains any elements of arrayExpression.
static BooleanExpression	Expression.arrayContainsAny(Expression array, Expression arrayExpression)	Creates an expression that checks if an array contains any of the elements of another array.
static BooleanExpression	Expression.arrayContainsAny(Expression array, List<Object> values)	Creates an expression that checks if an array contains any of the provided values.
static BooleanExpression	Expression.arrayContainsAny(String arrayFieldName, Expression arrayExpression)	Creates an expression that checks if an array contains any of the elements of another array.
static Expression	Expression.arrayFirst(Expression array)	Creates an expression that returns the first element of an array.
final Expression	Expression.arrayFirstN(Expression n)	Returns the first n elements of an array.
static Expression	Expression.arrayFirstN(Expression array, int n)	Creates an expression that returns the first n elements of an array.
static Expression	Expression.arrayFirstN(Expression array, Expression n)	Creates an expression that returns the first n elements of an array.
static Expression	Expression.arrayFirstN(String arrayFieldName, Expression n)	Creates an expression that returns the first n elements of an array.
final Expression	Expression.arrayGet(Expression offset)	Creates an expression that indexes into an array from the beginning or end and return the element.
static Expression	Expression.arrayGet(Expression array, int offset)	Creates an expression that returns an element from an array at a specified index.
static Expression	Expression.arrayGet(Expression array, Expression offset)	Creates an expression that returns an element from an array at a specified index.
static Expression	Expression.arrayGet(String arrayFieldName, Expression offset)	Creates an expression that returns an element from an array at a specified index.
final Expression	Expression.arrayIndexOf(Expression value)	Returns the index of the first occurrence of a value in an array.
static Expression	Expression.arrayIndexOf(Expression array, Expression value)	Creates an expression that returns the index of the first occurrence of a value in an array.
static Expression	Expression.arrayIndexOf(Expression array, Object value)	Creates an expression that returns the index of the first occurrence of a value in an array.
static Expression	Expression.arrayIndexOf(String arrayFieldName, Expression value)	Creates an expression that returns the index of the first occurrence of a value in an array.
final Expression	Expression.arrayIndexOfAll(Expression value)	Returns all indices of a value in an array.
static Expression	Expression.arrayIndexOfAll(Expression array, Expression value)	Creates an expression that returns all indices of a value in an array.
static Expression	Expression.arrayIndexOfAll(Expression array, Object value)	Creates an expression that returns all indices of a value in an array.
static Expression	Expression.arrayIndexOfAll(String arrayFieldName, Expression value)	Creates an expression that returns all indices of a value in an array.
static Expression	Expression.arrayLast(Expression array)	Creates an expression that returns the last element of an array.
final Expression	Expression.arrayLastIndexOf(Expression value)	Returns the index of the last occurrence of a value in an array.
static Expression	Expression.arrayLastIndexOf(Expression array, Expression value)	Creates an expression that returns the index of the last occurrence of a value in an array.
static Expression	Expression.arrayLastIndexOf(Expression array, Object value)	Creates an expression that returns the index of the last occurrence of a value in an array.
static Expression	Expression.arrayLastIndexOf(String arrayFieldName, Expression value)	Creates an expression that returns the index of the last occurrence of a value in an array.
final Expression	Expression.arrayLastN(Expression n)	Returns the last n elements of an array.
static Expression	Expression.arrayLastN(Expression array, int n)	Creates an expression that returns the last n elements of an array.
static Expression	Expression.arrayLastN(Expression array, Expression n)	Creates an expression that returns the last n elements of an array.
static Expression	Expression.arrayLastN(String arrayFieldName, Expression n)	Creates an expression that returns the last n elements of an array.
static Expression	Expression.arrayLength(Expression array)	Creates an expression that returns the length of an array.
static Expression	Expression.arrayMaximum(Expression array)	Creates an expression that returns the maximum value of an array.
final Expression	Expression.arrayMaximumN(Expression n)	Returns the n maximum values of an array.
static Expression	Expression.arrayMaximumN(Expression array, int n)	Creates an expression that returns the n maximum values of an array.
static Expression	Expression.arrayMaximumN(Expression array, Expression n)	Creates an expression that returns the n maximum values of an array.
static Expression	Expression.arrayMaximumN(String arrayFieldName, Expression n)	Creates an expression that returns the n maximum values of an array.
static Expression	Expression.arrayMinimum(Expression array)	Creates an expression that returns the minimum value of an array.
final Expression	Expression.arrayMinimumN(Expression n)	Returns the n minimum values of an array.
static Expression	Expression.arrayMinimumN(Expression array, int n)	Creates an expression that returns the n minimum values of an array.
static Expression	Expression.arrayMinimumN(Expression array, Expression n)	Creates an expression that returns the n minimum values of an array.
static Expression	Expression.arrayMinimumN(String arrayFieldName, Expression n)	Creates an expression that returns the n minimum values of an array.
static Expression	Expression.arrayReverse(Expression array)	Creates an expression that reverses an array.
static Expression	Expression.arraySum(Expression array)	Creates an expression that returns the sum of the elements of an array.
static Ordering	Ordering.ascending(Expression expr)
static AggregateFunction	AggregateFunction.average(Expression expression)	Creates an aggregation that calculates the average (mean) of values from an expression across multiple stage inputs.
static Expression	Expression.byteLength(Expression string)	Creates an expression that calculates the length of a string in UTF-8 bytes, or just the length of a Blob.
static Expression	Expression.ceil(Expression numericExpr)	Creates an expression that returns the smallest integer that isn't less than numericExpr.
static Expression	Expression.charLength(Expression string)	Creates an expression that calculates the character length of a string expression in UTF8.
static Expression	Expression.collectionId(Expression path)	Creates an expression that returns the collection ID from a path.
static Expression	Expression.concat(Expression first, Object... others)	Creates an expression that concatenates expressions together.
final Expression	BooleanExpression.conditional(Expression thenExpr, Expression elseExpr)	Creates a conditional expression that evaluates to a thenExpr expression if this condition is true or an elseExpr expression if the condition is false.
static Expression	Expression.conditional(BooleanExpression condition, Expression thenExpr, Expression elseExpr)	Creates a conditional expression that evaluates to a thenExpr expression if a condition is true or an elseExpr expression if the condition is false.
final Expression	Expression.cosineDistance(Expression vector)	Calculates the Cosine distance between this and another vector expressions.
static Expression	Expression.cosineDistance(Expression vector1, double[] vector2)	Creates an expression that calculates the cosine distance between two vectors.
static Expression	Expression.cosineDistance(Expression vector1, Expression vector2)	Creates an expression that calculates the cosine distance between two vectors.
static Expression	Expression.cosineDistance(String vectorFieldName, Expression vector)	Creates an expression that calculates the cosine distance between two vectors.
static AggregateFunction	AggregateFunction.count(Expression expression)	Creates an aggregation that counts the number of stage inputs with valid evaluations of the provided expression.
static AggregateFunction	AggregateFunction.countDistinct(Expression expression)	Creates an aggregation that counts the number of distinct values of an expression across multiple stage inputs.
static Ordering	Ordering.descending(Expression expr)
static Expression	Expression.divide(Expression dividend, Expression divisor)	Creates an expression that divides two numeric expressions.
static Expression	Expression.divide(Expression dividend, Number divisor)	Creates an expression that divides a numeric expression by a constant.
static Expression	Expression.divide(String fieldName, Expression divisor)	Creates an expression that divides numeric field by a numeric expression.
static Expression	Expression.documentId(Expression documentPath)	Creates an expression that returns the document ID from a path.
final Expression	Expression.dotProduct(Expression vector)	Calculates the dot product distance between this and another vector expression.
static Expression	Expression.dotProduct(Expression vector1, double[] vector2)	Creates an expression that calculates the dot product of two vectors.
static Expression	Expression.dotProduct(Expression vector1, Expression vector2)	Creates an expression that calculates the dot product of two vectors.
static Expression	Expression.dotProduct(String vectorFieldName, Expression vector)	Creates an expression that calculates the dot product of two vectors.
static BooleanExpression	Expression.endsWith(Expression string, Expression suffix)	Creates an expression that checks if a string expression ends with a given suffix.
static BooleanExpression	Expression.endsWith(Expression string, String suffix)	Creates an expression that checks if a string expression ends with a given suffix.
static BooleanExpression	Expression.endsWith(String fieldName, Expression suffix)	Creates an expression that checks if a string expression ends with a given suffix.
static BooleanExpression	Expression.equal(Expression left, Expression right)	Creates an expression that checks if two expressions are equal.
static BooleanExpression	Expression.equal(Expression left, Object right)	Creates an expression that checks if an expression is equal to a constant value.
static BooleanExpression	Expression.equal(String fieldName, Expression right)	Creates an expression that checks if a field is equal to an expression.
static BooleanExpression	Expression.equalAny(Expression expression, Expression arrayExpression)	Creates an expression that checks if an expression, when evaluated, is equal to any of the elements of arrayExpression.
static BooleanExpression	Expression.equalAny(Expression expression, List<Object> values)	Creates an expression that checks if an expression, when evaluated, is equal to any of the provided values.
static BooleanExpression	Expression.equalAny(String fieldName, Expression arrayExpression)	Creates an expression that checks if a field's value is equal to any of the elements of arrayExpression.
final Expression	Expression.euclideanDistance(Expression vector)	Calculates the Euclidean distance between this and another vector expression.
static Expression	Expression.euclideanDistance(Expression vector1, double[] vector2)	Creates an expression that calculates the Euclidean distance between two vectors.
static Expression	Expression.euclideanDistance(Expression vector1, Expression vector2)	Creates an expression that calculates the Euclidean distance between two vectors.
static Expression	Expression.euclideanDistance(String vectorFieldName, Expression vector)	Creates an expression that calculates the Euclidean distance between two vectors.
static BooleanExpression	Expression.exists(Expression value)	Creates an expression that checks if a field exists.
static Expression	Expression.exp(Expression numericExpr)	Creates an expression that returns Euler's number e raised to the power of numericExpr.
static Value	FunctionUtils.exprToValue(Expression expr)
static AggregateFunction	AggregateFunction.first(Expression expression)	Creates an aggregation that finds the first value of an expression across multiple stage inputs.
static Expression	Expression.floor(Expression numericExpr)	Creates an expression that returns the largest integer that isn't less than numericExpr.
static BooleanExpression	Expression.greaterThan(Expression left, Expression right)	Creates an expression that checks if the first expression is greater than the second expression.
static BooleanExpression	Expression.greaterThan(Expression left, Object right)	Creates an expression that checks if an expression is greater than a constant value.
static BooleanExpression	Expression.greaterThan(String fieldName, Expression right)	Creates an expression that checks if a field is greater than an expression.
static BooleanExpression	Expression.greaterThanOrEqual(Expression left, Expression right)	Creates an expression that checks if the first expression is greater than or equal to the second expression.
static BooleanExpression	Expression.greaterThanOrEqual(Expression left, Object right)	Creates an expression that checks if an expression is greater than or equal to a constant value.
static BooleanExpression	Expression.greaterThanOrEqual(String fieldName, Expression right)	Creates an expression that checks if a field is greater than or equal to an expression.
static Expression	Expression.ifAbsent(Expression ifExpr, Expression elseExpr)	Creates an expression that returns a default value if an expression evaluates to an absent value.
static Expression	Expression.ifAbsent(Expression ifExpr, Object elseValue)	Creates an expression that returns a default value if an expression evaluates to an absent value.
static Expression	Expression.ifAbsent(String ifFieldName, Expression elseExpr)	Creates an expression that returns a default value if a field is absent.
final Expression	Expression.ifError(Expression catchExpr)	Creates an expression that returns the catchExpr argument if there is an error, else return the result of this expression.
static Expression	Expression.ifError(Expression tryExpr, Expression catchExpr)	Creates an expression that returns the catchExpr argument if there is an error, else return the result of the tryExpr argument evaluation.
static Expression	Expression.ifError(Expression tryExpr, Object catchValue)	Creates an expression that returns the catchValue argument if there is an error, else return the result of the tryExpr argument evaluation.
static BooleanExpression	Expression.isAbsent(Expression value)	Creates an expression that returns true if a value is absent.
static BooleanExpression	Expression.isError(Expression expr)	Creates an expression that checks if a given expression produces an error.
static BooleanExpression	Expression.isNotNaN(Expression expr)	Creates an expression that checks if the results of expr is NOT 'NaN' (Not a Number).
Expression	Expression.join(Expression delimiter)	Creates an expression that joins the elements of this array expression into a string.
static Expression	Expression.join(Expression arrayExpression, Expression delimiterExpression)	Creates an expression that joins the elements of an array into a string.
static Expression	Expression.join(Expression arrayExpression, String delimiter)	Creates an expression that joins the elements of an array into a string.
static Expression	Expression.join(String arrayFieldName, Expression delimiterExpression)	Creates an expression that joins the elements of an array into a string.
static AggregateFunction	AggregateFunction.last(Expression expression)	Creates an aggregation that finds the last value of an expression across multiple stage inputs.
static Expression	Expression.length(Expression string)	Creates an expression that calculates the length of string, array, map, vector, or Blob.
static BooleanExpression	Expression.lessThan(Expression left, Expression right)	Creates an expression that checks if the first expression is less than the second expression.
static BooleanExpression	Expression.lessThan(Expression left, Object right)	Creates an expression that checks if an expression is less than a constant value.
static BooleanExpression	Expression.lessThan(String fieldName, Expression right)	Creates an expression that checks if a field is less than an expression.
static BooleanExpression	Expression.lessThanOrEqual(Expression left, Expression right)	Creates an expression that checks if the first expression is less than or equal to the second expression.
static BooleanExpression	Expression.lessThanOrEqual(Expression left, Object right)	Creates an expression that checks if an expression is less than or equal to a constant value.
static BooleanExpression	Expression.lessThanOrEqual(String fieldName, Expression right)	Creates an expression that checks if a field is less than or equal to an expression.
static BooleanExpression	Expression.like(Expression string, Expression pattern)	Creates an expression that performs a case-sensitive wildcard string comparison.
static BooleanExpression	Expression.like(Expression string, String pattern)	Creates an expression that performs a case-sensitive wildcard string comparison.
static BooleanExpression	Expression.like(String fieldName, Expression pattern)	Creates an expression that performs a case-sensitive wildcard string comparison against a field.
static Expression	Expression.ln(Expression numericExpr)	Creates an expression that returns the natural logarithm (base e) of numericExpr.
static Expression	Expression.log(Expression numericExpr, Expression base)	Creates an expression that returns the logarithm of numericExpr with a given base.
static Expression	Expression.log(Expression numericExpr, Number base)	Creates an expression that returns the logarithm of numericExpr with a given base.
static Expression	Expression.log(String numericField, Expression base)	Creates an expression that returns the logarithm of numericField with a given base.
static Expression	Expression.log10(Expression numericExpr)	Creates an expression that returns the base 10 logarithm of numericExpr.
static Expression	Expression.logicalMaximum(Expression expr, Object... others)	Creates an expression that returns the largest value between multiple input expressions or literal values.
static Expression	Expression.logicalMinimum(Expression expr, Object... others)	Creates an expression that returns the smallest value between multiple input expressions or literal values.
static Expression	Expression.mapGet(Expression map, Expression key)	Accesses a value from a map (object) field using the provided keyExpression.
static Expression	Expression.mapGet(Expression map, String key)	Accesses a value from a map (object) field using the provided key.
static Expression	Expression.mapGet(String fieldName, Expression key)	Accesses a value from a map (object) field using the provided keyExpression.
static Expression	Expression.mapMerge(Expression firstMap, Expression secondMap)
final Expression	Expression.mapMerge(Expression secondMap, Expression... otherMaps)	Creates an expression that merges multiple maps into a single map.
static Expression	Expression.mapMerge(Expression firstMap, Expression secondMap, Expression... otherMaps)	Creates an expression that merges multiple maps into a single map.
static Expression	Expression.mapMerge(String firstMapFieldName, Expression secondMap)
static Expression	Expression.mapMerge(String firstMapFieldName, Expression secondMap, Expression... otherMaps)	Creates an expression that merges multiple maps into a single map.
final Expression	Expression.mapRemove(Expression key)	Creates an expression that removes a key from this map expression.
static Expression	Expression.mapRemove(Expression mapExpr, Expression key)	Creates an expression that removes a key from a map.
static Expression	Expression.mapRemove(Expression mapExpr, String key)	Creates an expression that removes a key from a map.
static Expression	Expression.mapRemove(String mapField, Expression key)	Creates an expression that removes a key from a map.
static AggregateFunction	AggregateFunction.maximum(Expression expression)	Creates an aggregation that finds the maximum value of an expression across multiple stage inputs.
static AggregateFunction	AggregateFunction.minimum(Expression expression)	Creates an aggregation that finds the minimum value of an expression across multiple stage inputs.
static Expression	Expression.mod(Expression dividend, Expression divisor)	Creates an expression that calculates the modulo (remainder) of dividing two numeric expressions.
static Expression	Expression.mod(Expression dividend, Number divisor)	Creates an expression that calculates the modulo (remainder) of dividing a numeric expression by a constant.
static Expression	Expression.mod(String fieldName, Expression divisor)	Creates an expression that calculates the modulo (remainder) of dividing a numeric field by a constant.
static Expression	Expression.multiply(Expression first, Expression second)	Creates an expression that multiplies numeric expressions.
static Expression	Expression.multiply(Expression first, Number second)	Creates an expression that multiplies numeric expressions with a constant.
static Expression	Expression.multiply(String fieldName, Expression second)	Creates an expression that multiplies a numeric field with a numeric expression.
static BooleanExpression	Expression.notEqual(Expression left, Expression right)	Creates an expression that checks if two expressions are not equal.
static BooleanExpression	Expression.notEqual(Expression left, Object right)	Creates an expression that checks if an expression is not equal to a constant value.
static BooleanExpression	Expression.notEqual(String fieldName, Expression right)	Creates an expression that checks if a field is not equal to an expression.
static BooleanExpression	Expression.notEqualAny(Expression expression, Expression arrayExpression)	Creates an expression that checks if an expression, when evaluated, is not equal to all the elements of arrayExpression.
static BooleanExpression	Expression.notEqualAny(Expression expression, List<Object> values)	Creates an expression that checks if an expression, when evaluated, is not equal to all the provided values.
static BooleanExpression	Expression.notEqualAny(String fieldName, Expression arrayExpression)	Creates an expression that checks if a field's value is not equal to all of the elements of arrayExpression.
final Expression	Expression.pow(Expression exponent)	Creates an expression that returns this numeric expression raised to the power of the exponent.
static Expression	Expression.pow(Expression numericExpr, Expression exponent)	Creates an expression that returns the numericExpr raised to the power of the exponent.
static Expression	Expression.pow(Expression numericExpr, Number exponent)	Creates an expression that returns the numericExpr raised to the power of the exponent.
static Expression	Expression.pow(String numericField, Expression exponent)	Creates an expression that returns the numericField raised to the power of the exponent.
static AggregateFunction	AggregateFunction.rawAggregate(String name, Expression... expr)	Creates a raw aggregation function.
static Expression	Expression.rawExpression(String name, Expression... expr)	Creates a generic function expression that is not yet implemented.
static BooleanExpression	BooleanExpression.rawFunction(String name, Expression... params)	Creates a 'raw' boolean function expression.
static BooleanExpression	Expression.regexContains(Expression string, Expression pattern)	Creates an expression that checks if a string expression contains a specified regular expression as a substring.
static BooleanExpression	Expression.regexContains(Expression string, String pattern)	Creates an expression that checks if a string expression contains a specified regular expression as a substring.
static BooleanExpression	Expression.regexContains(String fieldName, Expression pattern)	Creates an expression that checks if a string field contains a specified regular expression as a substring.
static Expression	Expression.regexFind(Expression string, Expression pattern)	Creates an expression that returns the first substring of a string expression that matches a specified regular expression.
static Expression	Expression.regexFind(Expression string, String pattern)	Creates an expression that returns the first substring of a string expression that matches a specified regular expression.
static Expression	Expression.regexFind(String fieldName, Expression pattern)	Creates an expression that returns the first substring of a string field that matches a specified regular expression.
static Expression	Expression.regexFindAll(Expression string, Expression pattern)	Creates an expression that evaluates to a list of all substrings in a string expression that match a specified regular expression.
static Expression	Expression.regexFindAll(Expression string, String pattern)	Creates an expression that evaluates to a list of all substrings in a string expression that match a specified regular expression.
static Expression	Expression.regexFindAll(String fieldName, Expression pattern)	Creates an expression that evaluates to a list of all substrings in a string field that match a specified regular expression.
static BooleanExpression	Expression.regexMatch(Expression string, Expression pattern)	Creates an expression that checks if a string field matches a specified regular expression.
static BooleanExpression	Expression.regexMatch(Expression string, String pattern)	Creates an expression that checks if a string field matches a specified regular expression.
static BooleanExpression	Expression.regexMatch(String fieldName, Expression pattern)	Creates an expression that checks if a string field matches a specified regular expression.
static Expression	Expression.reverse(Expression expr)	Creates an expression that reverses a string, blob, or array.
static Expression	Expression.round(Expression numericExpr)	Creates an expression that rounds numericExpr to nearest integer.
final Expression	Expression.roundToPrecision(Expression decimalPlace)	Creates an expression that rounds off this numeric expression to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.roundToPrecision(Expression numericExpr, int decimalPlace)	Creates an expression that rounds off numericExpr to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.roundToPrecision(Expression numericExpr, Expression decimalPlace)	Creates an expression that rounds off numericExpr to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.roundToPrecision(String numericField, Expression decimalPlace)	Creates an expression that rounds off numericField to decimalPlace decimal places if decimalPlace is positive, rounds off digits to the left of the decimal point if decimalPlace is negative.
Expression	Expression.split(Expression delimiter)	Creates an expression that splits this string or blob expression by a delimiter.
static Expression	Expression.split(Expression value, Expression delimiter)	Creates an expression that splits a string or blob by a delimiter.
static Expression	Expression.split(Expression value, String delimiter)	Creates an expression that splits a string or blob by a delimiter.
static Expression	Expression.split(String fieldName, Expression delimiter)	Creates an expression that splits a string or blob by a delimiter.
static Expression	Expression.sqrt(Expression numericExpr)	Creates an expression that returns the square root of numericExpr.
static BooleanExpression	Expression.startsWith(Expression string, Expression prefix)	Creates an expression that checks if a string expression starts with a given prefix.
static BooleanExpression	Expression.startsWith(Expression string, String prefix)	Creates an expression that checks if a string expression starts with a given prefix.
static BooleanExpression	Expression.startsWith(String fieldName, Expression prefix)	Creates an expression that checks if a string expression starts with a given prefix.
final Expression	Expression.stringConcat(Expression... others)	Creates an expression that concatenates string expressions together.
static Expression	Expression.stringConcat(Expression firstString, Object... otherStrings)	Creates an expression that concatenates string expressions together.
static BooleanExpression	Expression.stringContains(Expression string, Expression substring)	Creates an expression that checks if a string expression contains a specified substring.
static BooleanExpression	Expression.stringContains(Expression string, String substring)	Creates an expression that checks if a string expression contains a specified substring.
static BooleanExpression	Expression.stringContains(String fieldName, Expression substring)	Creates an expression that checks if a string field contains a specified substring.
static Expression	Expression.substring(Expression string, Expression index, Expression length)	Creates an expression that returns a substring of the given string.
static Expression	Expression.subtract(Expression minuend, Expression subtrahend)	Creates an expression that subtracts two expressions.
static Expression	Expression.subtract(Expression minuend, Number subtrahend)	Creates an expression that subtracts a constant value from a numeric expression.
static Expression	Expression.subtract(String fieldName, Expression subtrahend)	Creates an expression that subtracts a numeric expressions from numeric field.
static AggregateFunction	AggregateFunction.sum(Expression expression)	Creates an aggregation that calculates the sum of values from an expression across multiple stage inputs.
final Expression	Expression.timestampAdd(Expression unit, Expression amount)	Creates an expression that adds a specified amount of time to this timestamp expression.
static Expression	Expression.timestampAdd(Expression timestamp, Expression unit, Expression amount)	Creates an expression that adds a specified amount of time to a timestamp.
static Expression	Expression.timestampAdd(Expression timestamp, String unit, long amount)	Creates an expression that adds a specified amount of time to a timestamp.
static Expression	Expression.timestampAdd(String fieldName, Expression unit, Expression amount)	Creates an expression that adds a specified amount of time to a timestamp.
final Expression	Expression.timestampSubtract(Expression unit, Expression amount)	Creates an expression that subtracts a specified amount of time to this timestamp expression.
static Expression	Expression.timestampSubtract(Expression timestamp, Expression unit, Expression amount)	Creates an expression that subtracts a specified amount of time to a timestamp.
static Expression	Expression.timestampSubtract(Expression timestamp, String unit, long amount)	Creates an expression that subtracts a specified amount of time to a timestamp.
static Expression	Expression.timestampSubtract(String fieldName, Expression unit, Expression amount)	Creates an expression that subtracts a specified amount of time to a timestamp.
static Expression	Expression.timestampToUnixMicros(Expression expr)	Creates an expression that converts a timestamp expression to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
static Expression	Expression.timestampToUnixMillis(Expression expr)	Creates an expression that converts a timestamp expression to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
static Expression	Expression.timestampToUnixSeconds(Expression expr)	Creates an expression that converts a timestamp expression to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC).
final Expression	Expression.timestampTruncate(Expression granularity)	Creates an expression that truncates this timestamp expression to a specified granularity.
static Expression	Expression.timestampTruncate(Expression timestamp, Expression granularity)	Creates an expression that truncates a timestamp to a specified granularity.
static Expression	Expression.timestampTruncate(Expression timestamp, Expression granularity, String timezone)	Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
static Expression	Expression.timestampTruncate(Expression timestamp, String granularity)	Creates an expression that truncates a timestamp to a specified granularity.
static Expression	Expression.timestampTruncate(Expression timestamp, String granularity, String timezone)	Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
static Expression	Expression.timestampTruncate(String fieldName, Expression granularity)	Creates an expression that truncates a timestamp to a specified granularity.
static Expression	Expression.timestampTruncate(String fieldName, Expression granularity, String timezone)	Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
static Expression	Expression.toLower(Expression string)	Creates an expression that converts a string expression to lowercase.
static Expression	Expression.toUpper(Expression string)	Creates an expression that converts a string expression to uppercase.
static Expression	Expression.trim(Expression string)	Creates an expression that removes leading and trailing whitespace from a string expression.
Expression	Expression.trimValue(Expression characters)	Creates an expression that removes specified characters from the beginning and end of this string or blob expression.
static Expression	Expression.trimValue(Expression value, Expression characters)	Creates an expression that removes specified characters from the beginning and end of a string or blob.
static Expression	Expression.trimValue(Expression value, String characters)	Creates an expression that removes specified characters from the beginning and end of a string or blob.
static Expression	Expression.trimValue(String fieldName, Expression characters)	Creates an expression that removes specified characters from the beginning and end of a string or blob.
static Expression	Expression.trunc(Expression numericExpr)	Creates an expression that truncates numericExpr to an integer.
final Expression	Expression.truncToPrecision(Expression decimalPlace)	Creates an expression that truncates this numeric expression to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.truncToPrecision(Expression numericExpr, int decimalPlace)	Creates an expression that truncates numericExpr to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.truncToPrecision(Expression numericExpr, Expression decimalPlace)	Creates an expression that truncates numericExpr to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.truncToPrecision(String numericField, Expression decimalPlace)	Creates an expression that truncates numericField to decimalPlace decimal places if decimalPlace is positive, truncates digits to the left of the decimal point if decimalPlace is negative.
static Expression	Expression.type(Expression expr)	Creates an expression that returns a string indicating the type of the value this expression evaluates to.
static Expression	Expression.unixMicrosToTimestamp(Expression expr)	Creates an expression that converts a Unix timestamp in microseconds to a Firestore timestamp.
static Expression	Expression.unixMillisToTimestamp(Expression expr)	Creates an expression that interprets an expression as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
static Expression	Expression.unixSecondsToTimestamp(Expression expr)	Creates an expression that interprets an expression as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
static Expression	Expression.vectorLength(Expression vectorExpression)	Creates an expression that calculates the length of a vector.

Uses of Expression in com.google.cloud.firestore.pipeline.stages

Constructors in com.google.cloud.firestore.pipeline.stages with parameters of type Expression

Modifier	Constructor	Description
	FindNearest(Expression property, VectorValue vector, FindNearest.DistanceMeasure distanceMeasure, FindNearestOptions options)
	ReplaceWith(Expression field)
	ReplaceWith(Expression expr, ReplaceWith.Mode mode)

Constructor parameters in com.google.cloud.firestore.pipeline.stages with type arguments of type Expression

Modifier	Constructor	Description
	AddFields(Map<String,Expression> fields)
	Distinct(Map<String,Expression> groups)
	Select(Map<String,Expression> projections)