Class Filters.KeyFilter (2.30.0)

Version 2.30.0

• 2.45.1 (latest)
• 2.44.1
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.5
• 2.37.0
• 2.35.1
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.1
• 2.28.0

public static final class Filters.KeyFilter implements Serializable

Inheritance

java.lang.Object > Filters.KeyFilter

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

exactMatch(ByteString value)

public Filters.Filter exactMatch(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.

Parameter
Name	Description
value	ByteString

Returns
Type	Description
Filters.Filter

exactMatch(String value)

public Filters.Filter exactMatch(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.

Parameter
Name	Description
value	String

Returns
Type	Description
Filters.Filter

regex(ByteString regex)

public Filters.Filter regex(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 , which may be present in a binary key.

Parameter
Name	Description
regex	ByteString

Returns
Type	Description
Filters.Filter

regex(String regex)

public Filters.Filter regex(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 , which may be present in a binary key.

Parameter
Name	Description
regex	String

Returns
Type	Description
Filters.Filter

sample(double probability)

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.

Parameter
Name	Description
probability	double

Returns
Type	Description
Filters.Filter