public interface RowFilterOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getApplyLabelTransformer()
public abstract String getApplyLabelTransformer() Applies the given label to all cells in the output row. This allows
the client to determine which results were produced from which part of
the filter.
Values must be at most 15 characters in length, and match the RE2
pattern [a-z0-9\\-]+
Due to a technical limitation, it is not currently possible to apply
multiple labels to a cell. As a result, a Chain may have no more than
one sub-filter which contains a apply_label_transformer. It is okay for
an Interleave to contain multiple apply_label_transformers, as they
will be applied to separate copies of the input. This may be relaxed in
the future.
string apply_label_transformer = 19;
| Type | Description |
| String | The applyLabelTransformer. |
getApplyLabelTransformerBytes()
public abstract ByteString getApplyLabelTransformerBytes() Applies the given label to all cells in the output row. This allows
the client to determine which results were produced from which part of
the filter.
Values must be at most 15 characters in length, and match the RE2
pattern [a-z0-9\\-]+
Due to a technical limitation, it is not currently possible to apply
multiple labels to a cell. As a result, a Chain may have no more than
one sub-filter which contains a apply_label_transformer. It is okay for
an Interleave to contain multiple apply_label_transformers, as they
will be applied to separate copies of the input. This may be relaxed in
the future.
string apply_label_transformer = 19;
| Type | Description |
| ByteString | The bytes for applyLabelTransformer. |
getBlockAllFilter()
public abstract boolean getBlockAllFilter()Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
bool block_all_filter = 18;
| Type | Description |
| boolean | The blockAllFilter. |
getCellsPerColumnLimitFilter()
public abstract int getCellsPerColumnLimitFilter() Matches only the most recent N cells within each column. For example,
if N=2, this filter would match column foo:bar at timestamps 10 and 9,
skip all earlier cells in foo:bar, and then begin matching again in
column foo:bar2.
If duplicate cells are present, as is possible when using an Interleave,
each copy of the cell is counted separately.
int32 cells_per_column_limit_filter = 12;
| Type | Description |
| int | The cellsPerColumnLimitFilter. |
getCellsPerRowLimitFilter()
public abstract int getCellsPerRowLimitFilter()Matches only the first N cells of each row. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.
int32 cells_per_row_limit_filter = 11;
| Type | Description |
| int | The cellsPerRowLimitFilter. |
getCellsPerRowOffsetFilter()
public abstract int getCellsPerRowOffsetFilter()Skips the first N cells of each row, matching all subsequent cells. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.
int32 cells_per_row_offset_filter = 10;
| Type | Description |
| int | The cellsPerRowOffsetFilter. |
getChain()
public abstract RowFilter.Chain getChain()Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;
| Type | Description |
| RowFilter.Chain | The chain. |
getChainOrBuilder()
public abstract RowFilter.ChainOrBuilder getChainOrBuilder()Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;
| Type | Description |
| RowFilter.ChainOrBuilder |
getColumnQualifierRegexFilter()
public abstract ByteString getColumnQualifierRegexFilter() Matches only cells from columns whose qualifiers satisfy the given RE2
regex.
Note that, since column qualifiers can contain arbitrary bytes, the \C
escape sequence must be used if a true wildcard is desired. The .
character will not match the new line character \n, which may be
present in a binary qualifier.
bytes column_qualifier_regex_filter = 6;
| Type | Description |
| ByteString | The columnQualifierRegexFilter. |
getColumnRangeFilter()
public abstract ColumnRange getColumnRangeFilter()Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;
| Type | Description |
| ColumnRange | The columnRangeFilter. |
getColumnRangeFilterOrBuilder()
public abstract ColumnRangeOrBuilder getColumnRangeFilterOrBuilder()Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;
| Type | Description |
| ColumnRangeOrBuilder |
getCondition()
public abstract RowFilter.Condition getCondition()Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
.google.bigtable.v2.RowFilter.Condition condition = 3;
| Type | Description |
| RowFilter.Condition | The condition. |
getConditionOrBuilder()
public abstract RowFilter.ConditionOrBuilder getConditionOrBuilder()Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
.google.bigtable.v2.RowFilter.Condition condition = 3;
| Type | Description |
| RowFilter.ConditionOrBuilder |
getFamilyNameRegexFilter()
public abstract String getFamilyNameRegexFilter() Matches only cells from columns whose families satisfy the given RE2
regex. For technical reasons, the regex must not contain the :
character, even if it is not being used as a literal.
Note that, since column families cannot contain the new line character
\n, it is sufficient to use . as a full wildcard when matching
column family names.
string family_name_regex_filter = 5;
| Type | Description |
| String | The familyNameRegexFilter. |
getFamilyNameRegexFilterBytes()
public abstract ByteString getFamilyNameRegexFilterBytes() Matches only cells from columns whose families satisfy the given RE2
regex. For technical reasons, the regex must not contain the :
character, even if it is not being used as a literal.
Note that, since column families cannot contain the new line character
\n, it is sufficient to use . as a full wildcard when matching
column family names.
string family_name_regex_filter = 5;
| Type | Description |
| ByteString | The bytes for familyNameRegexFilter. |
getFilterCase()
public abstract RowFilter.FilterCase getFilterCase()| Type | Description |
| RowFilter.FilterCase |
getInterleave()
public abstract RowFilter.Interleave getInterleave()Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;
| Type | Description |
| RowFilter.Interleave | The interleave. |
getInterleaveOrBuilder()
public abstract RowFilter.InterleaveOrBuilder getInterleaveOrBuilder()Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;
| Type | Description |
| RowFilter.InterleaveOrBuilder |
getPassAllFilter()
public abstract boolean getPassAllFilter() Matches all cells, regardless of input. Functionally equivalent to
leaving filter unset, but included for completeness.
bool pass_all_filter = 17;
| Type | Description |
| boolean | The passAllFilter. |
getRowKeyRegexFilter()
public abstract ByteString getRowKeyRegexFilter() Matches only cells from rows whose keys satisfy the given RE2 regex. In
other words, passes through the entire row when the key matches, and
otherwise produces an empty row.
Note that, since row keys can contain arbitrary bytes, the \C escape
sequence must be used if a true wildcard is desired. The . character
will not match the new line character \n, which may be present in a
binary key.
bytes row_key_regex_filter = 4;
| Type | Description |
| ByteString | The rowKeyRegexFilter. |
getRowSampleFilter()
public abstract double getRowSampleFilter()Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.
double row_sample_filter = 14;
| Type | Description |
| double | The rowSampleFilter. |
getSink()
public abstract boolean getSink() ADVANCED USE ONLY.
Hook for introspection into the RowFilter. Outputs all cells directly to
the output of the read rather than to any parent filter. Consider the
following example:
Chain(
FamilyRegex("A"),
Interleave(
All(),
Chain(Label("foo"), Sink())
),
QualifierRegex("B")
)
A,A,1,w
A,B,2,x
B,B,4,z
|
FamilyRegex("A")
|
A,A,1,w
A,B,2,x
|
+------------+-------------+
| |
All() Label(foo)
| |
A,A,1,w A,A,1,w,labels:[foo]
A,B,2,x A,B,2,x,labels:[foo]
| |
| Sink() --------------+
| | |
+------------+ x------+ A,A,1,w,labels:[foo]
| A,B,2,x,labels:[foo]
A,A,1,w |
A,B,2,x |
| |
QualifierRegex("B") |
| |
A,B,2,x |
| |
+--------------------------------+
|
A,A,1,w,labels:[foo]
A,B,2,x,labels:[foo] // could be switched
A,B,2,x // could be switched
Despite being excluded by the qualifier filter, a copy of every cell
that reaches the sink is present in the final result.
As with an Interleave,
duplicate cells are possible, and appear in an unspecified mutual order.
In this case we have a duplicate with column "A:B" and timestamp 2,
because one copy passed through the all filter while the other was
passed through the label and sink. Note that one copy has label "foo",
while the other does not.
Cannot be used within the predicate_filter, true_filter, or
false_filter of a Condition.
bool sink = 16;
| Type | Description |
| boolean | The sink. |
getStripValueTransformer()
public abstract boolean getStripValueTransformer()Replaces each cell's value with the empty string.
bool strip_value_transformer = 13;
| Type | Description |
| boolean | The stripValueTransformer. |
getTimestampRangeFilter()
public abstract TimestampRange getTimestampRangeFilter()Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;
| Type | Description |
| TimestampRange | The timestampRangeFilter. |
getTimestampRangeFilterOrBuilder()
public abstract TimestampRangeOrBuilder getTimestampRangeFilterOrBuilder()Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;
| Type | Description |
| TimestampRangeOrBuilder |
getValueRangeFilter()
public abstract ValueRange getValueRangeFilter()Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;
| Type | Description |
| ValueRange | The valueRangeFilter. |
getValueRangeFilterOrBuilder()
public abstract ValueRangeOrBuilder getValueRangeFilterOrBuilder()Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;
| Type | Description |
| ValueRangeOrBuilder |
getValueRegexFilter()
public abstract ByteString getValueRegexFilter() Matches only cells with values that satisfy the given regular expression.
Note that, since cell values can contain arbitrary bytes, the \C escape
sequence must be used if a true wildcard is desired. The . character
will not match the new line character \n, which may be present in a
binary value.
bytes value_regex_filter = 9;
| Type | Description |
| ByteString | The valueRegexFilter. |
hasApplyLabelTransformer()
public abstract boolean hasApplyLabelTransformer() Applies the given label to all cells in the output row. This allows
the client to determine which results were produced from which part of
the filter.
Values must be at most 15 characters in length, and match the RE2
pattern [a-z0-9\\-]+
Due to a technical limitation, it is not currently possible to apply
multiple labels to a cell. As a result, a Chain may have no more than
one sub-filter which contains a apply_label_transformer. It is okay for
an Interleave to contain multiple apply_label_transformers, as they
will be applied to separate copies of the input. This may be relaxed in
the future.
string apply_label_transformer = 19;
| Type | Description |
| boolean | Whether the applyLabelTransformer field is set. |
hasBlockAllFilter()
public abstract boolean hasBlockAllFilter()Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
bool block_all_filter = 18;
| Type | Description |
| boolean | Whether the blockAllFilter field is set. |
hasCellsPerColumnLimitFilter()
public abstract boolean hasCellsPerColumnLimitFilter() Matches only the most recent N cells within each column. For example,
if N=2, this filter would match column foo:bar at timestamps 10 and 9,
skip all earlier cells in foo:bar, and then begin matching again in
column foo:bar2.
If duplicate cells are present, as is possible when using an Interleave,
each copy of the cell is counted separately.
int32 cells_per_column_limit_filter = 12;
| Type | Description |
| boolean | Whether the cellsPerColumnLimitFilter field is set. |
hasCellsPerRowLimitFilter()
public abstract boolean hasCellsPerRowLimitFilter()Matches only the first N cells of each row. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.
int32 cells_per_row_limit_filter = 11;
| Type | Description |
| boolean | Whether the cellsPerRowLimitFilter field is set. |
hasCellsPerRowOffsetFilter()
public abstract boolean hasCellsPerRowOffsetFilter()Skips the first N cells of each row, matching all subsequent cells. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.
int32 cells_per_row_offset_filter = 10;
| Type | Description |
| boolean | Whether the cellsPerRowOffsetFilter field is set. |
hasChain()
public abstract boolean hasChain()Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;
| Type | Description |
| boolean | Whether the chain field is set. |
hasColumnQualifierRegexFilter()
public abstract boolean hasColumnQualifierRegexFilter() Matches only cells from columns whose qualifiers satisfy the given RE2
regex.
Note that, since column qualifiers can contain arbitrary bytes, the \C
escape sequence must be used if a true wildcard is desired. The .
character will not match the new line character \n, which may be
present in a binary qualifier.
bytes column_qualifier_regex_filter = 6;
| Type | Description |
| boolean | Whether the columnQualifierRegexFilter field is set. |
hasColumnRangeFilter()
public abstract boolean hasColumnRangeFilter()Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;
| Type | Description |
| boolean | Whether the columnRangeFilter field is set. |
hasCondition()
public abstract boolean hasCondition()Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
.google.bigtable.v2.RowFilter.Condition condition = 3;
| Type | Description |
| boolean | Whether the condition field is set. |
hasFamilyNameRegexFilter()
public abstract boolean hasFamilyNameRegexFilter() Matches only cells from columns whose families satisfy the given RE2
regex. For technical reasons, the regex must not contain the :
character, even if it is not being used as a literal.
Note that, since column families cannot contain the new line character
\n, it is sufficient to use . as a full wildcard when matching
column family names.
string family_name_regex_filter = 5;
| Type | Description |
| boolean | Whether the familyNameRegexFilter field is set. |
hasInterleave()
public abstract boolean hasInterleave()Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;
| Type | Description |
| boolean | Whether the interleave field is set. |
hasPassAllFilter()
public abstract boolean hasPassAllFilter() Matches all cells, regardless of input. Functionally equivalent to
leaving filter unset, but included for completeness.
bool pass_all_filter = 17;
| Type | Description |
| boolean | Whether the passAllFilter field is set. |
hasRowKeyRegexFilter()
public abstract boolean hasRowKeyRegexFilter() Matches only cells from rows whose keys satisfy the given RE2 regex. In
other words, passes through the entire row when the key matches, and
otherwise produces an empty row.
Note that, since row keys can contain arbitrary bytes, the \C escape
sequence must be used if a true wildcard is desired. The . character
will not match the new line character \n, which may be present in a
binary key.
bytes row_key_regex_filter = 4;
| Type | Description |
| boolean | Whether the rowKeyRegexFilter field is set. |
hasRowSampleFilter()
public abstract boolean hasRowSampleFilter()Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.
double row_sample_filter = 14;
| Type | Description |
| boolean | Whether the rowSampleFilter field is set. |
hasSink()
public abstract boolean hasSink() ADVANCED USE ONLY.
Hook for introspection into the RowFilter. Outputs all cells directly to
the output of the read rather than to any parent filter. Consider the
following example:
Chain(
FamilyRegex("A"),
Interleave(
All(),
Chain(Label("foo"), Sink())
),
QualifierRegex("B")
)
A,A,1,w
A,B,2,x
B,B,4,z
|
FamilyRegex("A")
|
A,A,1,w
A,B,2,x
|
+------------+-------------+
| |
All() Label(foo)
| |
A,A,1,w A,A,1,w,labels:[foo]
A,B,2,x A,B,2,x,labels:[foo]
| |
| Sink() --------------+
| | |
+------------+ x------+ A,A,1,w,labels:[foo]
| A,B,2,x,labels:[foo]
A,A,1,w |
A,B,2,x |
| |
QualifierRegex("B") |
| |
A,B,2,x |
| |
+--------------------------------+
|
A,A,1,w,labels:[foo]
A,B,2,x,labels:[foo] // could be switched
A,B,2,x // could be switched
Despite being excluded by the qualifier filter, a copy of every cell
that reaches the sink is present in the final result.
As with an Interleave,
duplicate cells are possible, and appear in an unspecified mutual order.
In this case we have a duplicate with column "A:B" and timestamp 2,
because one copy passed through the all filter while the other was
passed through the label and sink. Note that one copy has label "foo",
while the other does not.
Cannot be used within the predicate_filter, true_filter, or
false_filter of a Condition.
bool sink = 16;
| Type | Description |
| boolean | Whether the sink field is set. |
hasStripValueTransformer()
public abstract boolean hasStripValueTransformer()Replaces each cell's value with the empty string.
bool strip_value_transformer = 13;
| Type | Description |
| boolean | Whether the stripValueTransformer field is set. |
hasTimestampRangeFilter()
public abstract boolean hasTimestampRangeFilter()Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;
| Type | Description |
| boolean | Whether the timestampRangeFilter field is set. |
hasValueRangeFilter()
public abstract boolean hasValueRangeFilter()Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;
| Type | Description |
| boolean | Whether the valueRangeFilter field is set. |
hasValueRegexFilter()
public abstract boolean hasValueRegexFilter() Matches only cells with values that satisfy the given regular expression.
Note that, since cell values can contain arbitrary bytes, the \C escape
sequence must be used if a true wildcard is desired. The . character
will not match the new line character \n, which may be present in a
binary value.
bytes value_regex_filter = 9;
| Type | Description |
| boolean | Whether the valueRegexFilter field is set. |