Class ConditionalRowFilter (2.11.0)

Version 2.11.0

• 2.26.0 (latest)
• 2.25.0
• 2.24.0
• 2.23.1
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.1
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.1
• 2.13.2
• 2.12.0
• 2.11.3
• 2.10.1
• 2.9.0
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.3
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.3
• 1.6.1
• 1.5.1
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.34.0

ConditionalRowFilter(base_filter, true_filter=None, false_filter=None)

Conditional row filter which exhibits ternary behavior.

Executes one of two filters based on another filter. If the base_filter returns any cells in the row, then true_filter is executed. If not, then false_filter is executed.

Note: The base_filter does not execute atomically with the true and false filters, which may lead to inconsistent or unexpected results. Additionally, executing a ConditionalRowFilter has poor performance on the server, especially when false_filter is set.

Parameters

Name	Description
base_filter	`RowFilter` The filter to condition on before executing the true/false filters.
true_filter	`RowFilter` (Optional) The filter to execute if there are any cells matching base_filter. If not provided, no results will be returned in the true case.
false_filter	`RowFilter` (Optional) The filter to execute if there are no cells matching base_filter. If not provided, no results will be returned in the false case.

Inheritance

builtins.object > RowFilter > ConditionalRowFilter

Methods

to_pb

to_pb()

Converts the row filter to a protobuf.

Returns

Type	Description
`.data_v2_pb2.RowFilter`	The converted current object.