google_bigtable_v1

package
v2.3.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 4, 2016 License: Apache-2.0, Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package google_bigtable_v1 is a generated protocol buffer package.

It is generated from these files: 

google.golang.org/cloud/bigtable/internal/data_proto/bigtable_data.proto

It has these top-level messages: 

Row
Family
Column
Cell
RowRange
ColumnRange
TimestampRange
ValueRange
RowFilter
Mutation
ReadModifyWriteRule

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cell 

type Cell struct {
	// The cell's stored timestamp, which also uniquely identifies it within
	// its column.
	// Values are always expressed in microseconds, but individual tables may set
	// a coarser "granularity" to further restrict the allowed values. For
	// example, a table which specifies millisecond granularity will only allow
	// values of "timestamp_micros" which are multiples of 1000.
	TimestampMicros int64 `protobuf:"varint,1,opt,name=timestamp_micros" json:"timestamp_micros,omitempty"`
	// The value stored in the cell.
	// May contain any byte string, including the empty string, up to 100MiB in
	// length.
	Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// Labels applied to the cell by a [RowFilter][google.bigtable.v1.RowFilter].
	Labels []string `protobuf:"bytes,3,rep,name=labels" json:"labels,omitempty"`
}

Specifies (some of) the contents of a single row/column/timestamp of a table.

func (*Cell) ProtoMessage 

func (*Cell) ProtoMessage()

func (*Cell) Reset 

func (m *Cell) Reset()

func (*Cell) String 

func (m *Cell) String() string

type Column 

type Column struct {
	// The unique key which identifies this column within its family. This is the
	// same key that's used to identify the column in, for example, a RowFilter
	// which sets its "column_qualifier_regex_filter" field.
	// May contain any byte string, including the empty string, up to 16kiB in
	// length.
	Qualifier []byte `protobuf:"bytes,1,opt,name=qualifier,proto3" json:"qualifier,omitempty"`
	// Must not be empty. Sorted in order of decreasing "timestamp_micros".
	Cells []*Cell `protobuf:"bytes,2,rep,name=cells" json:"cells,omitempty"`
}

Specifies (some of) the contents of a single row/column of a table.

func (*Column) GetCells 

func (m *Column) GetCells() []*Cell

func (*Column) ProtoMessage 

func (*Column) ProtoMessage()

func (*Column) Reset 

func (m *Column) Reset()

func (*Column) String 

func (m *Column) String() string

type ColumnRange 

type ColumnRange struct {
	// The name of the column family within which this range falls.
	FamilyName string `protobuf:"bytes,1,opt,name=family_name" json:"family_name,omitempty"`
	// The column qualifier at which to start the range (within 'column_family').
	// If neither field is set, interpreted as the empty string, inclusive.
	//
	// Types that are valid to be assigned to StartQualifier:
	//	*ColumnRange_StartQualifierInclusive
	//	*ColumnRange_StartQualifierExclusive
	StartQualifier isColumnRange_StartQualifier `protobuf_oneof:"start_qualifier"`
	// The column qualifier at which to end the range (within 'column_family').
	// If neither field is set, interpreted as the infinite string, exclusive.
	//
	// Types that are valid to be assigned to EndQualifier:
	//	*ColumnRange_EndQualifierInclusive
	//	*ColumnRange_EndQualifierExclusive
	EndQualifier isColumnRange_EndQualifier `protobuf_oneof:"end_qualifier"`
}

Specifies a contiguous range of columns within a single column family. The range spans from <column_family>:<start_qualifier> to <column_family>:<end_qualifier>, where both bounds can be either inclusive or exclusive.

func (*ColumnRange) GetEndQualifier 

func (m *ColumnRange) GetEndQualifier() isColumnRange_EndQualifier

func (*ColumnRange) GetEndQualifierExclusive 

func (m *ColumnRange) GetEndQualifierExclusive() []byte

func (*ColumnRange) GetEndQualifierInclusive 

func (m *ColumnRange) GetEndQualifierInclusive() []byte

func (*ColumnRange) GetStartQualifier 

func (m *ColumnRange) GetStartQualifier() isColumnRange_StartQualifier

func (*ColumnRange) GetStartQualifierExclusive 

func (m *ColumnRange) GetStartQualifierExclusive() []byte

func (*ColumnRange) GetStartQualifierInclusive 

func (m *ColumnRange) GetStartQualifierInclusive() []byte

func (*ColumnRange) ProtoMessage 

func (*ColumnRange) ProtoMessage()

func (*ColumnRange) Reset 

func (m *ColumnRange) Reset()

func (*ColumnRange) String 

func (m *ColumnRange) String() string

func (*ColumnRange) XXX_OneofFuncs 

func (*ColumnRange) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type ColumnRange_EndQualifierExclusive 

type ColumnRange_EndQualifierExclusive struct {
	EndQualifierExclusive []byte `protobuf:"bytes,5,opt,name=end_qualifier_exclusive,proto3,oneof"`
}

type ColumnRange_EndQualifierInclusive 

type ColumnRange_EndQualifierInclusive struct {
	EndQualifierInclusive []byte `protobuf:"bytes,4,opt,name=end_qualifier_inclusive,proto3,oneof"`
}

type ColumnRange_StartQualifierExclusive 

type ColumnRange_StartQualifierExclusive struct {
	StartQualifierExclusive []byte `protobuf:"bytes,3,opt,name=start_qualifier_exclusive,proto3,oneof"`
}

type ColumnRange_StartQualifierInclusive 

type ColumnRange_StartQualifierInclusive struct {
	StartQualifierInclusive []byte `protobuf:"bytes,2,opt,name=start_qualifier_inclusive,proto3,oneof"`
}

type Family 

type Family struct {
	// The unique key which identifies this family within its row. This is the
	// same key that's used to identify the family in, for example, a RowFilter
	// which sets its "family_name_regex_filter" field.
	// Must match [-_.a-zA-Z0-9]+, except that AggregatingRowProcessors may
	// produce cells in a sentinel family with an empty name.
	// Must be no greater than 64 characters in length.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Must not be empty. Sorted in order of increasing "qualifier".
	Columns []*Column `protobuf:"bytes,2,rep,name=columns" json:"columns,omitempty"`
}

Specifies (some of) the contents of a single row/column family of a table.

func (*Family) GetColumns 

func (m *Family) GetColumns() []*Column

func (*Family) ProtoMessage 

func (*Family) ProtoMessage()

func (*Family) Reset 

func (m *Family) Reset()

func (*Family) String 

func (m *Family) String() string

type Mutation 

type Mutation struct {
	// Which of the possible Mutation types to apply.
	//
	// Types that are valid to be assigned to Mutation:
	//	*Mutation_SetCell_
	//	*Mutation_DeleteFromColumn_
	//	*Mutation_DeleteFromFamily_
	//	*Mutation_DeleteFromRow_
	Mutation isMutation_Mutation `protobuf_oneof:"mutation"`
}

Specifies a particular change to be made to the contents of a row.

func (*Mutation) GetDeleteFromColumn 

func (m *Mutation) GetDeleteFromColumn() *Mutation_DeleteFromColumn

func (*Mutation) GetDeleteFromFamily 

func (m *Mutation) GetDeleteFromFamily() *Mutation_DeleteFromFamily

func (*Mutation) GetDeleteFromRow 

func (m *Mutation) GetDeleteFromRow() *Mutation_DeleteFromRow

func (*Mutation) GetMutation 

func (m *Mutation) GetMutation() isMutation_Mutation

func (*Mutation) GetSetCell 

func (m *Mutation) GetSetCell() *Mutation_SetCell

func (*Mutation) ProtoMessage 

func (*Mutation) ProtoMessage()

func (*Mutation) Reset 

func (m *Mutation) Reset()

func (*Mutation) String 

func (m *Mutation) String() string

func (*Mutation) XXX_OneofFuncs 

func (*Mutation) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Mutation_DeleteFromColumn 

type Mutation_DeleteFromColumn struct {
	// The name of the family from which cells should be deleted.
	// Must match [-_.a-zA-Z0-9]+
	FamilyName string `protobuf:"bytes,1,opt,name=family_name" json:"family_name,omitempty"`
	// The qualifier of the column from which cells should be deleted.
	// Can be any byte string, including the empty string.
	ColumnQualifier []byte `protobuf:"bytes,2,opt,name=column_qualifier,proto3" json:"column_qualifier,omitempty"`
	// The range of timestamps within which cells should be deleted.
	TimeRange *TimestampRange `protobuf:"bytes,3,opt,name=time_range" json:"time_range,omitempty"`
}

A Mutation which deletes cells from the specified column, optionally restricting the deletions to a given timestamp range.

func (*Mutation_DeleteFromColumn) GetTimeRange 

func (m *Mutation_DeleteFromColumn) GetTimeRange() *TimestampRange

func (*Mutation_DeleteFromColumn) ProtoMessage 

func (*Mutation_DeleteFromColumn) ProtoMessage()

func (*Mutation_DeleteFromColumn) Reset 

func (m *Mutation_DeleteFromColumn) Reset()

func (*Mutation_DeleteFromColumn) String 

func (m *Mutation_DeleteFromColumn) String() string

type Mutation_DeleteFromColumn_ 

type Mutation_DeleteFromColumn_ struct {
	DeleteFromColumn *Mutation_DeleteFromColumn `protobuf:"bytes,2,opt,name=delete_from_column,oneof"`
}

type Mutation_DeleteFromFamily 

type Mutation_DeleteFromFamily struct {
	// The name of the family from which cells should be deleted.
	// Must match [-_.a-zA-Z0-9]+
	FamilyName string `protobuf:"bytes,1,opt,name=family_name" json:"family_name,omitempty"`
}

A Mutation which deletes all cells from the specified column family.

func (*Mutation_DeleteFromFamily) ProtoMessage 

func (*Mutation_DeleteFromFamily) ProtoMessage()

func (*Mutation_DeleteFromFamily) Reset 

func (m *Mutation_DeleteFromFamily) Reset()

func (*Mutation_DeleteFromFamily) String 

func (m *Mutation_DeleteFromFamily) String() string

type Mutation_DeleteFromFamily_ 

type Mutation_DeleteFromFamily_ struct {
	DeleteFromFamily *Mutation_DeleteFromFamily `protobuf:"bytes,3,opt,name=delete_from_family,oneof"`
}

type Mutation_DeleteFromRow 

type Mutation_DeleteFromRow struct {
}

A Mutation which deletes all cells from the containing row.

func (*Mutation_DeleteFromRow) ProtoMessage 

func (*Mutation_DeleteFromRow) ProtoMessage()

func (*Mutation_DeleteFromRow) Reset 

func (m *Mutation_DeleteFromRow) Reset()

func (*Mutation_DeleteFromRow) String 

func (m *Mutation_DeleteFromRow) String() string

type Mutation_DeleteFromRow_ 

type Mutation_DeleteFromRow_ struct {
	DeleteFromRow *Mutation_DeleteFromRow `protobuf:"bytes,4,opt,name=delete_from_row,oneof"`
}

type Mutation_SetCell 

type Mutation_SetCell struct {
	// The name of the family into which new data should be written.
	// Must match [-_.a-zA-Z0-9]+
	FamilyName string `protobuf:"bytes,1,opt,name=family_name" json:"family_name,omitempty"`
	// The qualifier of the column into which new data should be written.
	// Can be any byte string, including the empty string.
	ColumnQualifier []byte `protobuf:"bytes,2,opt,name=column_qualifier,proto3" json:"column_qualifier,omitempty"`
	// The timestamp of the cell into which new data should be written.
	// Use -1 for current Bigtable server time.
	// Otherwise, the client should set this value itself, noting that the
	// default value is a timestamp of zero if the field is left unspecified.
	// Values must match the "granularity" of the table (e.g. micros, millis).
	TimestampMicros int64 `protobuf:"varint,3,opt,name=timestamp_micros" json:"timestamp_micros,omitempty"`
	// The value to be written into the specified cell.
	Value []byte `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
}

A Mutation which sets the value of the specified cell.

func (*Mutation_SetCell) ProtoMessage 

func (*Mutation_SetCell) ProtoMessage()

func (*Mutation_SetCell) Reset 

func (m *Mutation_SetCell) Reset()

func (*Mutation_SetCell) String 

func (m *Mutation_SetCell) String() string

type Mutation_SetCell_ 

type Mutation_SetCell_ struct {
	SetCell *Mutation_SetCell `protobuf:"bytes,1,opt,name=set_cell,oneof"`
}

type ReadModifyWriteRule 

type ReadModifyWriteRule struct {
	// The name of the family to which the read/modify/write should be applied.
	// Must match [-_.a-zA-Z0-9]+
	FamilyName string `protobuf:"bytes,1,opt,name=family_name" json:"family_name,omitempty"`
	// The qualifier of the column to which the read/modify/write should be
	// applied.
	// Can be any byte string, including the empty string.
	ColumnQualifier []byte `protobuf:"bytes,2,opt,name=column_qualifier,proto3" json:"column_qualifier,omitempty"`
	// The rule used to determine the column's new latest value from its current
	// latest value.
	//
	// Types that are valid to be assigned to Rule:
	//	*ReadModifyWriteRule_AppendValue
	//	*ReadModifyWriteRule_IncrementAmount
	Rule isReadModifyWriteRule_Rule `protobuf_oneof:"rule"`
}

Specifies an atomic read/modify/write operation on the latest value of the specified column.

func (*ReadModifyWriteRule) GetAppendValue 

func (m *ReadModifyWriteRule) GetAppendValue() []byte

func (*ReadModifyWriteRule) GetIncrementAmount 

func (m *ReadModifyWriteRule) GetIncrementAmount() int64

func (*ReadModifyWriteRule) GetRule 

func (m *ReadModifyWriteRule) GetRule() isReadModifyWriteRule_Rule

func (*ReadModifyWriteRule) ProtoMessage 

func (*ReadModifyWriteRule) ProtoMessage()

func (*ReadModifyWriteRule) Reset 

func (m *ReadModifyWriteRule) Reset()

func (*ReadModifyWriteRule) String 

func (m *ReadModifyWriteRule) String() string

func (*ReadModifyWriteRule) XXX_OneofFuncs 

func (*ReadModifyWriteRule) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type ReadModifyWriteRule_AppendValue 

type ReadModifyWriteRule_AppendValue struct {
	AppendValue []byte `protobuf:"bytes,3,opt,name=append_value,proto3,oneof"`
}

type ReadModifyWriteRule_IncrementAmount 

type ReadModifyWriteRule_IncrementAmount struct {
	IncrementAmount int64 `protobuf:"varint,4,opt,name=increment_amount,oneof"`
}

type Row 

type Row struct {
	// The unique key which identifies this row within its table. This is the same
	// key that's used to identify the row in, for example, a MutateRowRequest.
	// May contain any non-empty byte string up to 4KiB in length.
	Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// May be empty, but only if the entire row is empty.
	// The mutual ordering of column families is not specified.
	Families []*Family `protobuf:"bytes,2,rep,name=families" json:"families,omitempty"`
}

Specifies the complete (requested) contents of a single row of a table. Rows which exceed 256MiB in size cannot be read in full.

func (*Row) GetFamilies 

func (m *Row) GetFamilies() []*Family

func (*Row) ProtoMessage 

func (*Row) ProtoMessage()

func (*Row) Reset 

func (m *Row) Reset()

func (*Row) String 

func (m *Row) String() string

type RowFilter 

type RowFilter struct {
	// Which of the possible RowFilter types to apply. If none are set, this
	// RowFilter returns all cells in the input row.
	//
	// Types that are valid to be assigned to Filter:
	//	*RowFilter_Chain_
	//	*RowFilter_Interleave_
	//	*RowFilter_Condition_
	//	*RowFilter_Sink
	//	*RowFilter_PassAllFilter
	//	*RowFilter_BlockAllFilter
	//	*RowFilter_RowKeyRegexFilter
	//	*RowFilter_RowSampleFilter
	//	*RowFilter_FamilyNameRegexFilter
	//	*RowFilter_ColumnQualifierRegexFilter
	//	*RowFilter_ColumnRangeFilter
	//	*RowFilter_TimestampRangeFilter
	//	*RowFilter_ValueRegexFilter
	//	*RowFilter_ValueRangeFilter
	//	*RowFilter_CellsPerRowOffsetFilter
	//	*RowFilter_CellsPerRowLimitFilter
	//	*RowFilter_CellsPerColumnLimitFilter
	//	*RowFilter_StripValueTransformer
	//	*RowFilter_ApplyLabelTransformer
	Filter isRowFilter_Filter `protobuf_oneof:"filter"`
}

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.

func (*RowFilter) GetApplyLabelTransformer 

func (m *RowFilter) GetApplyLabelTransformer() string

func (*RowFilter) GetBlockAllFilter 

func (m *RowFilter) GetBlockAllFilter() bool

func (*RowFilter) GetCellsPerColumnLimitFilter 

func (m *RowFilter) GetCellsPerColumnLimitFilter() int32

func (*RowFilter) GetCellsPerRowLimitFilter 

func (m *RowFilter) GetCellsPerRowLimitFilter() int32

func (*RowFilter) GetCellsPerRowOffsetFilter 

func (m *RowFilter) GetCellsPerRowOffsetFilter() int32

func (*RowFilter) GetChain 

func (m *RowFilter) GetChain() *RowFilter_Chain

func (*RowFilter) GetColumnQualifierRegexFilter 

func (m *RowFilter) GetColumnQualifierRegexFilter() []byte

func (*RowFilter) GetColumnRangeFilter 

func (m *RowFilter) GetColumnRangeFilter() *ColumnRange

func (*RowFilter) GetCondition 

func (m *RowFilter) GetCondition() *RowFilter_Condition

func (*RowFilter) GetFamilyNameRegexFilter 

func (m *RowFilter) GetFamilyNameRegexFilter() string

func (*RowFilter) GetFilter 

func (m *RowFilter) GetFilter() isRowFilter_Filter

func (*RowFilter) GetInterleave 

func (m *RowFilter) GetInterleave() *RowFilter_Interleave

func (*RowFilter) GetPassAllFilter 

func (m *RowFilter) GetPassAllFilter() bool

func (*RowFilter) GetRowKeyRegexFilter 

func (m *RowFilter) GetRowKeyRegexFilter() []byte

func (*RowFilter) GetRowSampleFilter 

func (m *RowFilter) GetRowSampleFilter() float64

func (*RowFilter) GetSink 

func (m *RowFilter) GetSink() bool

func (*RowFilter) GetStripValueTransformer 

func (m *RowFilter) GetStripValueTransformer() bool

func (*RowFilter) GetTimestampRangeFilter 

func (m *RowFilter) GetTimestampRangeFilter() *TimestampRange

func (*RowFilter) GetValueRangeFilter 

func (m *RowFilter) GetValueRangeFilter() *ValueRange

func (*RowFilter) GetValueRegexFilter 

func (m *RowFilter) GetValueRegexFilter() []byte

func (*RowFilter) ProtoMessage 

func (*RowFilter) ProtoMessage()

func (*RowFilter) Reset 

func (m *RowFilter) Reset()

func (*RowFilter) String 

func (m *RowFilter) String() string

func (*RowFilter) XXX_OneofFuncs 

func (*RowFilter) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type RowFilter_ApplyLabelTransformer 

type RowFilter_ApplyLabelTransformer struct {
	ApplyLabelTransformer string `protobuf:"bytes,19,opt,name=apply_label_transformer,oneof"`
}

type RowFilter_BlockAllFilter 

type RowFilter_BlockAllFilter struct {
	BlockAllFilter bool `protobuf:"varint,18,opt,name=block_all_filter,oneof"`
}

type RowFilter_CellsPerColumnLimitFilter 

type RowFilter_CellsPerColumnLimitFilter struct {
	CellsPerColumnLimitFilter int32 `protobuf:"varint,12,opt,name=cells_per_column_limit_filter,oneof"`
}

type RowFilter_CellsPerRowLimitFilter 

type RowFilter_CellsPerRowLimitFilter struct {
	CellsPerRowLimitFilter int32 `protobuf:"varint,11,opt,name=cells_per_row_limit_filter,oneof"`
}

type RowFilter_CellsPerRowOffsetFilter 

type RowFilter_CellsPerRowOffsetFilter struct {
	CellsPerRowOffsetFilter int32 `protobuf:"varint,10,opt,name=cells_per_row_offset_filter,oneof"`
}

type RowFilter_Chain 

type RowFilter_Chain struct {
	// 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.
	Filters []*RowFilter `protobuf:"bytes,1,rep,name=filters" json:"filters,omitempty"`
}

A RowFilter which sends rows through several RowFilters in sequence.

func (*RowFilter_Chain) GetFilters 

func (m *RowFilter_Chain) GetFilters() []*RowFilter

func (*RowFilter_Chain) ProtoMessage 

func (*RowFilter_Chain) ProtoMessage()

func (*RowFilter_Chain) Reset 

func (m *RowFilter_Chain) Reset()

func (*RowFilter_Chain) String 

func (m *RowFilter_Chain) String() string

type RowFilter_Chain_ 

type RowFilter_Chain_ struct {
	Chain *RowFilter_Chain `protobuf:"bytes,1,opt,name=chain,oneof"`
}

type RowFilter_ColumnQualifierRegexFilter 

type RowFilter_ColumnQualifierRegexFilter struct {
	ColumnQualifierRegexFilter []byte `protobuf:"bytes,6,opt,name=column_qualifier_regex_filter,proto3,oneof"`
}

type RowFilter_ColumnRangeFilter 

type RowFilter_ColumnRangeFilter struct {
	ColumnRangeFilter *ColumnRange `protobuf:"bytes,7,opt,name=column_range_filter,oneof"`
}

type RowFilter_Condition 

type RowFilter_Condition struct {
	// If "predicate_filter" outputs any cells, then "true_filter" will be
	// evaluated on the input row. Otherwise, "false_filter" will be evaluated.
	PredicateFilter *RowFilter `protobuf:"bytes,1,opt,name=predicate_filter" json:"predicate_filter,omitempty"`
	// 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.
	TrueFilter *RowFilter `protobuf:"bytes,2,opt,name=true_filter" json:"true_filter,omitempty"`
	// 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.
	FalseFilter *RowFilter `protobuf:"bytes,3,opt,name=false_filter" json:"false_filter,omitempty"`
}

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.

func (*RowFilter_Condition) GetFalseFilter 

func (m *RowFilter_Condition) GetFalseFilter() *RowFilter

func (*RowFilter_Condition) GetPredicateFilter 

func (m *RowFilter_Condition) GetPredicateFilter() *RowFilter

func (*RowFilter_Condition) GetTrueFilter 

func (m *RowFilter_Condition) GetTrueFilter() *RowFilter

func (*RowFilter_Condition) ProtoMessage 

func (*RowFilter_Condition) ProtoMessage()

func (*RowFilter_Condition) Reset 

func (m *RowFilter_Condition) Reset()

func (*RowFilter_Condition) String 

func (m *RowFilter_Condition) String() string

type RowFilter_Condition_ 

type RowFilter_Condition_ struct {
	Condition *RowFilter_Condition `protobuf:"bytes,3,opt,name=condition,oneof"`
}

type RowFilter_FamilyNameRegexFilter 

type RowFilter_FamilyNameRegexFilter struct {
	FamilyNameRegexFilter string `protobuf:"bytes,5,opt,name=family_name_regex_filter,oneof"`
}

type RowFilter_Interleave 

type RowFilter_Interleave struct {
	// 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.
	Filters []*RowFilter `protobuf:"bytes,1,rep,name=filters" json:"filters,omitempty"`
}

A RowFilter which sends each row to each of several component RowFilters and interleaves the results.

func (*RowFilter_Interleave) GetFilters 

func (m *RowFilter_Interleave) GetFilters() []*RowFilter

func (*RowFilter_Interleave) ProtoMessage 

func (*RowFilter_Interleave) ProtoMessage()

func (*RowFilter_Interleave) Reset 

func (m *RowFilter_Interleave) Reset()

func (*RowFilter_Interleave) String 

func (m *RowFilter_Interleave) String() string

type RowFilter_Interleave_ 

type RowFilter_Interleave_ struct {
	Interleave *RowFilter_Interleave `protobuf:"bytes,2,opt,name=interleave,oneof"`
}

type RowFilter_PassAllFilter 

type RowFilter_PassAllFilter struct {
	PassAllFilter bool `protobuf:"varint,17,opt,name=pass_all_filter,oneof"`
}

type RowFilter_RowKeyRegexFilter 

type RowFilter_RowKeyRegexFilter struct {
	RowKeyRegexFilter []byte `protobuf:"bytes,4,opt,name=row_key_regex_filter,proto3,oneof"`
}

type RowFilter_RowSampleFilter 

type RowFilter_RowSampleFilter struct {
	RowSampleFilter float64 `protobuf:"fixed64,14,opt,name=row_sample_filter,oneof"`
}

type RowFilter_Sink 

type RowFilter_Sink struct {
	Sink bool `protobuf:"varint,16,opt,name=sink,oneof"`
}

type RowFilter_StripValueTransformer 

type RowFilter_StripValueTransformer struct {
	StripValueTransformer bool `protobuf:"varint,13,opt,name=strip_value_transformer,oneof"`
}

type RowFilter_TimestampRangeFilter 

type RowFilter_TimestampRangeFilter struct {
	TimestampRangeFilter *TimestampRange `protobuf:"bytes,8,opt,name=timestamp_range_filter,oneof"`
}

type RowFilter_ValueRangeFilter 

type RowFilter_ValueRangeFilter struct {
	ValueRangeFilter *ValueRange `protobuf:"bytes,15,opt,name=value_range_filter,oneof"`
}

type RowFilter_ValueRegexFilter 

type RowFilter_ValueRegexFilter struct {
	ValueRegexFilter []byte `protobuf:"bytes,9,opt,name=value_regex_filter,proto3,oneof"`
}

type RowRange 

type RowRange struct {
	// Inclusive lower bound. If left empty, interpreted as the empty string.
	StartKey []byte `protobuf:"bytes,2,opt,name=start_key,proto3" json:"start_key,omitempty"`
	// Exclusive upper bound. If left empty, interpreted as infinity.
	EndKey []byte `protobuf:"bytes,3,opt,name=end_key,proto3" json:"end_key,omitempty"`
}

Specifies a contiguous range of rows.

func (*RowRange) ProtoMessage 

func (*RowRange) ProtoMessage()

func (*RowRange) Reset 

func (m *RowRange) Reset()

func (*RowRange) String 

func (m *RowRange) String() string

type TimestampRange 

type TimestampRange struct {
	// Inclusive lower bound. If left empty, interpreted as 0.
	StartTimestampMicros int64 `protobuf:"varint,1,opt,name=start_timestamp_micros" json:"start_timestamp_micros,omitempty"`
	// Exclusive upper bound. If left empty, interpreted as infinity.
	EndTimestampMicros int64 `protobuf:"varint,2,opt,name=end_timestamp_micros" json:"end_timestamp_micros,omitempty"`
}

Specified a contiguous range of microsecond timestamps.

func (*TimestampRange) ProtoMessage 

func (*TimestampRange) ProtoMessage()

func (*TimestampRange) Reset 

func (m *TimestampRange) Reset()

func (*TimestampRange) String 

func (m *TimestampRange) String() string

type ValueRange 

type ValueRange struct {
	// The value at which to start the range.
	// If neither field is set, interpreted as the empty string, inclusive.
	//
	// Types that are valid to be assigned to StartValue:
	//	*ValueRange_StartValueInclusive
	//	*ValueRange_StartValueExclusive
	StartValue isValueRange_StartValue `protobuf_oneof:"start_value"`
	// The value at which to end the range.
	// If neither field is set, interpreted as the infinite string, exclusive.
	//
	// Types that are valid to be assigned to EndValue:
	//	*ValueRange_EndValueInclusive
	//	*ValueRange_EndValueExclusive
	EndValue isValueRange_EndValue `protobuf_oneof:"end_value"`
}

Specifies a contiguous range of raw byte values.

func (*ValueRange) GetEndValue 

func (m *ValueRange) GetEndValue() isValueRange_EndValue

func (*ValueRange) GetEndValueExclusive 

func (m *ValueRange) GetEndValueExclusive() []byte

func (*ValueRange) GetEndValueInclusive 

func (m *ValueRange) GetEndValueInclusive() []byte

func (*ValueRange) GetStartValue 

func (m *ValueRange) GetStartValue() isValueRange_StartValue

func (*ValueRange) GetStartValueExclusive 

func (m *ValueRange) GetStartValueExclusive() []byte

func (*ValueRange) GetStartValueInclusive 

func (m *ValueRange) GetStartValueInclusive() []byte

func (*ValueRange) ProtoMessage 

func (*ValueRange) ProtoMessage()

func (*ValueRange) Reset 

func (m *ValueRange) Reset()

func (*ValueRange) String 

func (m *ValueRange) String() string

func (*ValueRange) XXX_OneofFuncs 

func (*ValueRange) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type ValueRange_EndValueExclusive 

type ValueRange_EndValueExclusive struct {
	EndValueExclusive []byte `protobuf:"bytes,4,opt,name=end_value_exclusive,proto3,oneof"`
}

type ValueRange_EndValueInclusive 

type ValueRange_EndValueInclusive struct {
	EndValueInclusive []byte `protobuf:"bytes,3,opt,name=end_value_inclusive,proto3,oneof"`
}

type ValueRange_StartValueExclusive 

type ValueRange_StartValueExclusive struct {
	StartValueExclusive []byte `protobuf:"bytes,2,opt,name=start_value_exclusive,proto3,oneof"`
}

type ValueRange_StartValueInclusive 

type ValueRange_StartValueInclusive struct {
	StartValueInclusive []byte `protobuf:"bytes,1,opt,name=start_value_inclusive,proto3,oneof"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.