http4s-grpc-google-cloud-bigtable-v2
2.23.3+0.0.5
API
Generated with
http4s-grpc-google-cloud-bigtable-v2/com.google.bigtable.v2/com.google.bigtable.v2.data

com.google.bigtable.v2.data

package com.google.bigtable.v2.data

Members list

Type members

Classlikes

final case class Cell(timestampMicros: Long, value: ByteString, labels: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Cell]

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

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

Value parameters

labels

Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter].

timestampMicros

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.

value

The value stored in the cell. May contain any byte string, including the empty string, up to 100MiB in length.

Attributes

Companion
object
Source
Cell.scala
Supertypes
trait Updatable[Cell]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Cell extends GeneratedMessageCompanion[Cell]

Attributes

Companion
class
Source
Cell.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Cell]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Cell.type
final case class Column(qualifier: ByteString, cells: Seq[Cell], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Column]

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

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

Value parameters

cells

Must not be empty. Sorted in order of decreasing "timestamp_micros".

qualifier

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.

Attributes

Companion
object
Source
Column.scala
Supertypes
trait Updatable[Column]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Column extends GeneratedMessageCompanion[Column]

Attributes

Companion
class
Source
Column.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Column]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Column.type
final case class ColumnRange(familyName: String, startQualifier: StartQualifier, endQualifier: EndQualifier, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ColumnRange]

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.

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.

Value parameters

familyName

The name of the column family within which this range falls.

Attributes

Companion
object
Source
ColumnRange.scala
Supertypes
trait Updatable[ColumnRange]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ColumnRange extends GeneratedMessageCompanion[ColumnRange]

Attributes

Companion
class
Source
ColumnRange.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ColumnRange]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object DataProto extends GeneratedFileObject

Attributes

Source
DataProto.scala
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
DataProto.type
final case class Family(name: String, columns: Seq[Column], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Family]

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

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

Value parameters

columns

Must not be empty. Sorted in order of increasing "qualifier".

name

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.

Attributes

Companion
object
Source
Family.scala
Supertypes
trait Updatable[Family]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Family extends GeneratedMessageCompanion[Family]

Attributes

Companion
class
Source
Family.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Family]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Family.type
final case class Mutation(mutation: Mutation, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Mutation]

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

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

Attributes

Companion
object
Source
Mutation.scala
Supertypes
trait Updatable[Mutation]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Mutation extends GeneratedMessageCompanion[Mutation]

Attributes

Companion
class
Source
Mutation.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Mutation]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Mutation.type
final case class ReadModifyWriteRule(familyName: String, columnQualifier: ByteString, rule: Rule, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ReadModifyWriteRule]

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

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

Value parameters

columnQualifier

The qualifier of the column to which the read/modify/write should be applied. Can be any byte string, including the empty string.

familyName

The name of the family to which the read/modify/write should be applied. Must match [-_.a-zA-Z0-9]+

Attributes

Companion
object
Source
ReadModifyWriteRule.scala
Supertypes
trait Updatable[ReadModifyWriteRule]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ReadModifyWriteRule extends GeneratedMessageCompanion[ReadModifyWriteRule]

Attributes

Companion
class
Source
ReadModifyWriteRule.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ReadModifyWriteRule]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class Row(key: ByteString, families: Seq[Family], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Row]

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

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

Value parameters

families

May be empty, but only if the entire row is empty. The mutual ordering of column families is not specified.

key

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.

Attributes

Companion
object
Source
Row.scala
Supertypes
trait Updatable[Row]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Row extends GeneratedMessageCompanion[Row]

Attributes

Companion
class
Source
Row.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Row]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Row.type
final case class RowFilter(filter: Filter, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RowFilter]

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

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([^&92;n]), meaning that it does not match newlines. When attempting to match an arbitrary byte, you should therefore use the escape sequence &92;C, which may need to be further escaped as &92;&92;C in your client language.

  • Transformers alter the input row by changing the values of some of its cells in the output, without excluding them completely. Currently, the only supported transformer is the strip_value_transformer, which replaces every cell's value with the empty string.

  • Chains and interleaves are described in more detail in the RowFilter.Chain and RowFilter.Interleave documentation.

The total serialized size of a RowFilter message must not exceed 20480 bytes, and RowFilters may not be nested within each other (in Chains or Interleaves) to a depth of more than 20.

Attributes

Companion
object
Source
RowFilter.scala
Supertypes
trait Updatable[RowFilter]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RowFilter extends GeneratedMessageCompanion[RowFilter]

Attributes

Companion
class
Source
RowFilter.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RowFilter]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
RowFilter.type
final case class RowRange(startKey: StartKey, endKey: EndKey, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RowRange]

Specifies a contiguous range of rows.

Specifies a contiguous range of rows.

Attributes

Companion
object
Source
RowRange.scala
Supertypes
trait Updatable[RowRange]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RowRange extends GeneratedMessageCompanion[RowRange]

Attributes

Companion
class
Source
RowRange.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RowRange]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
RowRange.type
final case class RowSet(rowKeys: Seq[ByteString], rowRanges: Seq[RowRange], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RowSet]

Specifies a non-contiguous set of rows.

Specifies a non-contiguous set of rows.

Value parameters

rowKeys

Single rows included in the set.

rowRanges

Contiguous row ranges included in the set.

Attributes

Companion
object
Source
RowSet.scala
Supertypes
trait Updatable[RowSet]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RowSet extends GeneratedMessageCompanion[RowSet]

Attributes

Companion
class
Source
RowSet.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RowSet]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
RowSet.type
final case class StreamContinuationToken(partition: Option[StreamPartition], token: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[StreamContinuationToken]

NOTE: This API is intended to be used by Apache Beam BigtableIO. The information required to continue reading the data from a StreamPartition from where a previous read left off.

NOTE: This API is intended to be used by Apache Beam BigtableIO. The information required to continue reading the data from a StreamPartition from where a previous read left off.

Value parameters

partition

The partition that this token applies to.

token

An encoded position in the stream to restart reading from.

Attributes

Companion
object
Source
StreamContinuationToken.scala
Supertypes
trait Updatable[StreamContinuationToken]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StreamContinuationToken extends GeneratedMessageCompanion[StreamContinuationToken]

Attributes

Companion
class
Source
StreamContinuationToken.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[StreamContinuationToken]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class StreamContinuationTokens(tokens: Seq[StreamContinuationToken], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[StreamContinuationTokens]

NOTE: This API is intended to be used by Apache Beam BigtableIO. The information required to continue reading the data from multiple StreamPartitions from where a previous read left off.

NOTE: This API is intended to be used by Apache Beam BigtableIO. The information required to continue reading the data from multiple StreamPartitions from where a previous read left off.

Value parameters

tokens

List of continuation tokens.

Attributes

Companion
object
Source
StreamContinuationTokens.scala
Supertypes
trait Updatable[StreamContinuationTokens]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StreamContinuationTokens extends GeneratedMessageCompanion[StreamContinuationTokens]

Attributes

Companion
class
Source
StreamContinuationTokens.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[StreamContinuationTokens]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class StreamPartition(rowRange: Option[RowRange], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[StreamPartition]

NOTE: This API is intended to be used by Apache Beam BigtableIO. A partition of a change stream.

NOTE: This API is intended to be used by Apache Beam BigtableIO. A partition of a change stream.

Value parameters

rowRange

The row range covered by this partition and is specified by [start_key_closed, end_key_open).

Attributes

Companion
object
Source
StreamPartition.scala
Supertypes
trait Updatable[StreamPartition]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StreamPartition extends GeneratedMessageCompanion[StreamPartition]

Attributes

Companion
class
Source
StreamPartition.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[StreamPartition]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class TimestampRange(startTimestampMicros: Long, endTimestampMicros: Long, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TimestampRange]

Specified a contiguous range of microsecond timestamps.

Specified a contiguous range of microsecond timestamps.

Value parameters

endTimestampMicros

Exclusive upper bound. If left empty, interpreted as infinity.

startTimestampMicros

Inclusive lower bound. If left empty, interpreted as 0.

Attributes

Companion
object
Source
TimestampRange.scala
Supertypes
trait Updatable[TimestampRange]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TimestampRange extends GeneratedMessageCompanion[TimestampRange]

Attributes

Companion
class
Source
TimestampRange.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TimestampRange]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ValueRange(startValue: StartValue, endValue: EndValue, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ValueRange]

Specifies a contiguous range of raw byte values.

Specifies a contiguous range of raw byte values.

Attributes

Companion
object
Source
ValueRange.scala
Supertypes
trait Updatable[ValueRange]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ValueRange extends GeneratedMessageCompanion[ValueRange]

Attributes

Companion
class
Source
ValueRange.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ValueRange]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
ValueRange.type
Generated with