Class BooleanExpression (3.35.1)

Version latest

• 3.35.1 (latest)
• 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

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public abstract class BooleanExpression extends Expression

Inheritance

Object > Expression > BooleanExpression

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.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.arrayGet(Expression)

Expression.arrayGet(Expression,Expression)

Expression.arrayGet(Expression,int)

Expression.arrayGet(int)

Expression.arrayGet(String,Expression)

Expression.arrayGet(String,int)

Expression.arrayLength()

Expression.arrayLength(Expression)

Expression.arrayLength(String)

Expression.arrayReverse()

Expression.arrayReverse(Expression)

Expression.arrayReverse(String)

Expression.arraySum()

Expression.arraySum(Expression)

Expression.arraySum(String)

Expression.as(String)

Expression.ascending()

Expression.average()

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.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.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.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.floor()

Expression.floor(Expression)

Expression.floor(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.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.join(Expression)

Expression.join(Expression,Expression)

Expression.join(Expression,String)

Expression.join(String)

Expression.join(String,Expression)

Expression.join(String,String)

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.map(Map<String,Object>)

Expression.mapGet(Expression,Expression)

Expression.mapGet(Expression,String)

Expression.mapGet(Object)

Expression.mapGet(String,Expression)

Expression.mapGet(String,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.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.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.pow(Expression)

Expression.pow(Expression,Expression)

Expression.pow(Expression,Number)

Expression.pow(Number)

Expression.pow(String,Expression)

Expression.pow(String,Number)

Expression.rawExpression(String,Expression)

Expression.regexContains(Expression,Expression)

Expression.regexContains(Expression,String)

Expression.regexContains(Object)

Expression.regexContains(String,Expression)

Expression.regexContains(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.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.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.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.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,Expression,String)

Expression.timestampTruncate(Expression,String)

Expression.timestampTruncate(Expression,String,String)

Expression.timestampTruncate(String)

Expression.timestampTruncate(String,Expression)

Expression.timestampTruncate(String,Expression,String)

Expression.timestampTruncate(String,String)

Expression.timestampTruncate(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.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.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)

Static Methods

rawFunction(String name, Expression[] params)

public static BooleanExpression rawFunction(String name, Expression[] params)

Creates a 'raw' boolean function expression. This is useful if the expression is available in the backend, but not yet in the current version of the SDK yet.

Parameters
Name	Description
name	String The name of the raw function.
params	Expression[] The expressions to be passed as arguments to the function.

Returns
Type	Description
BooleanExpression	A new [BooleanExpression] representing the raw function.

Methods

conditional(Expression thenExpr, Expression elseExpr)

public final Expression conditional(Expression thenExpr, Expression elseExpr)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates a conditional expression that evaluates to a thenExpr expression if this condition is true or an elseExpr expression if the condition is false.

Parameters
Name	Description
thenExpr	Expression The expression to evaluate if the condition is true.
elseExpr	Expression The expression to evaluate if the condition is false.

Returns
Type	Description
Expression	A new Expression representing the conditional operation.

conditional(Object thenValue, Object elseValue)

public final Expression conditional(Object thenValue, Object elseValue)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates a conditional expression that evaluates to a thenValue if this condition is true or an elseValue if the condition is false.

Parameters
Name	Description
thenValue	Object Value if the condition is true.
elseValue	Object Value if the condition is false.

Returns
Type	Description
Expression	A new Expression representing the conditional operation.

countIf()

public AggregateFunction countIf()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates an aggregation that counts the number of stage inputs where the this boolean expression evaluates to true.

Returns
Type	Description
AggregateFunction	A new AggregateFunction representing the count aggregation.

ifError(BooleanExpression catchExpr)

public final BooleanExpression ifError(BooleanExpression catchExpr)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates an expression that returns the catchExpr argument if there is an error, else return the result of this expression.

Parameter
Name	Description
catchExpr	BooleanExpression The catch expression that will be evaluated and returned if the this expression produces an error.

Returns
Type	Description
BooleanExpression	A new Expression representing the ifError operation.

not()

public final BooleanExpression not()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates an expression that negates this boolean expression.

Returns
Type	Description
BooleanExpression	A new BooleanExpression representing the not operation.