Uses of Class
com.google.cloud.firestore.pipeline.expressions.Expression
Packages that use Expression
Package
Description
-
Uses of Expression in com.google.cloud.firestore
Methods in com.google.cloud.firestore that return types with arguments of type ExpressionModifier and TypeMethodDescriptionstatic 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 ExpressionModifier and TypeMethodDescriptionstatic ValuePipelineUtils.encodeValue(Expression value) Pipeline.findNearest(Expression property, double[] vector, FindNearest.DistanceMeasure distanceMeasure, FindNearestOptions options) Performs vector distance (similarity) search with given parameters to the stage inputs.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.expressionsModifier and TypeClassDescriptionclassfinal classRepresents a reference to a field in a Firestore document.classMethods in com.google.cloud.firestore.pipeline.expressions that return ExpressionModifier and TypeMethodDescriptionfinal ExpressionExpression.abs()Creates an expression that returns the absolute value of this numeric expression.static ExpressionExpression.abs(Expression numericExpr) Creates an expression that returns the absolute value ofnumericExpr.static ExpressionCreates an expression that returns the absolute value ofnumericField.static ExpressionExpression.add(Expression first, Expression second) Creates an expression that adds numeric expressions.static ExpressionExpression.add(Expression first, Number second) Creates an expression that adds numeric expressions with a constant.final ExpressionCreates an expression that adds this numeric expression to another numeric expression.static ExpressionExpression.add(String fieldName, Expression second) Creates an expression that adds a numeric field with a numeric expression.static ExpressionCreates an expression that adds a numeric field with constant.static ExpressionCreates an expression that creates a Firestore array value from an input object.static ExpressionCreates an expression that creates a Firestore array value from an input object.final ExpressionExpression.arrayConcat(Expression... otherArrays) Creates an expression that concatenates a field's array value with other arrays.static ExpressionExpression.arrayConcat(Expression firstArray, Object... otherArrays) Creates an expression that concatenates multiple arrays into a single array.static ExpressionExpression.arrayConcat(String firstArrayField, Object... otherArrays) Creates an expression that concatenates multiple arrays into a single array.final ExpressionExpression.arrayFirst()Returns the first element of an array.static ExpressionExpression.arrayFirst(Expression array) Creates an expression that returns the first element of an array.static ExpressionExpression.arrayFirst(String arrayFieldName) Creates an expression that returns the first element of an array.final ExpressionExpression.arrayFirstN(int n) Returns the first n elements of an array.final ExpressionExpression.arrayFirstN(Expression n) Returns the first n elements of an array.static ExpressionExpression.arrayFirstN(Expression array, int n) Creates an expression that returns the first n elements of an array.static ExpressionExpression.arrayFirstN(Expression array, Expression n) Creates an expression that returns the first n elements of an array.static ExpressionExpression.arrayFirstN(String arrayFieldName, int n) Creates an expression that returns the first n elements of an array.static ExpressionExpression.arrayFirstN(String arrayFieldName, Expression n) Creates an expression that returns the first n elements of an array.final ExpressionExpression.arrayGet(int offset) Creates an expression that indexes into an array from the beginning or end and return the element.final ExpressionExpression.arrayGet(Expression offset) Creates an expression that indexes into an array from the beginning or end and return the element.static ExpressionExpression.arrayGet(Expression array, int offset) Creates an expression that returns an element from an array at a specified index.static ExpressionExpression.arrayGet(Expression array, Expression offset) Creates an expression that returns an element from an array at a specified index.static ExpressionCreates an expression that returns an element from an array at a specified index.static ExpressionExpression.arrayGet(String arrayFieldName, Expression offset) Creates an expression that returns an element from an array at a specified index.final ExpressionExpression.arrayIndexOf(Expression value) Returns the index of the first occurrence of a value in an array.static ExpressionExpression.arrayIndexOf(Expression array, Expression value) Creates an expression that returns the index of the first occurrence of a value in an array.static ExpressionExpression.arrayIndexOf(Expression array, Object value) Creates an expression that returns the index of the first occurrence of a value in an array.final ExpressionExpression.arrayIndexOf(Object value) Returns the index of the first occurrence of a value in an array.static ExpressionExpression.arrayIndexOf(String arrayFieldName, Expression value) Creates an expression that returns the index of the first occurrence of a value in an array.static ExpressionExpression.arrayIndexOf(String arrayFieldName, Object value) Creates an expression that returns the index of the first occurrence of a value in an array.final ExpressionExpression.arrayIndexOfAll(Expression value) Returns all indices of a value in an array.static ExpressionExpression.arrayIndexOfAll(Expression array, Expression value) Creates an expression that returns all indices of a value in an array.static ExpressionExpression.arrayIndexOfAll(Expression array, Object value) Creates an expression that returns all indices of a value in an array.final ExpressionExpression.arrayIndexOfAll(Object value) Returns all indices of a value in an array.static ExpressionExpression.arrayIndexOfAll(String arrayFieldName, Expression value) Creates an expression that returns all indices of a value in an array.static ExpressionExpression.arrayIndexOfAll(String arrayFieldName, Object value) Creates an expression that returns all indices of a value in an array.final ExpressionExpression.arrayLast()Returns the last element of an array.static ExpressionExpression.arrayLast(Expression array) Creates an expression that returns the last element of an array.static ExpressionCreates an expression that returns the last element of an array.final ExpressionExpression.arrayLastIndexOf(Expression value) Returns the index of the last occurrence of a value in an array.static ExpressionExpression.arrayLastIndexOf(Expression array, Expression value) Creates an expression that returns the index of the last occurrence of a value in an array.static ExpressionExpression.arrayLastIndexOf(Expression array, Object value) Creates an expression that returns the index of the last occurrence of a value in an array.final ExpressionExpression.arrayLastIndexOf(Object value) Returns the index of the last occurrence of a value in an array.static ExpressionExpression.arrayLastIndexOf(String arrayFieldName, Expression value) Creates an expression that returns the index of the last occurrence of a value in an array.static ExpressionExpression.arrayLastIndexOf(String arrayFieldName, Object value) Creates an expression that returns the index of the last occurrence of a value in an array.final ExpressionExpression.arrayLastN(int n) Returns the last n elements of an array.final ExpressionExpression.arrayLastN(Expression n) Returns the last n elements of an array.static ExpressionExpression.arrayLastN(Expression array, int n) Creates an expression that returns the last n elements of an array.static ExpressionExpression.arrayLastN(Expression array, Expression n) Creates an expression that returns the last n elements of an array.static ExpressionExpression.arrayLastN(String arrayFieldName, int n) Creates an expression that returns the last n elements of an array.static ExpressionExpression.arrayLastN(String arrayFieldName, Expression n) Creates an expression that returns the last n elements of an array.final ExpressionExpression.arrayLength()Creates an expression that calculates the length of an array expression.static ExpressionExpression.arrayLength(Expression array) Creates an expression that returns the length of an array.static ExpressionExpression.arrayLength(String arrayFieldName) Creates an expression that returns the length of an array.final ExpressionExpression.arrayMaximum()Returns the maximum value of an array.static ExpressionExpression.arrayMaximum(Expression array) Creates an expression that returns the maximum value of an array.static ExpressionExpression.arrayMaximum(String arrayFieldName) Creates an expression that returns the maximum value of an array.final ExpressionExpression.arrayMaximumN(int n) Returns the n maximum values of an array.final ExpressionExpression.arrayMaximumN(Expression n) Returns the n maximum values of an array.static ExpressionExpression.arrayMaximumN(Expression array, int n) Creates an expression that returns the n maximum values of an array.static ExpressionExpression.arrayMaximumN(Expression array, Expression n) Creates an expression that returns the n maximum values of an array.static ExpressionExpression.arrayMaximumN(String arrayFieldName, int n) Creates an expression that returns the n maximum values of an array.static ExpressionExpression.arrayMaximumN(String arrayFieldName, Expression n) Creates an expression that returns the n maximum values of an array.final ExpressionExpression.arrayMinimum()Returns the minimum value of an array.static ExpressionExpression.arrayMinimum(Expression array) Creates an expression that returns the minimum value of an array.static ExpressionExpression.arrayMinimum(String arrayFieldName) Creates an expression that returns the minimum value of an array.final ExpressionExpression.arrayMinimumN(int n) Returns the n minimum values of an array.final ExpressionExpression.arrayMinimumN(Expression n) Returns the n minimum values of an array.static ExpressionExpression.arrayMinimumN(Expression array, int n) Creates an expression that returns the n minimum values of an array.static ExpressionExpression.arrayMinimumN(Expression array, Expression n) Creates an expression that returns the n minimum values of an array.static ExpressionExpression.arrayMinimumN(String arrayFieldName, int n) Creates an expression that returns the n minimum values of an array.static ExpressionExpression.arrayMinimumN(String arrayFieldName, Expression n) Creates an expression that returns the n minimum values of an array.final ExpressionExpression.arrayReverse()Reverses the order of elements in the array.static ExpressionExpression.arrayReverse(Expression array) Creates an expression that reverses an array.static ExpressionExpression.arrayReverse(String arrayFieldName) Creates an expression that reverses an array.Expression.arraySum()Creates an expression that returns the sum of the elements of this array expression.static ExpressionExpression.arraySum(Expression array) Creates an expression that returns the sum of the elements of an array.static ExpressionCreates an expression that returns the sum of the elements of an array.final ExpressionExpression.byteLength()Creates an expression that calculates the length of a string in UTF-8 bytes, or just the length of a Blob.static ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.ceil()Creates an expression that returns the smallest integer that isn't less than this numeric expression.static ExpressionExpression.ceil(Expression numericExpr) Creates an expression that returns the smallest integer that isn't less thannumericExpr.static ExpressionCreates an expression that returns the smallest integer that isn't less thannumericField.final ExpressionExpression.charLength()Creates an expression that calculates the character length of this string expression in UTF8.static ExpressionExpression.charLength(Expression string) Creates an expression that calculates the character length of a string expression in UTF8.static ExpressionExpression.charLength(String fieldName) Creates an expression that calculates the character length of a string field in UTF8.final ExpressionExpression.collectionId()Creates an expression that returns the collection ID from this path expression.static ExpressionExpression.collectionId(Expression path) Creates an expression that returns the collection ID from a path.static ExpressionExpression.collectionId(String pathFieldName) Creates an expression that returns the collection ID from a path.static ExpressionExpression.concat(Expression first, Object... others) Creates an expression that concatenates expressions together.Creates an expression that concatenates this expression with other values.static ExpressionCreates an expression that concatenates expressions together.final ExpressionBooleanExpression.conditional(Expression thenExpr, Expression elseExpr) Creates a conditional expression that evaluates to athenExprexpression if this condition is true or anelseExprexpression if the condition is false.final ExpressionBooleanExpression.conditional(Object thenValue, Object elseValue) Creates a conditional expression that evaluates to athenValueif this condition is true or anelseValueif the condition is false.static ExpressionExpression.conditional(BooleanExpression condition, Expression thenExpr, Expression elseExpr) Creates a conditional expression that evaluates to athenExprexpression if a condition is true or anelseExprexpression if the condition is false.static ExpressionExpression.conditional(BooleanExpression condition, Object thenValue, Object elseValue) Creates a conditional expression that evaluates to athenValueif a condition is true or anelseValueif the condition is false.static ExpressionExpression.constant(byte[] value) Create a constant for a bytes value.static ExpressionCreate a constant for aBlobvalue.static ExpressionExpression.constant(DocumentReference value) Create a constant for aDocumentReferencevalue.static ExpressionCreate a constant for aGeoPointvalue.static ExpressionExpression.constant(VectorValue value) Create a constant for aVectorValuevalue.static ExpressionExpression.constant(com.google.cloud.Timestamp value) Create a constant for aTimestampvalue.static ExpressionCreate a constant for aNumbervalue.static ExpressionCreate a constant for aStringvalue.static ExpressionCreate a constant for aDatevalue.final ExpressionExpression.cosineDistance(double[] vector) Calculates the Cosine distance between this vector expression and a vector literal.final ExpressionExpression.cosineDistance(Expression vector) Calculates the Cosine distance between this and another vector expressions.static ExpressionExpression.cosineDistance(Expression vector1, double[] vector2) Creates an expression that calculates the cosine distance between two vectors.static ExpressionExpression.cosineDistance(Expression vector1, Expression vector2) Creates an expression that calculates the cosine distance between two vectors.static ExpressionExpression.cosineDistance(String vectorFieldName, double[] vector) Creates an expression that calculates the cosine distance between two vectors.static ExpressionExpression.cosineDistance(String vectorFieldName, Expression vector) Creates an expression that calculates the cosine distance between two vectors.static ExpressionExpression.currentTimestamp()Creates an expression that returns the current timestamp.static ExpressionExpression.divide(Expression dividend, Expression divisor) Creates an expression that divides two numeric expressions.static ExpressionExpression.divide(Expression dividend, Number divisor) Creates an expression that divides a numeric expression by a constant.final ExpressionCreates an expression that divides this numeric expression by another numeric expression.static ExpressionExpression.divide(String fieldName, Expression divisor) Creates an expression that divides numeric field by a numeric expression.static ExpressionCreates an expression that divides a numeric field by a constant.final ExpressionExpression.documentId()Creates an expression that returns the document ID from this path expression.static ExpressionExpression.documentId(DocumentReference docRef) Creates an expression that returns the document ID from aDocumentReference.static ExpressionExpression.documentId(Expression documentPath) Creates an expression that returns the document ID from a path.static ExpressionExpression.documentId(String documentPath) Creates an expression that returns the document ID from a path.final ExpressionExpression.dotProduct(double[] vector) Calculates the dot product distance between this vector expression and a vector literal.final ExpressionExpression.dotProduct(Expression vector) Calculates the dot product distance between this and another vector expression.static ExpressionExpression.dotProduct(Expression vector1, double[] vector2) Creates an expression that calculates the dot product of two vectors.static ExpressionExpression.dotProduct(Expression vector1, Expression vector2) Creates an expression that calculates the dot product of two vectors.static ExpressionExpression.dotProduct(String vectorFieldName, double[] vector) Creates an expression that calculates the dot product of two vectors.static ExpressionExpression.dotProduct(String vectorFieldName, Expression vector) Creates an expression that calculates the dot product of two vectors.final ExpressionExpression.euclideanDistance(double[] vector) Calculates the Euclidean distance between this vector expression and a vector literal.final ExpressionExpression.euclideanDistance(Expression vector) Calculates the Euclidean distance between this and another vector expression.static ExpressionExpression.euclideanDistance(Expression vector1, double[] vector2) Creates an expression that calculates the Euclidean distance between two vectors.static ExpressionExpression.euclideanDistance(Expression vector1, Expression vector2) Creates an expression that calculates the Euclidean distance between two vectors.static ExpressionExpression.euclideanDistance(String vectorFieldName, double[] vector) Creates an expression that calculates the Euclidean distance between two vectors.static ExpressionExpression.euclideanDistance(String vectorFieldName, Expression vector) Creates an expression that calculates the Euclidean distance between two vectors.final ExpressionExpression.exp()Creates an expression that returns Euler's number e raised to the power of this numeric expression.static ExpressionExpression.exp(Expression numericExpr) Creates an expression that returns Euler's number e raised to the power ofnumericExpr.static ExpressionCreates an expression that returns Euler's number e raised to the power ofnumericField.final ExpressionExpression.floor()Creates an expression that returns the largest integer that isn't less than this numeric expression.static ExpressionExpression.floor(Expression numericExpr) Creates an expression that returns the largest integer that isn't less thannumericExpr.static ExpressionCreates an expression that returns the largest integer that isn't less thannumericField.AliasedExpression.getExpr()Ordering.getExpr()static ExpressionExpression.ifAbsent(Expression ifExpr, Expression elseExpr) Creates an expression that returns a default value if an expression evaluates to an absent value.static ExpressionExpression.ifAbsent(Expression ifExpr, Object elseValue) Creates an expression that returns a default value if an expression evaluates to an absent value.Creates an expression that returns a default value if this expression evaluates to an absent value.static ExpressionExpression.ifAbsent(String ifFieldName, Expression elseExpr) Creates an expression that returns a default value if a field is absent.static ExpressionCreates an expression that returns a default value if a field is absent.final ExpressionExpression.ifError(Expression catchExpr) Creates an expression that returns thecatchExprargument if there is an error, else return the result of this expression.static ExpressionExpression.ifError(Expression tryExpr, Expression catchExpr) Creates an expression that returns thecatchExprargument if there is an error, else return the result of thetryExprargument evaluation.static ExpressionExpression.ifError(Expression tryExpr, Object catchValue) Creates an expression that returns thecatchValueargument if there is an error, else return the result of thetryExprargument evaluation.final ExpressionCreates an expression that returns thecatchValueargument if there is an error, else return the result of this expression.Expression.join(Expression delimiter) Creates an expression that joins the elements of this array expression into a string.static ExpressionExpression.join(Expression arrayExpression, Expression delimiterExpression) Creates an expression that joins the elements of an array into a string.static ExpressionExpression.join(Expression arrayExpression, String delimiter) Creates an expression that joins the elements of an array into a string.Creates an expression that joins the elements of this array expression into a string.static ExpressionExpression.join(String arrayFieldName, Expression delimiterExpression) Creates an expression that joins the elements of an array into a string.static ExpressionCreates an expression that joins the elements of an array into a string.final ExpressionExpression.length()Creates an expression that calculates the length of the expression if it is a string, array, map, or Blob.static ExpressionExpression.length(Expression string) Creates an expression that calculates the length of string, array, map, vector, or Blob.static ExpressionCreates an expression that calculates the length of string, array, map, vector, or Blob.final ExpressionExpression.ln()Creates an expression that returns the natural logarithm (base e) of this numeric expression.static ExpressionExpression.ln(Expression numericExpr) Creates an expression that returns the natural logarithm (base e) ofnumericExpr.static ExpressionCreates an expression that returns the natural logarithm (base e) ofnumericField.static ExpressionExpression.log(Expression numericExpr, Expression base) Creates an expression that returns the logarithm ofnumericExprwith a givenbase.static ExpressionExpression.log(Expression numericExpr, Number base) Creates an expression that returns the logarithm ofnumericExprwith a givenbase.static ExpressionExpression.log(String numericField, Expression base) Creates an expression that returns the logarithm ofnumericFieldwith a givenbase.static ExpressionCreates an expression that returns the logarithm ofnumericFieldwith a givenbase.Expression.log10()Creates an expression that returns the base 10 logarithm of this numeric expression.static ExpressionExpression.log10(Expression numericExpr) Creates an expression that returns the base 10 logarithm ofnumericExpr.static ExpressionCreates an expression that returns the base 10 logarithm ofnumericField.static ExpressionExpression.logicalMaximum(Expression expr, Object... others) Creates an expression that returns the largest value between multiple input expressions or literal values.final ExpressionExpression.logicalMaximum(Object... others) Creates an expression that returns the largest value between multiple input expressions or literal values.static ExpressionExpression.logicalMaximum(String fieldName, Object... others) Creates an expression that returns the largest value between multiple input expressions or literal values.static ExpressionExpression.logicalMinimum(Expression expr, Object... others) Creates an expression that returns the smallest value between multiple input expressions or literal values.final ExpressionExpression.logicalMinimum(Object... others) Creates an expression that returns the smallest value between multiple input expressions or literal values.static ExpressionExpression.logicalMinimum(String fieldName, Object... others) Creates an expression that returns the smallest value between multiple input expressions or literal values.static ExpressionCreates an expression that creates a Firestore map value from an input object.static ExpressionExpression.mapGet(Expression map, Expression key) Accesses a value from a map (object) field using the providedkeyExpression.static ExpressionExpression.mapGet(Expression map, String key) Accesses a value from a map (object) field using the providedkey.final ExpressionAccesses a map (object) value using the providedkey.static ExpressionExpression.mapGet(String fieldName, Expression key) Accesses a value from a map (object) field using the providedkeyExpression.static ExpressionAccesses a value from a map (object) field using the providedkey.static ExpressionExpression.mapMerge(Expression firstMap, Expression secondMap) final ExpressionExpression.mapMerge(Expression secondMap, Expression... otherMaps) Creates an expression that merges multiple maps into a single map.static ExpressionExpression.mapMerge(Expression firstMap, Expression secondMap, Expression... otherMaps) Creates an expression that merges multiple maps into a single map.static ExpressionExpression.mapMerge(String firstMapFieldName, Expression secondMap) static ExpressionExpression.mapMerge(String firstMapFieldName, Expression secondMap, Expression... otherMaps) Creates an expression that merges multiple maps into a single map.final ExpressionExpression.mapRemove(Expression key) Creates an expression that removes a key from this map expression.static ExpressionExpression.mapRemove(Expression mapExpr, Expression key) Creates an expression that removes a key from a map.static ExpressionExpression.mapRemove(Expression mapExpr, String key) Creates an expression that removes a key from a map.final ExpressionCreates an expression that removes a key from this map expression.static ExpressionExpression.mapRemove(String mapField, Expression key) Creates an expression that removes a key from a map.static ExpressionCreates an expression that removes a key from a map.static ExpressionExpression.mod(Expression dividend, Expression divisor) Creates an expression that calculates the modulo (remainder) of dividing two numeric expressions.static ExpressionExpression.mod(Expression dividend, Number divisor) Creates an expression that calculates the modulo (remainder) of dividing a numeric expression by a constant.final ExpressionCreates an expression that calculates the modulo (remainder) of dividing this numeric expressions by another numeric expression.static ExpressionExpression.mod(String fieldName, Expression divisor) Creates an expression that calculates the modulo (remainder) of dividing a numeric field by a constant.static ExpressionCreates an expression that calculates the modulo (remainder) of dividing a numeric field by a constant.static ExpressionExpression.multiply(Expression first, Expression second) Creates an expression that multiplies numeric expressions.static ExpressionExpression.multiply(Expression first, Number second) Creates an expression that multiplies numeric expressions with a constant.final ExpressionCreates an expression that multiplies this numeric expression with another numeric expression.static ExpressionExpression.multiply(String fieldName, Expression second) Creates an expression that multiplies a numeric field with a numeric expression.static ExpressionCreates an expression that multiplies a numeric field with a constant.static ExpressionExpression.nullValue()Constant for a null value.final ExpressionExpression.pow(Expression exponent) Creates an expression that returns this numeric expression raised to the power of theexponent.static ExpressionExpression.pow(Expression numericExpr, Expression exponent) Creates an expression that returns thenumericExprraised to the power of theexponent.static ExpressionExpression.pow(Expression numericExpr, Number exponent) Creates an expression that returns thenumericExprraised to the power of theexponent.final ExpressionCreates an expression that returns this numeric expression raised to the power of theexponent.static ExpressionExpression.pow(String numericField, Expression exponent) Creates an expression that returns thenumericFieldraised to the power of theexponent.static ExpressionCreates an expression that returns thenumericFieldraised to the power of theexponent.static ExpressionExpression.rand()Creates an expression that returns a random double between 0.0 and 1.0 but not including 1.0.static ExpressionExpression.rawExpression(String name, Expression... expr) Creates a generic function expression that is not yet implemented.static ExpressionExpression.regexFind(Expression string, Expression pattern) Creates an expression that returns the first substring of a string expression that matches a specified regular expression.static ExpressionExpression.regexFind(Expression string, String pattern) Creates an expression that returns the first substring of a string expression that matches a specified regular expression.final ExpressionCreates an expression that returns the first substring of a string expression that matches a specified regular expression.static ExpressionExpression.regexFind(String fieldName, Expression pattern) Creates an expression that returns the first substring of a string field that matches a specified regular expression.static ExpressionCreates an expression that returns the first substring of a string field that matches a specified regular expression.static ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.reverse()Creates an expression that reverses this expression, which must be a string, blob, or array.static ExpressionExpression.reverse(Expression expr) Creates an expression that reverses a string, blob, or array.static ExpressionCreates an expression that reverses the field value, which must be a string, blob, or array.final ExpressionExpression.round()Creates an expression that rounds this numeric expression to nearest integer.static ExpressionExpression.round(Expression numericExpr) Creates an expression that roundsnumericExprto nearest integer.static ExpressionCreates an expression that roundsnumericFieldto nearest integer.final ExpressionExpression.roundToPrecision(int decimalPlace) Creates an expression that rounds off this numeric expression todecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.final ExpressionExpression.roundToPrecision(Expression decimalPlace) Creates an expression that rounds off this numeric expression todecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.roundToPrecision(Expression numericExpr, int decimalPlace) Creates an expression that rounds offnumericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.roundToPrecision(Expression numericExpr, Expression decimalPlace) Creates an expression that rounds offnumericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.roundToPrecision(String numericField, int decimalPlace) Creates an expression that rounds offnumericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.roundToPrecision(String numericField, Expression decimalPlace) Creates an expression that rounds offnumericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.Expression.split(Expression delimiter) Creates an expression that splits this string or blob expression by a delimiter.static ExpressionExpression.split(Expression value, Expression delimiter) Creates an expression that splits a string or blob by a delimiter.static ExpressionExpression.split(Expression value, String delimiter) Creates an expression that splits a string or blob by a delimiter.Creates an expression that splits this string or blob expression by a delimiter.static ExpressionExpression.split(String fieldName, Expression delimiter) Creates an expression that splits a string or blob by a delimiter.static ExpressionCreates an expression that splits a string or blob by a delimiter.final ExpressionExpression.sqrt()Creates an expression that returns the square root of this numeric expression.static ExpressionExpression.sqrt(Expression numericExpr) Creates an expression that returns the square root ofnumericExpr.static ExpressionCreates an expression that returns the square root ofnumericField.final ExpressionExpression.stringConcat(Expression... others) Creates an expression that concatenates string expressions together.static ExpressionExpression.stringConcat(Expression firstString, Object... otherStrings) Creates an expression that concatenates string expressions together.final ExpressionExpression.stringConcat(String... others) Creates an expression that concatenates string expressions and string constants together.static ExpressionExpression.stringConcat(String fieldName, Object... otherStrings) Creates an expression that concatenates string expressions together.static ExpressionExpression.substring(Expression string, Expression index, Expression length) Creates an expression that returns a substring of the given string.final ExpressionCreates an expression that returns a substring of the given string.static ExpressionCreates an expression that returns a substring of the given string.static ExpressionExpression.subtract(Expression minuend, Expression subtrahend) Creates an expression that subtracts two expressions.static ExpressionExpression.subtract(Expression minuend, Number subtrahend) Creates an expression that subtracts a constant value from a numeric expression.final ExpressionCreates an expression that subtracts a numeric expressions from this numeric expression.static ExpressionExpression.subtract(String fieldName, Expression subtrahend) Creates an expression that subtracts a numeric expressions from numeric field.static ExpressionCreates an expression that subtracts a constant from numeric field.final ExpressionExpression.timestampAdd(Expression unit, Expression amount) Creates an expression that adds a specified amount of time to this timestamp expression.static ExpressionExpression.timestampAdd(Expression timestamp, Expression unit, Expression amount) Creates an expression that adds a specified amount of time to a timestamp.static ExpressionExpression.timestampAdd(Expression timestamp, String unit, long amount) Creates an expression that adds a specified amount of time to a timestamp.final ExpressionExpression.timestampAdd(String unit, long amount) Creates an expression that adds a specified amount of time to this timestamp expression.static ExpressionExpression.timestampAdd(String fieldName, Expression unit, Expression amount) Creates an expression that adds a specified amount of time to a timestamp.static ExpressionExpression.timestampAdd(String fieldName, String unit, long amount) Creates an expression that adds a specified amount of time to a timestamp.final ExpressionExpression.timestampSubtract(Expression unit, Expression amount) Creates an expression that subtracts a specified amount of time to this timestamp expression.static ExpressionExpression.timestampSubtract(Expression timestamp, Expression unit, Expression amount) Creates an expression that subtracts a specified amount of time to a timestamp.static ExpressionExpression.timestampSubtract(Expression timestamp, String unit, long amount) Creates an expression that subtracts a specified amount of time to a timestamp.final ExpressionExpression.timestampSubtract(String unit, long amount) Creates an expression that subtracts a specified amount of time to this timestamp expression.static ExpressionExpression.timestampSubtract(String fieldName, Expression unit, Expression amount) Creates an expression that subtracts a specified amount of time to a timestamp.static ExpressionExpression.timestampSubtract(String fieldName, String unit, long amount) Creates an expression that subtracts a specified amount of time to a timestamp.final ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.timestampTruncate(Expression granularity) Creates an expression that truncates this timestamp expression to a specified granularity.static ExpressionExpression.timestampTruncate(Expression timestamp, Expression granularity) Creates an expression that truncates a timestamp to a specified granularity.static ExpressionExpression.timestampTruncate(Expression timestamp, Expression granularity, String timezone) Creates an expression that truncates a timestamp to a specified granularity in a given timezone.static ExpressionExpression.timestampTruncate(Expression timestamp, String granularity) Creates an expression that truncates a timestamp to a specified granularity.static ExpressionExpression.timestampTruncate(Expression timestamp, String granularity, String timezone) Creates an expression that truncates a timestamp to a specified granularity in a given timezone.final ExpressionExpression.timestampTruncate(String granularity) Creates an expression that truncates this timestamp expression to a specified granularity.static ExpressionExpression.timestampTruncate(String fieldName, Expression granularity) Creates an expression that truncates a timestamp to a specified granularity.static ExpressionExpression.timestampTruncate(String fieldName, Expression granularity, String timezone) Creates an expression that truncates a timestamp to a specified granularity in a given timezone.static ExpressionExpression.timestampTruncate(String fieldName, String granularity) Creates an expression that truncates a timestamp to a specified granularity.static ExpressionExpression.timestampTruncate(String fieldName, String granularity, String timezone) Creates an expression that truncates a timestamp to a specified granularity in a given timezone.final ExpressionExpression.toLower()Creates an expression that converts this string expression to lowercase.static ExpressionExpression.toLower(Expression string) Creates an expression that converts a string expression to lowercase.static ExpressionCreates an expression that converts a string field to lowercase.final ExpressionExpression.toUpper()Creates an expression that converts this string expression to uppercase.static ExpressionExpression.toUpper(Expression string) Creates an expression that converts a string expression to uppercase.static ExpressionCreates an expression that converts a string field to uppercase.final ExpressionExpression.trim()Creates an expression that removes leading and trailing whitespace from this string expression.static ExpressionExpression.trim(Expression string) Creates an expression that removes leading and trailing whitespace from a string expression.static ExpressionCreates an expression that removes leading and trailing whitespace from a string field.Expression.trimValue(Expression characters) Creates an expression that removes specified characters from the beginning and end of this string or blob expression.static ExpressionExpression.trimValue(Expression value, Expression characters) Creates an expression that removes specified characters from the beginning and end of a string or blob.static ExpressionExpression.trimValue(Expression value, String characters) Creates an expression that removes specified characters from the beginning and end of a string or blob.Creates an expression that removes specified characters from the beginning and end of this string or blob expression.static ExpressionExpression.trimValue(String fieldName, Expression characters) Creates an expression that removes specified characters from the beginning and end of a string or blob.static ExpressionCreates an expression that removes specified characters from the beginning and end of a string or blob.final ExpressionExpression.trunc()Creates an expression that truncates this numeric expression to an integer.static ExpressionExpression.trunc(Expression numericExpr) Creates an expression that truncatesnumericExprto an integer.static ExpressionCreates an expression that truncatesnumericFieldto an integer.final ExpressionExpression.truncToPrecision(int decimalPlace) Creates an expression that truncates this numeric expression todecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.final ExpressionExpression.truncToPrecision(Expression decimalPlace) Creates an expression that truncates this numeric expression todecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.truncToPrecision(Expression numericExpr, int decimalPlace) Creates an expression that truncatesnumericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.truncToPrecision(Expression numericExpr, Expression decimalPlace) Creates an expression that truncatesnumericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.truncToPrecision(String numericField, int decimalPlace) Creates an expression that truncatesnumericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.truncToPrecision(String numericField, Expression decimalPlace) Creates an expression that truncatesnumericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.final ExpressionExpression.type()Creates an expression that returns a string indicating the type of the value this expression evaluates to.static ExpressionExpression.type(Expression expr) Creates an expression that returns a string indicating the type of the value this expression evaluates to.static ExpressionCreates an expression that returns a string indicating the type of the value this field evaluates to.final ExpressionExpression.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 ExpressionExpression.unixMicrosToTimestamp(Expression expr) Creates an expression that converts a Unix timestamp in microseconds to a Firestore timestamp.static ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.vectorLength()Creates an expression that calculates the length (dimension) of a Firestore Vector.static ExpressionExpression.vectorLength(Expression vectorExpression) Creates an expression that calculates the length of a vector.static ExpressionExpression.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 ExpressionModifier and TypeMethodDescriptionstatic ExpressionExpression.abs(Expression numericExpr) Creates an expression that returns the absolute value ofnumericExpr.static ExpressionExpression.add(Expression first, Expression second) Creates an expression that adds numeric expressions.static ExpressionExpression.add(Expression first, Number second) Creates an expression that adds numeric expressions with a constant.static ExpressionExpression.add(String fieldName, Expression second) Creates an expression that adds a numeric field with a numeric expression.static AggregateFunctionAggregateFunction.arrayAgg(Expression expression) Creates an aggregation that collects all values of an expression across multiple stage inputs into an array.static AggregateFunctionAggregateFunction.arrayAggDistinct(Expression expression) Creates an aggregation that collects all distinct values of an expression across multiple stage inputs into an array.final ExpressionExpression.arrayConcat(Expression... otherArrays) Creates an expression that concatenates a field's array value with other arrays.static ExpressionExpression.arrayConcat(Expression firstArray, Object... otherArrays) Creates an expression that concatenates multiple arrays into a single array.static BooleanExpressionExpression.arrayContains(Expression array, Expression element) Creates an expression that checks if an array contains a specified element.static BooleanExpressionExpression.arrayContains(Expression array, Object element) Creates an expression that checks if an array contains a specified element.static BooleanExpressionExpression.arrayContains(String arrayFieldName, Expression element) Creates an expression that checks if an array contains a specified element.final BooleanExpressionExpression.arrayContainsAll(Expression arrayExpression) Creates an expression that checks if array contains all elements ofarrayExpression.static BooleanExpressionExpression.arrayContainsAll(Expression array, Expression arrayExpression) Creates an expression that checks if an array contains all of the elements of another array.static BooleanExpressionExpression.arrayContainsAll(Expression array, List<Object> values) Creates an expression that checks if an array contains all of the provided values.static BooleanExpressionExpression.arrayContainsAll(String arrayFieldName, Expression arrayExpression) Creates an expression that checks if an array contains all of the elements of another array.final BooleanExpressionExpression.arrayContainsAny(Expression arrayExpression) Creates an expression that checks if array contains any elements ofarrayExpression.static BooleanExpressionExpression.arrayContainsAny(Expression array, Expression arrayExpression) Creates an expression that checks if an array contains any of the elements of another array.static BooleanExpressionExpression.arrayContainsAny(Expression array, List<Object> values) Creates an expression that checks if an array contains any of the provided values.static BooleanExpressionExpression.arrayContainsAny(String arrayFieldName, Expression arrayExpression) Creates an expression that checks if an array contains any of the elements of another array.static ExpressionExpression.arrayFirst(Expression array) Creates an expression that returns the first element of an array.final ExpressionExpression.arrayFirstN(Expression n) Returns the first n elements of an array.static ExpressionExpression.arrayFirstN(Expression array, int n) Creates an expression that returns the first n elements of an array.static ExpressionExpression.arrayFirstN(Expression array, Expression n) Creates an expression that returns the first n elements of an array.static ExpressionExpression.arrayFirstN(String arrayFieldName, Expression n) Creates an expression that returns the first n elements of an array.final ExpressionExpression.arrayGet(Expression offset) Creates an expression that indexes into an array from the beginning or end and return the element.static ExpressionExpression.arrayGet(Expression array, int offset) Creates an expression that returns an element from an array at a specified index.static ExpressionExpression.arrayGet(Expression array, Expression offset) Creates an expression that returns an element from an array at a specified index.static ExpressionExpression.arrayGet(String arrayFieldName, Expression offset) Creates an expression that returns an element from an array at a specified index.final ExpressionExpression.arrayIndexOf(Expression value) Returns the index of the first occurrence of a value in an array.static ExpressionExpression.arrayIndexOf(Expression array, Expression value) Creates an expression that returns the index of the first occurrence of a value in an array.static ExpressionExpression.arrayIndexOf(Expression array, Object value) Creates an expression that returns the index of the first occurrence of a value in an array.static ExpressionExpression.arrayIndexOf(String arrayFieldName, Expression value) Creates an expression that returns the index of the first occurrence of a value in an array.final ExpressionExpression.arrayIndexOfAll(Expression value) Returns all indices of a value in an array.static ExpressionExpression.arrayIndexOfAll(Expression array, Expression value) Creates an expression that returns all indices of a value in an array.static ExpressionExpression.arrayIndexOfAll(Expression array, Object value) Creates an expression that returns all indices of a value in an array.static ExpressionExpression.arrayIndexOfAll(String arrayFieldName, Expression value) Creates an expression that returns all indices of a value in an array.static ExpressionExpression.arrayLast(Expression array) Creates an expression that returns the last element of an array.final ExpressionExpression.arrayLastIndexOf(Expression value) Returns the index of the last occurrence of a value in an array.static ExpressionExpression.arrayLastIndexOf(Expression array, Expression value) Creates an expression that returns the index of the last occurrence of a value in an array.static ExpressionExpression.arrayLastIndexOf(Expression array, Object value) Creates an expression that returns the index of the last occurrence of a value in an array.static ExpressionExpression.arrayLastIndexOf(String arrayFieldName, Expression value) Creates an expression that returns the index of the last occurrence of a value in an array.final ExpressionExpression.arrayLastN(Expression n) Returns the last n elements of an array.static ExpressionExpression.arrayLastN(Expression array, int n) Creates an expression that returns the last n elements of an array.static ExpressionExpression.arrayLastN(Expression array, Expression n) Creates an expression that returns the last n elements of an array.static ExpressionExpression.arrayLastN(String arrayFieldName, Expression n) Creates an expression that returns the last n elements of an array.static ExpressionExpression.arrayLength(Expression array) Creates an expression that returns the length of an array.static ExpressionExpression.arrayMaximum(Expression array) Creates an expression that returns the maximum value of an array.final ExpressionExpression.arrayMaximumN(Expression n) Returns the n maximum values of an array.static ExpressionExpression.arrayMaximumN(Expression array, int n) Creates an expression that returns the n maximum values of an array.static ExpressionExpression.arrayMaximumN(Expression array, Expression n) Creates an expression that returns the n maximum values of an array.static ExpressionExpression.arrayMaximumN(String arrayFieldName, Expression n) Creates an expression that returns the n maximum values of an array.static ExpressionExpression.arrayMinimum(Expression array) Creates an expression that returns the minimum value of an array.final ExpressionExpression.arrayMinimumN(Expression n) Returns the n minimum values of an array.static ExpressionExpression.arrayMinimumN(Expression array, int n) Creates an expression that returns the n minimum values of an array.static ExpressionExpression.arrayMinimumN(Expression array, Expression n) Creates an expression that returns the n minimum values of an array.static ExpressionExpression.arrayMinimumN(String arrayFieldName, Expression n) Creates an expression that returns the n minimum values of an array.static ExpressionExpression.arrayReverse(Expression array) Creates an expression that reverses an array.static ExpressionExpression.arraySum(Expression array) Creates an expression that returns the sum of the elements of an array.static OrderingOrdering.ascending(Expression expr) static AggregateFunctionAggregateFunction.average(Expression expression) Creates an aggregation that calculates the average (mean) of values from an expression across multiple stage inputs.static ExpressionExpression.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 ExpressionExpression.ceil(Expression numericExpr) Creates an expression that returns the smallest integer that isn't less thannumericExpr.static ExpressionExpression.charLength(Expression string) Creates an expression that calculates the character length of a string expression in UTF8.static ExpressionExpression.collectionId(Expression path) Creates an expression that returns the collection ID from a path.static ExpressionExpression.concat(Expression first, Object... others) Creates an expression that concatenates expressions together.final ExpressionBooleanExpression.conditional(Expression thenExpr, Expression elseExpr) Creates a conditional expression that evaluates to athenExprexpression if this condition is true or anelseExprexpression if the condition is false.static ExpressionExpression.conditional(BooleanExpression condition, Expression thenExpr, Expression elseExpr) Creates a conditional expression that evaluates to athenExprexpression if a condition is true or anelseExprexpression if the condition is false.final ExpressionExpression.cosineDistance(Expression vector) Calculates the Cosine distance between this and another vector expressions.static ExpressionExpression.cosineDistance(Expression vector1, double[] vector2) Creates an expression that calculates the cosine distance between two vectors.static ExpressionExpression.cosineDistance(Expression vector1, Expression vector2) Creates an expression that calculates the cosine distance between two vectors.static ExpressionExpression.cosineDistance(String vectorFieldName, Expression vector) Creates an expression that calculates the cosine distance between two vectors.static AggregateFunctionAggregateFunction.count(Expression expression) Creates an aggregation that counts the number of stage inputs with valid evaluations of the providedexpression.static AggregateFunctionAggregateFunction.countDistinct(Expression expression) Creates an aggregation that counts the number of distinct values of an expression across multiple stage inputs.static OrderingOrdering.descending(Expression expr) static ExpressionExpression.divide(Expression dividend, Expression divisor) Creates an expression that divides two numeric expressions.static ExpressionExpression.divide(Expression dividend, Number divisor) Creates an expression that divides a numeric expression by a constant.static ExpressionExpression.divide(String fieldName, Expression divisor) Creates an expression that divides numeric field by a numeric expression.static ExpressionExpression.documentId(Expression documentPath) Creates an expression that returns the document ID from a path.final ExpressionExpression.dotProduct(Expression vector) Calculates the dot product distance between this and another vector expression.static ExpressionExpression.dotProduct(Expression vector1, double[] vector2) Creates an expression that calculates the dot product of two vectors.static ExpressionExpression.dotProduct(Expression vector1, Expression vector2) Creates an expression that calculates the dot product of two vectors.static ExpressionExpression.dotProduct(String vectorFieldName, Expression vector) Creates an expression that calculates the dot product of two vectors.static BooleanExpressionExpression.endsWith(Expression string, Expression suffix) Creates an expression that checks if a string expression ends with a givensuffix.static BooleanExpressionExpression.endsWith(Expression string, String suffix) Creates an expression that checks if a string expression ends with a givensuffix.static BooleanExpressionExpression.endsWith(String fieldName, Expression suffix) Creates an expression that checks if a string expression ends with a givensuffix.static BooleanExpressionExpression.equal(Expression left, Expression right) Creates an expression that checks if two expressions are equal.static BooleanExpressionExpression.equal(Expression left, Object right) Creates an expression that checks if an expression is equal to a constant value.static BooleanExpressionExpression.equal(String fieldName, Expression right) Creates an expression that checks if a field is equal to an expression.static BooleanExpressionExpression.equalAny(Expression expression, Expression arrayExpression) Creates an expression that checks if anexpression, when evaluated, is equal to any of the elements ofarrayExpression.static BooleanExpressionExpression.equalAny(Expression expression, List<Object> values) Creates an expression that checks if anexpression, when evaluated, is equal to any of the providedvalues.static BooleanExpressionExpression.equalAny(String fieldName, Expression arrayExpression) Creates an expression that checks if a field's value is equal to any of the elements ofarrayExpression.final ExpressionExpression.euclideanDistance(Expression vector) Calculates the Euclidean distance between this and another vector expression.static ExpressionExpression.euclideanDistance(Expression vector1, double[] vector2) Creates an expression that calculates the Euclidean distance between two vectors.static ExpressionExpression.euclideanDistance(Expression vector1, Expression vector2) Creates an expression that calculates the Euclidean distance between two vectors.static ExpressionExpression.euclideanDistance(String vectorFieldName, Expression vector) Creates an expression that calculates the Euclidean distance between two vectors.static BooleanExpressionExpression.exists(Expression value) Creates an expression that checks if a field exists.static ExpressionExpression.exp(Expression numericExpr) Creates an expression that returns Euler's number e raised to the power ofnumericExpr.static ValueFunctionUtils.exprToValue(Expression expr) static AggregateFunctionAggregateFunction.first(Expression expression) Creates an aggregation that finds the first value of an expression across multiple stage inputs.static ExpressionExpression.floor(Expression numericExpr) Creates an expression that returns the largest integer that isn't less thannumericExpr.static BooleanExpressionExpression.greaterThan(Expression left, Expression right) Creates an expression that checks if the first expression is greater than the second expression.static BooleanExpressionExpression.greaterThan(Expression left, Object right) Creates an expression that checks if an expression is greater than a constant value.static BooleanExpressionExpression.greaterThan(String fieldName, Expression right) Creates an expression that checks if a field is greater than an expression.static BooleanExpressionExpression.greaterThanOrEqual(Expression left, Expression right) Creates an expression that checks if the first expression is greater than or equal to the second expression.static BooleanExpressionExpression.greaterThanOrEqual(Expression left, Object right) Creates an expression that checks if an expression is greater than or equal to a constant value.static BooleanExpressionExpression.greaterThanOrEqual(String fieldName, Expression right) Creates an expression that checks if a field is greater than or equal to an expression.static ExpressionExpression.ifAbsent(Expression ifExpr, Expression elseExpr) Creates an expression that returns a default value if an expression evaluates to an absent value.static ExpressionExpression.ifAbsent(Expression ifExpr, Object elseValue) Creates an expression that returns a default value if an expression evaluates to an absent value.static ExpressionExpression.ifAbsent(String ifFieldName, Expression elseExpr) Creates an expression that returns a default value if a field is absent.final ExpressionExpression.ifError(Expression catchExpr) Creates an expression that returns thecatchExprargument if there is an error, else return the result of this expression.static ExpressionExpression.ifError(Expression tryExpr, Expression catchExpr) Creates an expression that returns thecatchExprargument if there is an error, else return the result of thetryExprargument evaluation.static ExpressionExpression.ifError(Expression tryExpr, Object catchValue) Creates an expression that returns thecatchValueargument if there is an error, else return the result of thetryExprargument evaluation.static BooleanExpressionExpression.isAbsent(Expression value) Creates an expression that returns true if a value is absent.static BooleanExpressionExpression.isError(Expression expr) Creates an expression that checks if a given expression produces an error.static BooleanExpressionExpression.isNotNaN(Expression expr) Creates an expression that checks if the results ofexpris NOT 'NaN' (Not a Number).Expression.join(Expression delimiter) Creates an expression that joins the elements of this array expression into a string.static ExpressionExpression.join(Expression arrayExpression, Expression delimiterExpression) Creates an expression that joins the elements of an array into a string.static ExpressionExpression.join(Expression arrayExpression, String delimiter) Creates an expression that joins the elements of an array into a string.static ExpressionExpression.join(String arrayFieldName, Expression delimiterExpression) Creates an expression that joins the elements of an array into a string.static AggregateFunctionAggregateFunction.last(Expression expression) Creates an aggregation that finds the last value of an expression across multiple stage inputs.static ExpressionExpression.length(Expression string) Creates an expression that calculates the length of string, array, map, vector, or Blob.static BooleanExpressionExpression.lessThan(Expression left, Expression right) Creates an expression that checks if the first expression is less than the second expression.static BooleanExpressionExpression.lessThan(Expression left, Object right) Creates an expression that checks if an expression is less than a constant value.static BooleanExpressionExpression.lessThan(String fieldName, Expression right) Creates an expression that checks if a field is less than an expression.static BooleanExpressionExpression.lessThanOrEqual(Expression left, Expression right) Creates an expression that checks if the first expression is less than or equal to the second expression.static BooleanExpressionExpression.lessThanOrEqual(Expression left, Object right) Creates an expression that checks if an expression is less than or equal to a constant value.static BooleanExpressionExpression.lessThanOrEqual(String fieldName, Expression right) Creates an expression that checks if a field is less than or equal to an expression.static BooleanExpressionExpression.like(Expression string, Expression pattern) Creates an expression that performs a case-sensitive wildcard string comparison.static BooleanExpressionExpression.like(Expression string, String pattern) Creates an expression that performs a case-sensitive wildcard string comparison.static BooleanExpressionExpression.like(String fieldName, Expression pattern) Creates an expression that performs a case-sensitive wildcard string comparison against a field.static ExpressionExpression.ln(Expression numericExpr) Creates an expression that returns the natural logarithm (base e) ofnumericExpr.static ExpressionExpression.log(Expression numericExpr, Expression base) Creates an expression that returns the logarithm ofnumericExprwith a givenbase.static ExpressionExpression.log(Expression numericExpr, Number base) Creates an expression that returns the logarithm ofnumericExprwith a givenbase.static ExpressionExpression.log(String numericField, Expression base) Creates an expression that returns the logarithm ofnumericFieldwith a givenbase.static ExpressionExpression.log10(Expression numericExpr) Creates an expression that returns the base 10 logarithm ofnumericExpr.static ExpressionExpression.logicalMaximum(Expression expr, Object... others) Creates an expression that returns the largest value between multiple input expressions or literal values.static ExpressionExpression.logicalMinimum(Expression expr, Object... others) Creates an expression that returns the smallest value between multiple input expressions or literal values.static ExpressionExpression.mapGet(Expression map, Expression key) Accesses a value from a map (object) field using the providedkeyExpression.static ExpressionExpression.mapGet(Expression map, String key) Accesses a value from a map (object) field using the providedkey.static ExpressionExpression.mapGet(String fieldName, Expression key) Accesses a value from a map (object) field using the providedkeyExpression.static ExpressionExpression.mapMerge(Expression firstMap, Expression secondMap) final ExpressionExpression.mapMerge(Expression secondMap, Expression... otherMaps) Creates an expression that merges multiple maps into a single map.static ExpressionExpression.mapMerge(Expression firstMap, Expression secondMap, Expression... otherMaps) Creates an expression that merges multiple maps into a single map.static ExpressionExpression.mapMerge(String firstMapFieldName, Expression secondMap) static ExpressionExpression.mapMerge(String firstMapFieldName, Expression secondMap, Expression... otherMaps) Creates an expression that merges multiple maps into a single map.final ExpressionExpression.mapRemove(Expression key) Creates an expression that removes a key from this map expression.static ExpressionExpression.mapRemove(Expression mapExpr, Expression key) Creates an expression that removes a key from a map.static ExpressionExpression.mapRemove(Expression mapExpr, String key) Creates an expression that removes a key from a map.static ExpressionExpression.mapRemove(String mapField, Expression key) Creates an expression that removes a key from a map.static AggregateFunctionAggregateFunction.maximum(Expression expression) Creates an aggregation that finds the maximum value of an expression across multiple stage inputs.static AggregateFunctionAggregateFunction.minimum(Expression expression) Creates an aggregation that finds the minimum value of an expression across multiple stage inputs.static ExpressionExpression.mod(Expression dividend, Expression divisor) Creates an expression that calculates the modulo (remainder) of dividing two numeric expressions.static ExpressionExpression.mod(Expression dividend, Number divisor) Creates an expression that calculates the modulo (remainder) of dividing a numeric expression by a constant.static ExpressionExpression.mod(String fieldName, Expression divisor) Creates an expression that calculates the modulo (remainder) of dividing a numeric field by a constant.static ExpressionExpression.multiply(Expression first, Expression second) Creates an expression that multiplies numeric expressions.static ExpressionExpression.multiply(Expression first, Number second) Creates an expression that multiplies numeric expressions with a constant.static ExpressionExpression.multiply(String fieldName, Expression second) Creates an expression that multiplies a numeric field with a numeric expression.static BooleanExpressionExpression.notEqual(Expression left, Expression right) Creates an expression that checks if two expressions are not equal.static BooleanExpressionExpression.notEqual(Expression left, Object right) Creates an expression that checks if an expression is not equal to a constant value.static BooleanExpressionExpression.notEqual(String fieldName, Expression right) Creates an expression that checks if a field is not equal to an expression.static BooleanExpressionExpression.notEqualAny(Expression expression, Expression arrayExpression) Creates an expression that checks if anexpression, when evaluated, is not equal to all the elements ofarrayExpression.static BooleanExpressionExpression.notEqualAny(Expression expression, List<Object> values) Creates an expression that checks if anexpression, when evaluated, is not equal to all the providedvalues.static BooleanExpressionExpression.notEqualAny(String fieldName, Expression arrayExpression) Creates an expression that checks if a field's value is not equal to all of the elements ofarrayExpression.final ExpressionExpression.pow(Expression exponent) Creates an expression that returns this numeric expression raised to the power of theexponent.static ExpressionExpression.pow(Expression numericExpr, Expression exponent) Creates an expression that returns thenumericExprraised to the power of theexponent.static ExpressionExpression.pow(Expression numericExpr, Number exponent) Creates an expression that returns thenumericExprraised to the power of theexponent.static ExpressionExpression.pow(String numericField, Expression exponent) Creates an expression that returns thenumericFieldraised to the power of theexponent.static AggregateFunctionAggregateFunction.rawAggregate(String name, Expression... expr) Creates a raw aggregation function.static ExpressionExpression.rawExpression(String name, Expression... expr) Creates a generic function expression that is not yet implemented.static BooleanExpressionBooleanExpression.rawFunction(String name, Expression... params) Creates a 'raw' boolean function expression.static BooleanExpressionExpression.regexContains(Expression string, Expression pattern) Creates an expression that checks if a string expression contains a specified regular expression as a substring.static BooleanExpressionExpression.regexContains(Expression string, String pattern) Creates an expression that checks if a string expression contains a specified regular expression as a substring.static BooleanExpressionExpression.regexContains(String fieldName, Expression pattern) Creates an expression that checks if a string field contains a specified regular expression as a substring.static ExpressionExpression.regexFind(Expression string, Expression pattern) Creates an expression that returns the first substring of a string expression that matches a specified regular expression.static ExpressionExpression.regexFind(Expression string, String pattern) Creates an expression that returns the first substring of a string expression that matches a specified regular expression.static ExpressionExpression.regexFind(String fieldName, Expression pattern) Creates an expression that returns the first substring of a string field that matches a specified regular expression.static ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 BooleanExpressionExpression.regexMatch(Expression string, Expression pattern) Creates an expression that checks if a string field matches a specified regular expression.static BooleanExpressionExpression.regexMatch(Expression string, String pattern) Creates an expression that checks if a string field matches a specified regular expression.static BooleanExpressionExpression.regexMatch(String fieldName, Expression pattern) Creates an expression that checks if a string field matches a specified regular expression.static ExpressionExpression.reverse(Expression expr) Creates an expression that reverses a string, blob, or array.static ExpressionExpression.round(Expression numericExpr) Creates an expression that roundsnumericExprto nearest integer.final ExpressionExpression.roundToPrecision(Expression decimalPlace) Creates an expression that rounds off this numeric expression todecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.roundToPrecision(Expression numericExpr, int decimalPlace) Creates an expression that rounds offnumericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.roundToPrecision(Expression numericExpr, Expression decimalPlace) Creates an expression that rounds offnumericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.roundToPrecision(String numericField, Expression decimalPlace) Creates an expression that rounds offnumericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative.Expression.split(Expression delimiter) Creates an expression that splits this string or blob expression by a delimiter.static ExpressionExpression.split(Expression value, Expression delimiter) Creates an expression that splits a string or blob by a delimiter.static ExpressionExpression.split(Expression value, String delimiter) Creates an expression that splits a string or blob by a delimiter.static ExpressionExpression.split(String fieldName, Expression delimiter) Creates an expression that splits a string or blob by a delimiter.static ExpressionExpression.sqrt(Expression numericExpr) Creates an expression that returns the square root ofnumericExpr.static BooleanExpressionExpression.startsWith(Expression string, Expression prefix) Creates an expression that checks if a string expression starts with a givenprefix.static BooleanExpressionExpression.startsWith(Expression string, String prefix) Creates an expression that checks if a string expression starts with a givenprefix.static BooleanExpressionExpression.startsWith(String fieldName, Expression prefix) Creates an expression that checks if a string expression starts with a givenprefix.final ExpressionExpression.stringConcat(Expression... others) Creates an expression that concatenates string expressions together.static ExpressionExpression.stringConcat(Expression firstString, Object... otherStrings) Creates an expression that concatenates string expressions together.static BooleanExpressionExpression.stringContains(Expression string, Expression substring) Creates an expression that checks if a string expression contains a specified substring.static BooleanExpressionExpression.stringContains(Expression string, String substring) Creates an expression that checks if a string expression contains a specified substring.static BooleanExpressionExpression.stringContains(String fieldName, Expression substring) Creates an expression that checks if a string field contains a specified substring.static ExpressionExpression.substring(Expression string, Expression index, Expression length) Creates an expression that returns a substring of the given string.static ExpressionExpression.subtract(Expression minuend, Expression subtrahend) Creates an expression that subtracts two expressions.static ExpressionExpression.subtract(Expression minuend, Number subtrahend) Creates an expression that subtracts a constant value from a numeric expression.static ExpressionExpression.subtract(String fieldName, Expression subtrahend) Creates an expression that subtracts a numeric expressions from numeric field.static AggregateFunctionAggregateFunction.sum(Expression expression) Creates an aggregation that calculates the sum of values from an expression across multiple stage inputs.final ExpressionExpression.timestampAdd(Expression unit, Expression amount) Creates an expression that adds a specified amount of time to this timestamp expression.static ExpressionExpression.timestampAdd(Expression timestamp, Expression unit, Expression amount) Creates an expression that adds a specified amount of time to a timestamp.static ExpressionExpression.timestampAdd(Expression timestamp, String unit, long amount) Creates an expression that adds a specified amount of time to a timestamp.static ExpressionExpression.timestampAdd(String fieldName, Expression unit, Expression amount) Creates an expression that adds a specified amount of time to a timestamp.final ExpressionExpression.timestampSubtract(Expression unit, Expression amount) Creates an expression that subtracts a specified amount of time to this timestamp expression.static ExpressionExpression.timestampSubtract(Expression timestamp, Expression unit, Expression amount) Creates an expression that subtracts a specified amount of time to a timestamp.static ExpressionExpression.timestampSubtract(Expression timestamp, String unit, long amount) Creates an expression that subtracts a specified amount of time to a timestamp.static ExpressionExpression.timestampSubtract(String fieldName, Expression unit, Expression amount) Creates an expression that subtracts a specified amount of time to a timestamp.static ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.timestampTruncate(Expression granularity) Creates an expression that truncates this timestamp expression to a specified granularity.static ExpressionExpression.timestampTruncate(Expression timestamp, Expression granularity) Creates an expression that truncates a timestamp to a specified granularity.static ExpressionExpression.timestampTruncate(Expression timestamp, Expression granularity, String timezone) Creates an expression that truncates a timestamp to a specified granularity in a given timezone.static ExpressionExpression.timestampTruncate(Expression timestamp, String granularity) Creates an expression that truncates a timestamp to a specified granularity.static ExpressionExpression.timestampTruncate(Expression timestamp, String granularity, String timezone) Creates an expression that truncates a timestamp to a specified granularity in a given timezone.static ExpressionExpression.timestampTruncate(String fieldName, Expression granularity) Creates an expression that truncates a timestamp to a specified granularity.static ExpressionExpression.timestampTruncate(String fieldName, Expression granularity, String timezone) Creates an expression that truncates a timestamp to a specified granularity in a given timezone.static ExpressionExpression.toLower(Expression string) Creates an expression that converts a string expression to lowercase.static ExpressionExpression.toUpper(Expression string) Creates an expression that converts a string expression to uppercase.static ExpressionExpression.trim(Expression string) Creates an expression that removes leading and trailing whitespace from a string expression.Expression.trimValue(Expression characters) Creates an expression that removes specified characters from the beginning and end of this string or blob expression.static ExpressionExpression.trimValue(Expression value, Expression characters) Creates an expression that removes specified characters from the beginning and end of a string or blob.static ExpressionExpression.trimValue(Expression value, String characters) Creates an expression that removes specified characters from the beginning and end of a string or blob.static ExpressionExpression.trimValue(String fieldName, Expression characters) Creates an expression that removes specified characters from the beginning and end of a string or blob.static ExpressionExpression.trunc(Expression numericExpr) Creates an expression that truncatesnumericExprto an integer.final ExpressionExpression.truncToPrecision(Expression decimalPlace) Creates an expression that truncates this numeric expression todecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.truncToPrecision(Expression numericExpr, int decimalPlace) Creates an expression that truncatesnumericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.truncToPrecision(Expression numericExpr, Expression decimalPlace) Creates an expression that truncatesnumericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.truncToPrecision(String numericField, Expression decimalPlace) Creates an expression that truncatesnumericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative.static ExpressionExpression.type(Expression expr) Creates an expression that returns a string indicating the type of the value this expression evaluates to.static ExpressionExpression.unixMicrosToTimestamp(Expression expr) Creates an expression that converts a Unix timestamp in microseconds to a Firestore timestamp.static ExpressionExpression.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 ExpressionExpression.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 ExpressionExpression.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 ExpressionModifierConstructorDescriptionFindNearest(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 ExpressionModifierConstructorDescriptionAddFields(Map<String, Expression> fields) Distinct(Map<String, Expression> groups) Select(Map<String, Expression> projections)