Package com.google.bigtable.v2
Class RowFilter.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
com.google.bigtable.v2.RowFilter.Builder
- All Implemented Interfaces:
RowFilterOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- RowFilter
public static final class RowFilter.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
implements RowFilterOrBuilder
Takes a row as input and produces an alternate view of the row based on specified rules. For example, a RowFilter might trim down a row to include just the cells from columns matching a given regular expression, or might return all the cells of a row but not their values. More complicated filters can be composed out of these components to express requests such as, "within every column of a particular family, give just the two most recent cells which are older than timestamp X." There are two broad categories of RowFilters (true filters and transformers), as well as two ways to compose simple filters into more complex ones (chains and interleaves). They work as follows: * True filters alter the input row by excluding some of its cells wholesale from the output row. An example of a true filter is the `value_regex_filter`, which excludes cells whose values don't match the specified pattern. All regex true filters use RE2 syntax (https://github.com/google/re2/wiki/Syntax) in raw byte mode (RE2::Latin1), and are evaluated as full matches. An important point to keep in mind is that `RE2(.)` is equivalent by default to `RE2([^\n])`, meaning that it does not match newlines. When attempting to match an arbitrary byte, you should therefore use the escape sequence `\C`, which may need to be further escaped as `\\C` in your client language. * Transformers alter the input row by changing the values of some of its cells in the output, without excluding them completely. Currently, the only supported transformer is the `strip_value_transformer`, which replaces every cell's value with the empty string. * Chains and interleaves are described in more detail in the RowFilter.Chain and RowFilter.Interleave documentation. The total serialized size of a RowFilter message must not exceed 20480 bytes, and RowFilters may not be nested within each other (in Chains or Interleaves) to a depth of more than 20.Protobuf type
google.bigtable.v2.RowFilter-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()Applies the given label to all cells in the output row.Does not match any cells, regardless of input.Matches only the most recent N cells within each column.Matches only the first N cells of each row.Skips the first N cells of each row, matching all subsequent cells.Applies several RowFilters to the data in sequence, progressively narrowing the results.Matches only cells from columns whose qualifiers satisfy the given RE2 regex.Matches only cells from columns within the given range.Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.Matches only cells from columns whose families satisfy the given RE2 regex.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) Applies several RowFilters to the data in parallel and combines the results.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Matches all cells, regardless of input.Matches only cells from rows whose keys satisfy the given RE2 regex.Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.ADVANCED USE ONLY.Replaces each cell's value with the empty string.Matches only cells with timestamps within the given range.Matches only cells with values that fall within the given range.Matches only cells with values that satisfy the given regular expression.clone()Applies the given label to all cells in the output row.com.google.protobuf.ByteStringApplies the given label to all cells in the output row.booleanDoes not match any cells, regardless of input.intMatches only the most recent N cells within each column.intMatches only the first N cells of each row.intSkips the first N cells of each row, matching all subsequent cells.getChain()Applies several RowFilters to the data in sequence, progressively narrowing the results.Applies several RowFilters to the data in sequence, progressively narrowing the results.Applies several RowFilters to the data in sequence, progressively narrowing the results.com.google.protobuf.ByteStringMatches only cells from columns whose qualifiers satisfy the given RE2 regex.Matches only cells from columns within the given range.Matches only cells from columns within the given range.Matches only cells from columns within the given range.Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorMatches only cells from columns whose families satisfy the given RE2 regex.com.google.protobuf.ByteStringMatches only cells from columns whose families satisfy the given RE2 regex.Applies several RowFilters to the data in parallel and combines the results.Applies several RowFilters to the data in parallel and combines the results.Applies several RowFilters to the data in parallel and combines the results.booleanMatches all cells, regardless of input.com.google.protobuf.ByteStringMatches only cells from rows whose keys satisfy the given RE2 regex.doubleMatches all cells from a row with probability p, and matches no cells from the row with probability 1-p.booleangetSink()ADVANCED USE ONLY.booleanReplaces each cell's value with the empty string.Matches only cells with timestamps within the given range.Matches only cells with timestamps within the given range.Matches only cells with timestamps within the given range.Matches only cells with values that fall within the given range.Matches only cells with values that fall within the given range.Matches only cells with values that fall within the given range.com.google.protobuf.ByteStringMatches only cells with values that satisfy the given regular expression.booleanApplies the given label to all cells in the output row.booleanDoes not match any cells, regardless of input.booleanMatches only the most recent N cells within each column.booleanMatches only the first N cells of each row.booleanSkips the first N cells of each row, matching all subsequent cells.booleanhasChain()Applies several RowFilters to the data in sequence, progressively narrowing the results.booleanMatches only cells from columns whose qualifiers satisfy the given RE2 regex.booleanMatches only cells from columns within the given range.booleanApplies one of two possible RowFilters to the data based on the output of a predicate RowFilter.booleanMatches only cells from columns whose families satisfy the given RE2 regex.booleanApplies several RowFilters to the data in parallel and combines the results.booleanMatches all cells, regardless of input.booleanMatches only cells from rows whose keys satisfy the given RE2 regex.booleanMatches all cells from a row with probability p, and matches no cells from the row with probability 1-p.booleanhasSink()ADVANCED USE ONLY.booleanReplaces each cell's value with the empty string.booleanMatches only cells with timestamps within the given range.booleanMatches only cells with values that fall within the given range.booleanMatches only cells with values that satisfy the given regular expression.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeChain(RowFilter.Chain value) Applies several RowFilters to the data in sequence, progressively narrowing the results.Matches only cells from columns within the given range.Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Applies several RowFilters to the data in parallel and combines the results.Matches only cells with timestamps within the given range.final RowFilter.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) mergeValueRangeFilter(ValueRange value) Matches only cells with values that fall within the given range.setApplyLabelTransformer(String value) Applies the given label to all cells in the output row.setApplyLabelTransformerBytes(com.google.protobuf.ByteString value) Applies the given label to all cells in the output row.setBlockAllFilter(boolean value) Does not match any cells, regardless of input.setCellsPerColumnLimitFilter(int value) Matches only the most recent N cells within each column.setCellsPerRowLimitFilter(int value) Matches only the first N cells of each row.setCellsPerRowOffsetFilter(int value) Skips the first N cells of each row, matching all subsequent cells.setChain(RowFilter.Chain value) Applies several RowFilters to the data in sequence, progressively narrowing the results.setChain(RowFilter.Chain.Builder builderForValue) Applies several RowFilters to the data in sequence, progressively narrowing the results.setColumnQualifierRegexFilter(com.google.protobuf.ByteString value) Matches only cells from columns whose qualifiers satisfy the given RE2 regex.setColumnRangeFilter(ColumnRange value) Matches only cells from columns within the given range.setColumnRangeFilter(ColumnRange.Builder builderForValue) Matches only cells from columns within the given range.setCondition(RowFilter.Condition value) Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.setCondition(RowFilter.Condition.Builder builderForValue) Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.setFamilyNameRegexFilter(String value) Matches only cells from columns whose families satisfy the given RE2 regex.setFamilyNameRegexFilterBytes(com.google.protobuf.ByteString value) Matches only cells from columns whose families satisfy the given RE2 regex.Applies several RowFilters to the data in parallel and combines the results.setInterleave(RowFilter.Interleave.Builder builderForValue) Applies several RowFilters to the data in parallel and combines the results.setPassAllFilter(boolean value) Matches all cells, regardless of input.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRowKeyRegexFilter(com.google.protobuf.ByteString value) Matches only cells from rows whose keys satisfy the given RE2 regex.setRowSampleFilter(double value) Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.setSink(boolean value) ADVANCED USE ONLY.setStripValueTransformer(boolean value) Replaces each cell's value with the empty string.Matches only cells with timestamps within the given range.setTimestampRangeFilter(TimestampRange.Builder builderForValue) Matches only cells with timestamps within the given range.final RowFilter.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setValueRangeFilter(ValueRange value) Matches only cells with values that fall within the given range.setValueRangeFilter(ValueRange.Builder builderForValue) Matches only cells with values that fall within the given range.setValueRegexFilter(com.google.protobuf.ByteString value) Matches only cells with values that satisfy the given regular expression.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
setField
public RowFilter.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
setRepeatedField
public RowFilter.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
addRepeatedField
public RowFilter.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<RowFilter.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
mergeFrom
public RowFilter.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<RowFilter.Builder>- Throws:
IOException
-
getFilterCase
- Specified by:
getFilterCasein interfaceRowFilterOrBuilder
-
clearFilter
-
hasChain
public boolean hasChain()Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;- Specified by:
hasChainin interfaceRowFilterOrBuilder- Returns:
- Whether the chain field is set.
-
getChain
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;- Specified by:
getChainin interfaceRowFilterOrBuilder- Returns:
- The chain.
-
setChain
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1; -
setChain
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1; -
mergeChain
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1; -
clearChain
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1; -
getChainBuilder
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1; -
getChainOrBuilder
Applies several RowFilters to the data in sequence, progressively narrowing the results.
.google.bigtable.v2.RowFilter.Chain chain = 1;- Specified by:
getChainOrBuilderin interfaceRowFilterOrBuilder
-
hasInterleave
public boolean hasInterleave()Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;- Specified by:
hasInterleavein interfaceRowFilterOrBuilder- Returns:
- Whether the interleave field is set.
-
getInterleave
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;- Specified by:
getInterleavein interfaceRowFilterOrBuilder- Returns:
- The interleave.
-
setInterleave
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2; -
setInterleave
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2; -
mergeInterleave
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2; -
clearInterleave
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2; -
getInterleaveBuilder
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2; -
getInterleaveOrBuilder
Applies several RowFilters to the data in parallel and combines the results.
.google.bigtable.v2.RowFilter.Interleave interleave = 2;- Specified by:
getInterleaveOrBuilderin interfaceRowFilterOrBuilder
-
hasCondition
public 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;- Specified by:
hasConditionin interfaceRowFilterOrBuilder- Returns:
- Whether the condition field is set.
-
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;- Specified by:
getConditionin interfaceRowFilterOrBuilder- Returns:
- The condition.
-
setCondition
Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
.google.bigtable.v2.RowFilter.Condition condition = 3; -
setCondition
Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
.google.bigtable.v2.RowFilter.Condition condition = 3; -
mergeCondition
Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
.google.bigtable.v2.RowFilter.Condition condition = 3; -
clearCondition
Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
.google.bigtable.v2.RowFilter.Condition condition = 3; -
getConditionBuilder
Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
.google.bigtable.v2.RowFilter.Condition condition = 3; -
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;- Specified by:
getConditionOrBuilderin interfaceRowFilterOrBuilder
-
hasSink
public 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][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;- Specified by:
hasSinkin interfaceRowFilterOrBuilder- Returns:
- Whether the sink field is set.
-
getSink
public 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;- Specified by:
getSinkin interfaceRowFilterOrBuilder- Returns:
- The sink.
-
setSink
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;- Parameters:
value- The sink to set.- Returns:
- This builder for chaining.
-
clearSink
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;- Returns:
- This builder for chaining.
-
hasPassAllFilter
public boolean hasPassAllFilter()Matches all cells, regardless of input. Functionally equivalent to leaving `filter` unset, but included for completeness.
bool pass_all_filter = 17;- Specified by:
hasPassAllFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the passAllFilter field is set.
-
getPassAllFilter
public boolean getPassAllFilter()Matches all cells, regardless of input. Functionally equivalent to leaving `filter` unset, but included for completeness.
bool pass_all_filter = 17;- Specified by:
getPassAllFilterin interfaceRowFilterOrBuilder- Returns:
- The passAllFilter.
-
setPassAllFilter
Matches all cells, regardless of input. Functionally equivalent to leaving `filter` unset, but included for completeness.
bool pass_all_filter = 17;- Parameters:
value- The passAllFilter to set.- Returns:
- This builder for chaining.
-
clearPassAllFilter
Matches all cells, regardless of input. Functionally equivalent to leaving `filter` unset, but included for completeness.
bool pass_all_filter = 17;- Returns:
- This builder for chaining.
-
hasBlockAllFilter
public boolean hasBlockAllFilter()Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
bool block_all_filter = 18;- Specified by:
hasBlockAllFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the blockAllFilter field is set.
-
getBlockAllFilter
public boolean getBlockAllFilter()Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
bool block_all_filter = 18;- Specified by:
getBlockAllFilterin interfaceRowFilterOrBuilder- Returns:
- The blockAllFilter.
-
setBlockAllFilter
Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
bool block_all_filter = 18;- Parameters:
value- The blockAllFilter to set.- Returns:
- This builder for chaining.
-
clearBlockAllFilter
Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
bool block_all_filter = 18;- Returns:
- This builder for chaining.
-
hasRowKeyRegexFilter
public 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;- Specified by:
hasRowKeyRegexFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the rowKeyRegexFilter field is set.
-
getRowKeyRegexFilter
public 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;- Specified by:
getRowKeyRegexFilterin interfaceRowFilterOrBuilder- Returns:
- The rowKeyRegexFilter.
-
setRowKeyRegexFilter
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;- Parameters:
value- The rowKeyRegexFilter to set.- Returns:
- This builder for chaining.
-
clearRowKeyRegexFilter
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;- Returns:
- This builder for chaining.
-
hasRowSampleFilter
public 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;- Specified by:
hasRowSampleFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the rowSampleFilter field is set.
-
getRowSampleFilter
public 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;- Specified by:
getRowSampleFilterin interfaceRowFilterOrBuilder- Returns:
- The rowSampleFilter.
-
setRowSampleFilter
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;- Parameters:
value- The rowSampleFilter to set.- Returns:
- This builder for chaining.
-
clearRowSampleFilter
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;- Returns:
- This builder for chaining.
-
hasFamilyNameRegexFilter
public 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;- Specified by:
hasFamilyNameRegexFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the familyNameRegexFilter field is set.
-
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;- Specified by:
getFamilyNameRegexFilterin interfaceRowFilterOrBuilder- Returns:
- The familyNameRegexFilter.
-
getFamilyNameRegexFilterBytes
public 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;- Specified by:
getFamilyNameRegexFilterBytesin interfaceRowFilterOrBuilder- Returns:
- The bytes for familyNameRegexFilter.
-
setFamilyNameRegexFilter
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;- Parameters:
value- The familyNameRegexFilter to set.- Returns:
- This builder for chaining.
-
clearFamilyNameRegexFilter
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;- Returns:
- This builder for chaining.
-
setFamilyNameRegexFilterBytes
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;- Parameters:
value- The bytes for familyNameRegexFilter to set.- Returns:
- This builder for chaining.
-
hasColumnQualifierRegexFilter
public 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;- Specified by:
hasColumnQualifierRegexFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the columnQualifierRegexFilter field is set.
-
getColumnQualifierRegexFilter
public 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;- Specified by:
getColumnQualifierRegexFilterin interfaceRowFilterOrBuilder- Returns:
- The columnQualifierRegexFilter.
-
setColumnQualifierRegexFilter
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;- Parameters:
value- The columnQualifierRegexFilter to set.- Returns:
- This builder for chaining.
-
clearColumnQualifierRegexFilter
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;- Returns:
- This builder for chaining.
-
hasColumnRangeFilter
public boolean hasColumnRangeFilter()Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;- Specified by:
hasColumnRangeFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the columnRangeFilter field is set.
-
getColumnRangeFilter
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;- Specified by:
getColumnRangeFilterin interfaceRowFilterOrBuilder- Returns:
- The columnRangeFilter.
-
setColumnRangeFilter
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7; -
setColumnRangeFilter
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7; -
mergeColumnRangeFilter
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7; -
clearColumnRangeFilter
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7; -
getColumnRangeFilterBuilder
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7; -
getColumnRangeFilterOrBuilder
Matches only cells from columns within the given range.
.google.bigtable.v2.ColumnRange column_range_filter = 7;- Specified by:
getColumnRangeFilterOrBuilderin interfaceRowFilterOrBuilder
-
hasTimestampRangeFilter
public boolean hasTimestampRangeFilter()Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;- Specified by:
hasTimestampRangeFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the timestampRangeFilter field is set.
-
getTimestampRangeFilter
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;- Specified by:
getTimestampRangeFilterin interfaceRowFilterOrBuilder- Returns:
- The timestampRangeFilter.
-
setTimestampRangeFilter
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8; -
setTimestampRangeFilter
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8; -
mergeTimestampRangeFilter
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8; -
clearTimestampRangeFilter
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8; -
getTimestampRangeFilterBuilder
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8; -
getTimestampRangeFilterOrBuilder
Matches only cells with timestamps within the given range.
.google.bigtable.v2.TimestampRange timestamp_range_filter = 8;- Specified by:
getTimestampRangeFilterOrBuilderin interfaceRowFilterOrBuilder
-
hasValueRegexFilter
public 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;- Specified by:
hasValueRegexFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the valueRegexFilter field is set.
-
getValueRegexFilter
public 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;- Specified by:
getValueRegexFilterin interfaceRowFilterOrBuilder- Returns:
- The valueRegexFilter.
-
setValueRegexFilter
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;- Parameters:
value- The valueRegexFilter to set.- Returns:
- This builder for chaining.
-
clearValueRegexFilter
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;- Returns:
- This builder for chaining.
-
hasValueRangeFilter
public boolean hasValueRangeFilter()Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;- Specified by:
hasValueRangeFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the valueRangeFilter field is set.
-
getValueRangeFilter
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;- Specified by:
getValueRangeFilterin interfaceRowFilterOrBuilder- Returns:
- The valueRangeFilter.
-
setValueRangeFilter
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15; -
setValueRangeFilter
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15; -
mergeValueRangeFilter
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15; -
clearValueRangeFilter
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15; -
getValueRangeFilterBuilder
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15; -
getValueRangeFilterOrBuilder
Matches only cells with values that fall within the given range.
.google.bigtable.v2.ValueRange value_range_filter = 15;- Specified by:
getValueRangeFilterOrBuilderin interfaceRowFilterOrBuilder
-
hasCellsPerRowOffsetFilter
public 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;- Specified by:
hasCellsPerRowOffsetFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the cellsPerRowOffsetFilter field is set.
-
getCellsPerRowOffsetFilter
public 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;- Specified by:
getCellsPerRowOffsetFilterin interfaceRowFilterOrBuilder- Returns:
- The cellsPerRowOffsetFilter.
-
setCellsPerRowOffsetFilter
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;- Parameters:
value- The cellsPerRowOffsetFilter to set.- Returns:
- This builder for chaining.
-
clearCellsPerRowOffsetFilter
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;- Returns:
- This builder for chaining.
-
hasCellsPerRowLimitFilter
public 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;- Specified by:
hasCellsPerRowLimitFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the cellsPerRowLimitFilter field is set.
-
getCellsPerRowLimitFilter
public 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;- Specified by:
getCellsPerRowLimitFilterin interfaceRowFilterOrBuilder- Returns:
- The cellsPerRowLimitFilter.
-
setCellsPerRowLimitFilter
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;- Parameters:
value- The cellsPerRowLimitFilter to set.- Returns:
- This builder for chaining.
-
clearCellsPerRowLimitFilter
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;- Returns:
- This builder for chaining.
-
hasCellsPerColumnLimitFilter
public 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;- Specified by:
hasCellsPerColumnLimitFilterin interfaceRowFilterOrBuilder- Returns:
- Whether the cellsPerColumnLimitFilter field is set.
-
getCellsPerColumnLimitFilter
public 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;- Specified by:
getCellsPerColumnLimitFilterin interfaceRowFilterOrBuilder- Returns:
- The cellsPerColumnLimitFilter.
-
setCellsPerColumnLimitFilter
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;- Parameters:
value- The cellsPerColumnLimitFilter to set.- Returns:
- This builder for chaining.
-
clearCellsPerColumnLimitFilter
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;- Returns:
- This builder for chaining.
-
hasStripValueTransformer
public boolean hasStripValueTransformer()Replaces each cell's value with the empty string.
bool strip_value_transformer = 13;- Specified by:
hasStripValueTransformerin interfaceRowFilterOrBuilder- Returns:
- Whether the stripValueTransformer field is set.
-
getStripValueTransformer
public boolean getStripValueTransformer()Replaces each cell's value with the empty string.
bool strip_value_transformer = 13;- Specified by:
getStripValueTransformerin interfaceRowFilterOrBuilder- Returns:
- The stripValueTransformer.
-
setStripValueTransformer
Replaces each cell's value with the empty string.
bool strip_value_transformer = 13;- Parameters:
value- The stripValueTransformer to set.- Returns:
- This builder for chaining.
-
clearStripValueTransformer
Replaces each cell's value with the empty string.
bool strip_value_transformer = 13;- Returns:
- This builder for chaining.
-
hasApplyLabelTransformer
public 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;- Specified by:
hasApplyLabelTransformerin interfaceRowFilterOrBuilder- Returns:
- Whether the applyLabelTransformer field is set.
-
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;- Specified by:
getApplyLabelTransformerin interfaceRowFilterOrBuilder- Returns:
- The applyLabelTransformer.
-
getApplyLabelTransformerBytes
public 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;- Specified by:
getApplyLabelTransformerBytesin interfaceRowFilterOrBuilder- Returns:
- The bytes for applyLabelTransformer.
-
setApplyLabelTransformer
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;- Parameters:
value- The applyLabelTransformer to set.- Returns:
- This builder for chaining.
-
clearApplyLabelTransformer
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;- Returns:
- This builder for chaining.
-
setApplyLabelTransformerBytes
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;- Parameters:
value- The bytes for applyLabelTransformer to set.- Returns:
- This builder for chaining.
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-
mergeUnknownFields
public final RowFilter.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<RowFilter.Builder>
-