Class FunctionExpression (3.41.0)

3.41.0 (latest) 3.38.0 3.37.0 3.36.0 3.35.1 3.33.4 3.32.2 3.31.9 3.30.11 3.28.0 3.27.2 3.26.5 3.25.1 3.24.3 3.22.0 3.21.4 3.20.0 3.17.0 3.16.3 3.15.7 3.14.4 3.13.2 3.12.1 3.11.0 3.10.0 3.9.6 3.8.2 3.7.10 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.1.0 3.0.21

public class FunctionExpression extends Expression

Inheritance

Object > Expression > FunctionExpression

Inherited Members

Expression.abs()

Expression.abs(Expression)

Expression.abs(String)

Expression.add(Expression,Expression)

Expression.add(Expression,Number)

Expression.add(Object)

Expression.add(String,Expression)

Expression.add(String,Number)

Expression.and(BooleanExpression,BooleanExpression)

Expression.array(Object)

Expression.array(List<Object>)

Expression.arrayAgg()

Expression.arrayAggDistinct()

Expression.arrayConcat(Expression,Object)

Expression.arrayConcat(Expression)

Expression.arrayConcat(String,Object)

Expression.arrayContains(Expression,Expression)

Expression.arrayContains(Expression,Object)

Expression.arrayContains(Object)

Expression.arrayContains(String,Expression)

Expression.arrayContains(String,Object)

Expression.arrayContainsAll(Expression)

Expression.arrayContainsAll(Expression,Expression)

Expression.arrayContainsAll(Expression,List<Object>)

Expression.arrayContainsAll(String,Expression)

Expression.arrayContainsAll(String,List<Object>)

Expression.arrayContainsAll(List<Object>)

Expression.arrayContainsAny(Expression)

Expression.arrayContainsAny(Expression,Expression)

Expression.arrayContainsAny(Expression,List<Object>)

Expression.arrayContainsAny(String,Expression)

Expression.arrayContainsAny(String,List<Object>)

Expression.arrayContainsAny(List<Object>)

Expression.arrayFilter(Expression,String,BooleanExpression)

Expression.arrayFilter(String,BooleanExpression)

Expression.arrayFilter(String,String,BooleanExpression)

Expression.arrayFirst()

Expression.arrayFirst(Expression)

Expression.arrayFirst(String)

Expression.arrayFirstN(Expression)

Expression.arrayFirstN(Expression,Expression)

Expression.arrayFirstN(Expression,int)

Expression.arrayFirstN(int)

Expression.arrayFirstN(String,Expression)

Expression.arrayFirstN(String,int)

Expression.arrayGet(Expression)

Expression.arrayGet(Expression,Expression)

Expression.arrayGet(Expression,int)

Expression.arrayGet(int)

Expression.arrayGet(String,Expression)

Expression.arrayGet(String,int)

Expression.arrayIndexOf(Expression)

Expression.arrayIndexOf(Expression,Expression)

Expression.arrayIndexOf(Expression,Object)

Expression.arrayIndexOf(Object)

Expression.arrayIndexOf(String,Expression)

Expression.arrayIndexOf(String,Object)

Expression.arrayIndexOfAll(Expression)

Expression.arrayIndexOfAll(Expression,Expression)

Expression.arrayIndexOfAll(Expression,Object)

Expression.arrayIndexOfAll(Object)

Expression.arrayIndexOfAll(String,Expression)

Expression.arrayIndexOfAll(String,Object)

Expression.arrayLast()

Expression.arrayLast(Expression)

Expression.arrayLast(String)

Expression.arrayLastIndexOf(Expression)

Expression.arrayLastIndexOf(Expression,Expression)

Expression.arrayLastIndexOf(Expression,Object)

Expression.arrayLastIndexOf(Object)

Expression.arrayLastIndexOf(String,Expression)

Expression.arrayLastIndexOf(String,Object)

Expression.arrayLastN(Expression)

Expression.arrayLastN(Expression,Expression)

Expression.arrayLastN(Expression,int)

Expression.arrayLastN(int)

Expression.arrayLastN(String,Expression)

Expression.arrayLastN(String,int)

Expression.arrayLength()

Expression.arrayLength(Expression)

Expression.arrayLength(String)

Expression.arrayMaximum()

Expression.arrayMaximum(Expression)

Expression.arrayMaximum(String)

Expression.arrayMaximumN(Expression)

Expression.arrayMaximumN(Expression,Expression)

Expression.arrayMaximumN(Expression,int)

Expression.arrayMaximumN(int)

Expression.arrayMaximumN(String,Expression)

Expression.arrayMaximumN(String,int)

Expression.arrayMinimum()

Expression.arrayMinimum(Expression)

Expression.arrayMinimum(String)

Expression.arrayMinimumN(Expression)

Expression.arrayMinimumN(Expression,Expression)

Expression.arrayMinimumN(Expression,int)

Expression.arrayMinimumN(int)

Expression.arrayMinimumN(String,Expression)

Expression.arrayMinimumN(String,int)

Expression.arrayReverse()

Expression.arrayReverse(Expression)

Expression.arrayReverse(String)

Expression.arraySlice(Expression,Expression)

Expression.arraySlice(Expression,Expression,Expression)

Expression.arraySlice(Expression,int,int)

Expression.arraySlice(int,int)

Expression.arraySlice(String,Expression,Expression)

Expression.arraySlice(String,int,int)

Expression.arraySliceToEnd(Expression)

Expression.arraySliceToEnd(Expression,Expression)

Expression.arraySliceToEnd(Expression,int)

Expression.arraySliceToEnd(int)

Expression.arraySliceToEnd(String,Expression)

Expression.arraySliceToEnd(String,int)

Expression.arraySum()

Expression.arraySum(Expression)

Expression.arraySum(String)

Expression.arrayTransform(Expression,String,Expression)

Expression.arrayTransform(String,Expression)

Expression.arrayTransform(String,String,Expression)

Expression.arrayTransformWithIndex(Expression,String,String,Expression)

Expression.arrayTransformWithIndex(String,String,Expression)

Expression.arrayTransformWithIndex(String,String,String,Expression)

Expression.as(String)

Expression.ascending()

Expression.average()

Expression.between(Expression,Expression)

Expression.between(Object,Object)

Expression.byteLength()

Expression.byteLength(Expression)

Expression.byteLength(String)

Expression.ceil()

Expression.ceil(Expression)

Expression.ceil(String)

Expression.charLength()

Expression.charLength(Expression)

Expression.charLength(String)

Expression.coalesce(Expression,Object,Object)

Expression.coalesce(Object,Object)

Expression.coalesce(String,Object,Object)

Expression.collectionId()

Expression.collectionId(Expression)

Expression.collectionId(String)

Expression.concat(Expression,Object)

Expression.concat(Object)

Expression.concat(String,Object)

Expression.conditional(BooleanExpression,Expression,Expression)

Expression.conditional(BooleanExpression,Object,Object)

Expression.constant(byte[])

Expression.constant(Timestamp)

Expression.constant(Blob)

Expression.constant(DocumentReference)

Expression.constant(GeoPoint)

Expression.constant(VectorValue)

Expression.constant(Boolean)

Expression.constant(Number)

Expression.constant(String)

Expression.constant(Date)

Expression.cosineDistance(Expression)

Expression.cosineDistance(Expression,Expression)

Expression.cosineDistance(Expression,double[])

Expression.cosineDistance(double[])

Expression.cosineDistance(String,Expression)

Expression.cosineDistance(String,double[])

Expression.count()

Expression.countDistinct()

Expression.currentDocument()

Expression.currentTimestamp()

Expression.descending()

Expression.divide(Expression,Expression)

Expression.divide(Expression,Number)

Expression.divide(Object)

Expression.divide(String,Expression)

Expression.divide(String,Number)

Expression.documentId()

Expression.documentId(DocumentReference)

Expression.documentId(Expression)

Expression.documentId(String)

Expression.documentMatches(String)

Expression.dotProduct(Expression)

Expression.dotProduct(Expression,Expression)

Expression.dotProduct(Expression,double[])

Expression.dotProduct(double[])

Expression.dotProduct(String,Expression)

Expression.dotProduct(String,double[])

Expression.endsWith(Expression,Expression)

Expression.endsWith(Expression,String)

Expression.endsWith(Object)

Expression.endsWith(String,Expression)

Expression.endsWith(String,String)

Expression.equal(Expression,Expression)

Expression.equal(Expression,Object)

Expression.equal(Object)

Expression.equal(String,Expression)

Expression.equal(String,Object)

Expression.equalAny(Expression,Expression)

Expression.equalAny(Expression,List<Object>)

Expression.equalAny(String,Expression)

Expression.equalAny(String,List<Object>)

Expression.equalAny(List<Object>)

Expression.euclideanDistance(Expression)

Expression.euclideanDistance(Expression,Expression)

Expression.euclideanDistance(Expression,double[])

Expression.euclideanDistance(double[])

Expression.euclideanDistance(String,Expression)

Expression.euclideanDistance(String,double[])

Expression.exists()

Expression.exists(Expression)

Expression.exists(String)

Expression.exp()

Expression.exp(Expression)

Expression.exp(String)

Expression.field(FieldPath)

Expression.field(String)

Expression.first()

Expression.floor()

Expression.floor(Expression)

Expression.floor(String)

Expression.geoDistance(Field,GeoPoint)

Expression.geoDistance(String,GeoPoint)

Expression.getField(Expression)

Expression.getField(Expression,Expression)

Expression.getField(Expression,String)

Expression.getField(String)

Expression.getField(String,Expression)

Expression.getField(String,String)

Expression.greaterThan(Expression,Expression)

Expression.greaterThan(Expression,Object)

Expression.greaterThan(Object)

Expression.greaterThan(String,Expression)

Expression.greaterThan(String,Object)

Expression.greaterThanOrEqual(Expression,Expression)

Expression.greaterThanOrEqual(Expression,Object)

Expression.greaterThanOrEqual(Object)

Expression.greaterThanOrEqual(String,Expression)

Expression.greaterThanOrEqual(String,Object)

Expression.ifAbsent(Expression,Expression)

Expression.ifAbsent(Expression,Object)

Expression.ifAbsent(Object)

Expression.ifAbsent(String,Expression)

Expression.ifAbsent(String,Object)

Expression.ifError(BooleanExpression,BooleanExpression)

Expression.ifError(Expression)

Expression.ifError(Expression,Expression)

Expression.ifError(Expression,Object)

Expression.ifError(Object)

Expression.ifNull(Expression,Expression)

Expression.ifNull(Expression,Object)

Expression.ifNull(Object)

Expression.ifNull(String,Expression)

Expression.ifNull(String,Object)

Expression.isAbsent()

Expression.isAbsent(Expression)

Expression.isAbsent(String)

Expression.isError()

Expression.isError(Expression)

Expression.isNaN()

Expression.isNotNaN()

Expression.isNotNaN(Expression)

Expression.isNotNaN(String)

Expression.isNotNull()

Expression.isNull()

Expression.isType(Expression,String)

Expression.isType(String)

Expression.isType(String,String)

Expression.join(Expression)

Expression.join(Expression,Expression)

Expression.join(Expression,String)

Expression.join(String)

Expression.join(String,Expression)

Expression.join(String,String)

Expression.last()

Expression.length()

Expression.length(Expression)

Expression.length(String)

Expression.lessThan(Expression,Expression)

Expression.lessThan(Expression,Object)

Expression.lessThan(Object)

Expression.lessThan(String,Expression)

Expression.lessThan(String,Object)

Expression.lessThanOrEqual(Expression,Expression)

Expression.lessThanOrEqual(Expression,Object)

Expression.lessThanOrEqual(Object)

Expression.lessThanOrEqual(String,Expression)

Expression.lessThanOrEqual(String,Object)

Expression.like(Expression,Expression)

Expression.like(Expression,String)

Expression.like(Object)

Expression.like(String,Expression)

Expression.like(String,String)

Expression.ln()

Expression.ln(Expression)

Expression.ln(String)

Expression.log(Expression,Expression)

Expression.log(Expression,Number)

Expression.log(String,Expression)

Expression.log(String,Number)

Expression.log10()

Expression.log10(Expression)

Expression.log10(String)

Expression.logicalMaximum(Expression,Object)

Expression.logicalMaximum(Object)

Expression.logicalMaximum(String,Object)

Expression.logicalMinimum(Expression,Object)

Expression.logicalMinimum(Object)

Expression.logicalMinimum(String,Object)

Expression.ltrim()

Expression.ltrim(Expression)

Expression.ltrim(String)

Expression.ltrimValue(Expression)

Expression.ltrimValue(Expression,Expression)

Expression.ltrimValue(Expression,String)

Expression.ltrimValue(String)

Expression.ltrimValue(String,Expression)

Expression.ltrimValue(String,String)

Expression.map(Map<String,Object>)

Expression.mapEntries()

Expression.mapEntries(Expression)

Expression.mapEntries(String)

Expression.mapGet(Expression,Expression)

Expression.mapGet(Expression,String)

Expression.mapGet(Object)

Expression.mapGet(String,Expression)

Expression.mapGet(String,String)

Expression.mapKeys()

Expression.mapKeys(Expression)

Expression.mapKeys(String)

Expression.mapMerge(Expression,Expression)

Expression.mapMerge(Expression,Expression,Expression)

Expression.mapMerge(Expression,Expression)

Expression.mapMerge(String,Expression)

Expression.mapMerge(String,Expression,Expression)

Expression.mapRemove(Expression)

Expression.mapRemove(Expression,Expression)

Expression.mapRemove(Expression,String)

Expression.mapRemove(String)

Expression.mapRemove(String,Expression)

Expression.mapRemove(String,String)

Expression.mapSet(Expression,Expression,Expression,Expression)

Expression.mapSet(Expression,Expression,Expression)

Expression.mapSet(Expression,String,Object,Object)

Expression.mapSet(String,Expression,Expression,Expression)

Expression.mapSet(String,Object,Object)

Expression.mapSet(String,String,Object,Object)

Expression.mapValues()

Expression.mapValues(Expression)

Expression.mapValues(String)

Expression.maximum()

Expression.minimum()

Expression.mod(Expression,Expression)

Expression.mod(Expression,Number)

Expression.mod(Object)

Expression.mod(String,Expression)

Expression.mod(String,Number)

Expression.multiply(Expression,Expression)

Expression.multiply(Expression,Number)

Expression.multiply(Object)

Expression.multiply(String,Expression)

Expression.multiply(String,Number)

Expression.nor(BooleanExpression,BooleanExpression)

Expression.not(BooleanExpression)

Expression.notEqual(Expression,Expression)

Expression.notEqual(Expression,Object)

Expression.notEqual(Object)

Expression.notEqual(String,Expression)

Expression.notEqual(String,Object)

Expression.notEqualAny(Expression,Expression)

Expression.notEqualAny(Expression,List<Object>)

Expression.notEqualAny(String,Expression)

Expression.notEqualAny(String,List<Object>)

Expression.notEqualAny(List<Object>)

Expression.nullValue()

Expression.or(BooleanExpression,BooleanExpression)

Expression.parent()

Expression.parent(DocumentReference)

Expression.parent(Expression)

Expression.parent(String)

Expression.pow(Expression)

Expression.pow(Expression,Expression)

Expression.pow(Expression,Number)

Expression.pow(Number)

Expression.pow(String,Expression)

Expression.pow(String,Number)

Expression.rand()

Expression.rawExpression(String,Expression)

Expression.regexContains(Expression,Expression)

Expression.regexContains(Expression,String)

Expression.regexContains(Object)

Expression.regexContains(String,Expression)

Expression.regexContains(String,String)

Expression.regexFind(Expression,Expression)

Expression.regexFind(Expression,String)

Expression.regexFind(Object)

Expression.regexFind(String,Expression)

Expression.regexFind(String,String)

Expression.regexFindAll(Expression,Expression)

Expression.regexFindAll(Expression,String)

Expression.regexFindAll(Object)

Expression.regexFindAll(String,Expression)

Expression.regexFindAll(String,String)

Expression.regexMatch(Expression,Expression)

Expression.regexMatch(Expression,String)

Expression.regexMatch(Object)

Expression.regexMatch(String,Expression)

Expression.regexMatch(String,String)

Expression.reverse()

Expression.reverse(Expression)

Expression.reverse(String)

Expression.round()

Expression.round(Expression)

Expression.round(String)

Expression.roundToPrecision(Expression)

Expression.roundToPrecision(Expression,Expression)

Expression.roundToPrecision(Expression,int)

Expression.roundToPrecision(int)

Expression.roundToPrecision(String,Expression)

Expression.roundToPrecision(String,int)

Expression.rtrim()

Expression.rtrim(Expression)

Expression.rtrim(String)

Expression.rtrimValue(Expression)

Expression.rtrimValue(Expression,Expression)

Expression.rtrimValue(Expression,String)

Expression.rtrimValue(String)

Expression.rtrimValue(String,Expression)

Expression.rtrimValue(String,String)

Expression.score()

Expression.split(Expression)

Expression.split(Expression,Expression)

Expression.split(Expression,String)

Expression.split(String)

Expression.split(String,Expression)

Expression.split(String,String)

Expression.sqrt()

Expression.sqrt(Expression)

Expression.sqrt(String)

Expression.startsWith(Expression,Expression)

Expression.startsWith(Expression,String)

Expression.startsWith(Object)

Expression.startsWith(String,Expression)

Expression.startsWith(String,String)

Expression.stringConcat(Expression,Object)

Expression.stringConcat(Expression)

Expression.stringConcat(String,Object)

Expression.stringConcat(String)

Expression.stringContains(Expression,Expression)

Expression.stringContains(Expression,String)

Expression.stringContains(Object)

Expression.stringContains(String,Expression)

Expression.stringContains(String,String)

Expression.stringIndexOf(Expression)

Expression.stringIndexOf(Expression,Expression)

Expression.stringIndexOf(Expression,String)

Expression.stringIndexOf(String)

Expression.stringIndexOf(String,Expression)

Expression.stringIndexOf(String,String)

Expression.stringRepeat(Expression)

Expression.stringRepeat(Expression,Expression)

Expression.stringRepeat(Expression,Number)

Expression.stringRepeat(Number)

Expression.stringRepeat(String,Expression)

Expression.stringRepeat(String,Number)

Expression.stringReplaceAll(Expression,Expression)

Expression.stringReplaceAll(Expression,Expression,Expression)

Expression.stringReplaceAll(Expression,String,String)

Expression.stringReplaceAll(String,Expression,Expression)

Expression.stringReplaceAll(String,String)

Expression.stringReplaceAll(String,String,String)

Expression.stringReplaceOne(Expression,Expression)

Expression.stringReplaceOne(Expression,Expression,Expression)

Expression.stringReplaceOne(Expression,String,String)

Expression.stringReplaceOne(String,Expression,Expression)

Expression.stringReplaceOne(String,String)

Expression.stringReplaceOne(String,String,String)

Expression.substring(Expression,Expression,Expression)

Expression.substring(Object,Object)

Expression.substring(String,int,int)

Expression.subtract(Expression,Expression)

Expression.subtract(Expression,Number)

Expression.subtract(Object)

Expression.subtract(String,Expression)

Expression.subtract(String,Number)

Expression.sum()

Expression.switchOn(BooleanExpression,Expression,Object)

Expression.timestampAdd(Expression,Expression)

Expression.timestampAdd(Expression,Expression,Expression)

Expression.timestampAdd(Expression,String,long)

Expression.timestampAdd(String,Expression,Expression)

Expression.timestampAdd(String,String,long)

Expression.timestampAdd(String,long)

Expression.timestampDiff(Expression,Expression)

Expression.timestampDiff(Expression,Expression,Expression)

Expression.timestampDiff(Expression,Expression,String)

Expression.timestampDiff(Expression,String)

Expression.timestampDiff(Expression,String,String)

Expression.timestampDiff(String,Expression,String)

Expression.timestampDiff(String,String)

Expression.timestampDiff(String,String,String)

Expression.timestampExtract(Expression)

Expression.timestampExtract(Expression,Expression)

Expression.timestampExtract(Expression,String)

Expression.timestampExtract(String)

Expression.timestampExtract(String,Expression)

Expression.timestampExtract(String,String)

Expression.timestampExtractWithTimezone(Expression,Expression)

Expression.timestampExtractWithTimezone(Expression,Expression,Expression)

Expression.timestampExtractWithTimezone(Expression,Expression,String)

Expression.timestampExtractWithTimezone(Expression,String)

Expression.timestampExtractWithTimezone(Expression,String,Expression)

Expression.timestampExtractWithTimezone(Expression,String,String)

Expression.timestampExtractWithTimezone(String,Expression)

Expression.timestampExtractWithTimezone(String,Expression,Expression)

Expression.timestampExtractWithTimezone(String,Expression,String)

Expression.timestampExtractWithTimezone(String,String)

Expression.timestampExtractWithTimezone(String,String,Expression)

Expression.timestampExtractWithTimezone(String,String,String)

Expression.timestampSubtract(Expression,Expression)

Expression.timestampSubtract(Expression,Expression,Expression)

Expression.timestampSubtract(Expression,String,long)

Expression.timestampSubtract(String,Expression,Expression)

Expression.timestampSubtract(String,String,long)

Expression.timestampSubtract(String,long)

Expression.timestampToUnixMicros()

Expression.timestampToUnixMicros(Expression)

Expression.timestampToUnixMicros(String)

Expression.timestampToUnixMillis()

Expression.timestampToUnixMillis(Expression)

Expression.timestampToUnixMillis(String)

Expression.timestampToUnixSeconds()

Expression.timestampToUnixSeconds(Expression)

Expression.timestampToUnixSeconds(String)

Expression.timestampTruncate(Expression)

Expression.timestampTruncate(Expression,Expression)

Expression.timestampTruncate(Expression,String)

Expression.timestampTruncate(String)

Expression.timestampTruncate(String,Expression)

Expression.timestampTruncate(String,String)

Expression.timestampTruncateWithTimezone(Expression,Expression)

Expression.timestampTruncateWithTimezone(Expression,Expression,Expression)

Expression.timestampTruncateWithTimezone(Expression,Expression,String)

Expression.timestampTruncateWithTimezone(Expression,String)

Expression.timestampTruncateWithTimezone(Expression,String,Expression)

Expression.timestampTruncateWithTimezone(Expression,String,String)

Expression.timestampTruncateWithTimezone(String,Expression)

Expression.timestampTruncateWithTimezone(String,Expression,Expression)

Expression.timestampTruncateWithTimezone(String,Expression,String)

Expression.timestampTruncateWithTimezone(String,String)

Expression.timestampTruncateWithTimezone(String,String,Expression)

Expression.timestampTruncateWithTimezone(String,String,String)

Expression.toLower()

Expression.toLower(Expression)

Expression.toLower(String)

Expression.toUpper()

Expression.toUpper(Expression)

Expression.toUpper(String)

Expression.trim()

Expression.trim(Expression)

Expression.trim(String)

Expression.trimValue(Expression)

Expression.trimValue(Expression,Expression)

Expression.trimValue(Expression,String)

Expression.trimValue(String)

Expression.trimValue(String,Expression)

Expression.trimValue(String,String)

Expression.trunc()

Expression.trunc(Expression)

Expression.trunc(String)

Expression.truncToPrecision(Expression)

Expression.truncToPrecision(Expression,Expression)

Expression.truncToPrecision(Expression,int)

Expression.truncToPrecision(int)

Expression.truncToPrecision(String,Expression)

Expression.truncToPrecision(String,int)

Expression.type()

Expression.type(Expression)

Expression.type(String)

Expression.unixMicrosToTimestamp()

Expression.unixMicrosToTimestamp(Expression)

Expression.unixMicrosToTimestamp(String)

Expression.unixMillisToTimestamp()

Expression.unixMillisToTimestamp(Expression)

Expression.unixMillisToTimestamp(String)

Expression.unixSecondsToTimestamp()

Expression.unixSecondsToTimestamp(Expression)

Expression.unixSecondsToTimestamp(String)

Expression.variable(String)

Expression.vectorLength()

Expression.vectorLength(Expression)

Expression.vectorLength(String)

Expression.xor(BooleanExpression,BooleanExpression)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

FunctionExpression(String name, List<? extends Expression> params)

public FunctionExpression(String name, List<? extends Expression> params)

Parameters
Name	Description
name	String
params	List<? extends com.google.cloud.firestore.pipeline.expressions.Expression>

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
o	Object

Returns
Type	Description
boolean

Overrides

Object.equals(Object)

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

Object.hashCode()