Class: Google::Bigtable::V2::RowFilter

Inherits:

Object

Object
Google::Bigtable::V2::RowFilter

show all

Defined in:: lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb

Overview

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 4096 bytes, and RowFilters may not be nested within each other (in Chains or Interleaves) to a depth of more than 20.

Defined Under Namespace

Classes: Chain, Condition, Interleave

Instance Attribute Summary collapse

#apply_label_transformer ⇒ String
Applies the given label to all cells in the output row.
#block_all_filter ⇒ true, false
Does not match any cells, regardless of input.
#cells_per_column_limit_filter ⇒ Integer
Matches only the most recent N cells within each column.
#cells_per_row_limit_filter ⇒ Integer
Matches only the first N cells of each row.
#cells_per_row_offset_filter ⇒ Integer
Skips the first N cells of each row, matching all subsequent cells.
#chain ⇒ Google::Bigtable::V2::RowFilter::Chain
Applies several RowFilters to the data in sequence, progressively narrowing the results.
#column_qualifier_regex_filter ⇒ String
Matches only cells from columns whose qualifiers satisfy the given RE2 regex.
#column_range_filter ⇒ Google::Bigtable::V2::ColumnRange
Matches only cells from columns within the given range.
#condition ⇒ Google::Bigtable::V2::RowFilter::Condition
Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
#family_name_regex_filter ⇒ String
Matches only cells from columns whose families satisfy the given RE2 regex.
#interleave ⇒ Google::Bigtable::V2::RowFilter::Interleave
Applies several RowFilters to the data in parallel and combines the results.
#pass_all_filter ⇒ true, false
Matches all cells, regardless of input.
#row_key_regex_filter ⇒ String
Matches only cells from rows whose keys satisfy the given RE2 regex.
#row_sample_filter ⇒ Float
Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.
#sink ⇒ true, false
ADVANCED USE ONLY.
#strip_value_transformer ⇒ true, false
Replaces each cell's value with the empty string.
#timestamp_range_filter ⇒ Google::Bigtable::V2::TimestampRange
Matches only cells with timestamps within the given range.
#value_range_filter ⇒ Google::Bigtable::V2::ValueRange
Matches only cells with values that fall within the given range.
#value_regex_filter ⇒ String
Matches only cells with values that satisfy the given regular expression.

Instance Attribute Details

#apply_label_transformer ⇒ `String`

Returns 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.

Returns:

(String) —
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.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#block_all_filter ⇒ `true`, `false`

Returns Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.

Returns:

(true, false) —
Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#cells_per_column_limit_filter ⇒ `Integer`

Returns 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.

Returns:

(Integer) —
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.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#cells_per_row_limit_filter ⇒ `Integer`

Returns 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.

Returns:

(Integer) —
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.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#cells_per_row_offset_filter ⇒ `Integer`

Returns 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.

Returns:

(Integer) —
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.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#chain ⇒ `Google::Bigtable::V2::RowFilter::Chain`

Returns Applies several RowFilters to the data in sequence, progressively narrowing the results.

Returns:

(Google::Bigtable::V2::RowFilter::Chain) —
Applies several RowFilters to the data in sequence, progressively narrowing the results.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#column_qualifier_regex_filter ⇒ `String`

Returns 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.

Returns:

(String) —
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.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#column_range_filter ⇒ `Google::Bigtable::V2::ColumnRange`

Returns Matches only cells from columns within the given range.

Returns:

(Google::Bigtable::V2::ColumnRange) —
Matches only cells from columns within the given range.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#condition ⇒ `Google::Bigtable::V2::RowFilter::Condition`

Returns Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.

Returns:

(Google::Bigtable::V2::RowFilter::Condition) —
Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#family_name_regex_filter ⇒ `String`

Returns 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.

Returns:

(String) —
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.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#interleave ⇒ `Google::Bigtable::V2::RowFilter::Interleave`

Returns Applies several RowFilters to the data in parallel and combines the results.

Returns:

(Google::Bigtable::V2::RowFilter::Interleave) —
Applies several RowFilters to the data in parallel and combines the results.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#pass_all_filter ⇒ `true`, `false`

Returns Matches all cells, regardless of input. Functionally equivalent to leaving +filter+ unset, but included for completeness.

Returns:

(true, false) —
Matches all cells, regardless of input. Functionally equivalent to leaving +filter+ unset, but included for completeness.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#row_key_regex_filter ⇒ `String`

Returns 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.

Returns:

(String) —
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.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#row_sample_filter ⇒ `Float`

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

Returns:

(Float) —
Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#sink ⇒ `true`, `false`

Returns 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.

Returns:

(true, false) —

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.

Cannot be used within the +predicate_filter+, +true_filter+, or +false_filter+ of a Condition.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#strip_value_transformer ⇒ `true`, `false`

Returns Replaces each cell's value with the empty string.

Returns:

(true, false) —
Replaces each cell's value with the empty string.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#timestamp_range_filter ⇒ `Google::Bigtable::V2::TimestampRange`

Returns Matches only cells with timestamps within the given range.

Returns:

(Google::Bigtable::V2::TimestampRange) —
Matches only cells with timestamps within the given range.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#value_range_filter ⇒ `Google::Bigtable::V2::ValueRange`

Returns Matches only cells with values that fall within the given range.

Returns:

(Google::Bigtable::V2::ValueRange) —
Matches only cells with values that fall within the given range.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

#value_regex_filter ⇒ `String`

Returns 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.

Returns:

(String) —
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.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 343

class RowFilter
  # A RowFilter which sends rows through several RowFilters in sequence.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" are chained together to process the input row:
  #     in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
  #     The full chain is executed atomically.
  class Chain; end

  # A RowFilter which sends each row to each of several component
  # RowFilters and interleaves the results.
  # @!attribute [rw] filters
  #   @return [Array<Google::Bigtable::V2::RowFilter>]
  #     The elements of "filters" all process a copy of the input row, and the
  #     results are pooled, sorted, and combined into a single output row.
  #     If multiple cells are produced with the same column and timestamp,
  #     they will all appear in the output row in an unspecified mutual order.
  #     Consider the following example, with three filters:
  #
  #                                      input row
  #                                          |
  #                -----------------------------------------------------
  #                |                         |                         |
  #               f(0)                      f(1)                      f(2)
  #                |                         |                         |
  #         1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
  #         2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
  #                |                         |                         |
  #                -----------------------------------------------------
  #                                          |
  #         1:                      foo,bar,10,z   // could have switched with #2
  #         2:                      foo,bar,10,x   // could have switched with #1
  #         3:                      foo,blah,11,z
  #         4:                      far,bar,7,a
  #         5:                      far,blah,5,x   // identical to #6
  #         6:                      far,blah,5,x   // identical to #5
  #
  #     All interleaved filters are executed atomically.
  class Interleave; end

  # A RowFilter which evaluates one of two possible RowFilters, depending on
  # whether or not a predicate RowFilter outputs any cells from the input row.
  #
  # IMPORTANT NOTE: The predicate filter does not execute atomically with the
  # true and false filters, which may lead to inconsistent or unexpected
  # results. Additionally, Condition filters have poor performance, especially
  # when filters are set for the false condition.
  # @!attribute [rw] predicate_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     If +predicate_filter+ outputs any cells, then +true_filter+ will be
  #     evaluated on the input row. Otherwise, +false_filter+ will be evaluated.
  # @!attribute [rw] true_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ returns any
  #     results. If not provided, no results will be returned in the true case.
  # @!attribute [rw] false_filter
  #   @return [Google::Bigtable::V2::RowFilter]
  #     The filter to apply to the input row if +predicate_filter+ does not
  #     return any results. If not provided, no results will be returned in the
  #     false case.
  class Condition; end
end

Class: Google::Bigtable::V2::RowFilter

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#apply_label_transformer ⇒ String

#block_all_filter ⇒ true, false

#cells_per_column_limit_filter ⇒ Integer

#cells_per_row_limit_filter ⇒ Integer

#cells_per_row_offset_filter ⇒ Integer

#chain ⇒ Google::Bigtable::V2::RowFilter::Chain

#column_qualifier_regex_filter ⇒ String

#column_range_filter ⇒ Google::Bigtable::V2::ColumnRange

#condition ⇒ Google::Bigtable::V2::RowFilter::Condition

#family_name_regex_filter ⇒ String

#interleave ⇒ Google::Bigtable::V2::RowFilter::Interleave

#pass_all_filter ⇒ true, false

#row_key_regex_filter ⇒ String

#row_sample_filter ⇒ Float

#sink ⇒ true, false

#strip_value_transformer ⇒ true, false

#timestamp_range_filter ⇒ Google::Bigtable::V2::TimestampRange

#value_range_filter ⇒ Google::Bigtable::V2::ValueRange

#value_regex_filter ⇒ String

#apply_label_transformer ⇒ `String`

#block_all_filter ⇒ `true`, `false`

#cells_per_column_limit_filter ⇒ `Integer`

#cells_per_row_limit_filter ⇒ `Integer`

#cells_per_row_offset_filter ⇒ `Integer`

#chain ⇒ `Google::Bigtable::V2::RowFilter::Chain`

#column_qualifier_regex_filter ⇒ `String`

#column_range_filter ⇒ `Google::Bigtable::V2::ColumnRange`

#condition ⇒ `Google::Bigtable::V2::RowFilter::Condition`

#family_name_regex_filter ⇒ `String`

#interleave ⇒ `Google::Bigtable::V2::RowFilter::Interleave`

#pass_all_filter ⇒ `true`, `false`

#row_key_regex_filter ⇒ `String`

#row_sample_filter ⇒ `Float`

#sink ⇒ `true`, `false`

#strip_value_transformer ⇒ `true`, `false`

#timestamp_range_filter ⇒ `Google::Bigtable::V2::TimestampRange`

#value_range_filter ⇒ `Google::Bigtable::V2::ValueRange`

#value_regex_filter ⇒ `String`