com.google.cloud.bigtable.data.v2.models

Class Filters.KeyFilter

java.lang.Object

com.google.cloud.bigtable.data.v2.models.Filters.KeyFilter

Enclosing class:

Filters

public static final class Filters.KeyFilter
extends Object

Method Summary

Modifier and Type	Method and Description
Filters.Filter	exactMatch(ByteString value) Matches only cells from rows whose keys equal the value.
Filters.Filter	exactMatch(String value) Matches only cells from rows whose keys equal the value.
Filters.Filter	regex(ByteString regex) Matches only cells from rows whose keys satisfy the given RE2 regex.
Filters.Filter	regex(String regex) Matches only cells from rows whose keys satisfy the given RE2 regex.
Filters.Filter	sample(double probability) Matches all cells from a row with `probability`, and matches no cells from the row with probability 1-`probability`.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

regex

public Filters.Filter regex(@Nonnull
                            String regex)

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.

regex

public Filters.Filter regex(@Nonnull
                            ByteString regex)

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.

exactMatch

public Filters.Filter exactMatch(@Nonnull
                                 String value)

Matches only cells from rows whose keys equal the value. In other words, passes through the entire row when the key matches, and otherwise produces an empty row.

exactMatch

public Filters.Filter exactMatch(@Nonnull
                                 ByteString value)

Matches only cells from rows whose keys equal the value. In other words, passes through the entire row when the key matches, and otherwise produces an empty row.

sample

public Filters.Filter sample(double probability)

Matches all cells from a row with `probability`, and matches no cells from the row with probability 1-`probability`.