public interface RowFilterOrBuilder
extends com.google.protobuf.MessageOrBuilder
Modifier and Type | Method and Description |
---|---|
String |
getApplyLabelTransformer()
Applies the given label to all cells in the output row.
|
com.google.protobuf.ByteString |
getApplyLabelTransformerBytes()
Applies the given label to all cells in the output row.
|
boolean |
getBlockAllFilter()
Does not match any cells, regardless of input.
|
int |
getCellsPerColumnLimitFilter()
Matches only the most recent N cells within each column.
|
int |
getCellsPerRowLimitFilter()
Matches only the first N cells of each row.
|
int |
getCellsPerRowOffsetFilter()
Skips the first N cells of each row, matching all subsequent cells.
|
RowFilter.Chain |
getChain()
Applies several RowFilters to the data in sequence, progressively
narrowing the results.
|
RowFilter.ChainOrBuilder |
getChainOrBuilder()
Applies several RowFilters to the data in sequence, progressively
narrowing the results.
|
com.google.protobuf.ByteString |
getColumnQualifierRegexFilter()
Matches only cells from columns whose qualifiers satisfy the given RE2
regex.
|
ColumnRange |
getColumnRangeFilter()
Matches only cells from columns within the given range.
|
ColumnRangeOrBuilder |
getColumnRangeFilterOrBuilder()
Matches only cells from columns within the given range.
|
RowFilter.Condition |
getCondition()
Applies one of two possible RowFilters to the data based on the output of
a predicate RowFilter.
|
RowFilter.ConditionOrBuilder |
getConditionOrBuilder()
Applies one of two possible RowFilters to the data based on the output of
a predicate RowFilter.
|
String |
getFamilyNameRegexFilter()
Matches only cells from columns whose families satisfy the given RE2
regex.
|
com.google.protobuf.ByteString |
getFamilyNameRegexFilterBytes()
Matches only cells from columns whose families satisfy the given RE2
regex.
|
RowFilter.FilterCase |
getFilterCase() |
RowFilter.Interleave |
getInterleave()
Applies several RowFilters to the data in parallel and combines the
results.
|
RowFilter.InterleaveOrBuilder |
getInterleaveOrBuilder()
Applies several RowFilters to the data in parallel and combines the
results.
|
boolean |
getPassAllFilter()
Matches all cells, regardless of input.
|
com.google.protobuf.ByteString |
getRowKeyRegexFilter()
Matches only cells from rows whose keys satisfy the given RE2 regex.
|
double |
getRowSampleFilter()
Matches all cells from a row with probability p, and matches no cells
from the row with probability 1-p.
|
boolean |
getSink()
ADVANCED USE ONLY.
|
boolean |
getStripValueTransformer()
Replaces each cell's value with the empty string.
|
TimestampRange |
getTimestampRangeFilter()
Matches only cells with timestamps within the given range.
|
TimestampRangeOrBuilder |
getTimestampRangeFilterOrBuilder()
Matches only cells with timestamps within the given range.
|
ValueRange |
getValueRangeFilter()
Matches only cells with values that fall within the given range.
|
ValueRangeOrBuilder |
getValueRangeFilterOrBuilder()
Matches only cells with values that fall within the given range.
|
com.google.protobuf.ByteString |
getValueRegexFilter()
Matches only cells with values that satisfy the given regular expression.
|
boolean |
hasChain()
Applies several RowFilters to the data in sequence, progressively
narrowing the results.
|
boolean |
hasColumnRangeFilter()
Matches only cells from columns within the given range.
|
boolean |
hasCondition()
Applies one of two possible RowFilters to the data based on the output of
a predicate RowFilter.
|
boolean |
hasInterleave()
Applies several RowFilters to the data in parallel and combines the
results.
|
boolean |
hasTimestampRangeFilter()
Matches only cells with timestamps within the given range.
|
boolean |
hasValueRangeFilter()
Matches only cells with values that fall within the given range.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
boolean hasChain()
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;
RowFilter.Chain getChain()
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;
RowFilter.ChainOrBuilder getChainOrBuilder()
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;
boolean hasInterleave()
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;
RowFilter.Interleave getInterleave()
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;
RowFilter.InterleaveOrBuilder getInterleaveOrBuilder()
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;
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;
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;
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;
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][google.bigtable.v2.RowFilter.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][google.bigtable.v2.RowFilter.Condition].
bool sink = 16;
boolean getPassAllFilter()
Matches all cells, regardless of input. Functionally equivalent to leaving `filter` unset, but included for completeness.
bool pass_all_filter = 17;
boolean getBlockAllFilter()
Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
bool block_all_filter = 18;
com.google.protobuf.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;
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;
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;
com.google.protobuf.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;
com.google.protobuf.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;
boolean hasColumnRangeFilter()
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;
ColumnRange getColumnRangeFilter()
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;
ColumnRangeOrBuilder getColumnRangeFilterOrBuilder()
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;
boolean hasTimestampRangeFilter()
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;
TimestampRange getTimestampRangeFilter()
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;
TimestampRangeOrBuilder getTimestampRangeFilterOrBuilder()
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;
com.google.protobuf.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;
boolean hasValueRangeFilter()
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;
ValueRange getValueRangeFilter()
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;
ValueRangeOrBuilder getValueRangeFilterOrBuilder()
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;
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;
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;
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;
boolean getStripValueTransformer()
Replaces each cell's value with the empty string.
bool strip_value_transformer = 13;
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;
com.google.protobuf.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;
RowFilter.FilterCase getFilterCase()
Copyright © 2018 Google LLC. All rights reserved.