Classes
Bigtable
Service for reading from and writing to existing Bigtable tables.
Bigtable.BigtableBase
Base class for server-side implementations of Bigtable
Bigtable.BigtableClient
Client for Bigtable
BigtableClient
BigtableServiceApi client wrapper, for convenient use.
BigtableClientBuilder
Builder class for BigtableClient to provide simple configuration of credentials, endpoint etc.
BigtableClientImpl
BigtableServiceApi client wrapper, for convenient use.
BigtableServiceApiClient
BigtableServiceApi client wrapper, for convenient use.
BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream
Server streaming methods for GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest, CallSettings) .
BigtableServiceApiClient.MutateRowsStream
Server streaming methods for MutateRows(MutateRowsRequest, CallSettings).
BigtableServiceApiClient.ReadChangeStreamStream
Server streaming methods for ReadChangeStream(ReadChangeStreamRequest, CallSettings).
BigtableServiceApiClient.ReadRowsStream
Server streaming methods for ReadRows(ReadRowsRequest, CallSettings).
BigtableServiceApiClient.SampleRowKeysStream
Server streaming methods for SampleRowKeys(SampleRowKeysRequest, CallSettings).
BigtableServiceApiClientBuilder
Builder class for BigtableServiceApiClient to provide simple configuration of credentials, endpoint etc.
BigtableServiceApiClientImpl
BigtableServiceApi client wrapper implementation, for convenient use.
BigtableServiceApiSettings
Settings for BigtableServiceApiClient instances.
BigtableServiceApiSettingsExtensions
Extensions for use on BigtableServiceApiSettings.
BigtableVersionRange
A contiguous range of versions.
Cell
Specifies (some of) the contents of a single row/column/timestamp of a table.
CheckAndMutateRowRequest
Request message for Bigtable.CheckAndMutateRow.
CheckAndMutateRowResponse
Response message for Bigtable.CheckAndMutateRow.
Column
Specifies (some of) the contents of a single row/column intersection of a table.
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.
Family
Specifies (some of) the contents of a single row/column family intersection of a table.
FeatureFlags
Feature flags supported or enabled by a client.
This is intended to be sent as part of request metadata to assure the server
that certain behaviors are safe to enable. This proto is meant to be
serialized and websafe-base64 encoded under the bigtable-features
metadata
key. The value will remain constant for the lifetime of a client and due to
HTTP2's HPACK compression, the request overhead will be tiny.
This is an internal implementation detail and should not be used by end users
directly.
FullReadStatsView
FullReadStatsView captures all known information about a read.
GenerateInitialChangeStreamPartitionsRequest
NOTE: This API is intended to be used by Apache Beam BigtableIO. Request message for Bigtable.GenerateInitialChangeStreamPartitions.
GenerateInitialChangeStreamPartitionsResponse
NOTE: This API is intended to be used by Apache Beam BigtableIO. Response message for Bigtable.GenerateInitialChangeStreamPartitions.
MutateRowRequest
Request message for Bigtable.MutateRow.
MutateRowResponse
Response message for Bigtable.MutateRow.
MutateRowsRequest
Request message for BigtableService.MutateRows.
MutateRowsRequest.Types
Container for nested types declared in the MutateRowsRequest message type.
MutateRowsRequest.Types.Entry
A mutation for a given row.
MutateRowsResponse
Response message for BigtableService.MutateRows.
MutateRowsResponse.Types
Container for nested types declared in the MutateRowsResponse message type.
MutateRowsResponse.Types.Entry
The result of applying a passed mutation in the original request.
Mutation
Specifies a particular change to be made to the contents of a row.
Mutation.Types
Container for nested types declared in the Mutation message type.
Mutation.Types.DeleteFromColumn
A Mutation which deletes cells from the specified column, optionally restricting the deletions to a given timestamp range.
Mutation.Types.DeleteFromFamily
A Mutation which deletes all cells from the specified column family.
Mutation.Types.DeleteFromRow
A Mutation which deletes all cells from the containing row.
Mutation.Types.SetCell
A Mutation which sets the value of the specified cell.
Mutations
Static class with convenience methods for creating various kinds of Mutation instances.
PingAndWarmRequest
Request message for client connection keep-alive and warming.
PingAndWarmResponse
Response message for Bigtable.PingAndWarm connection keepalive and warming.
RateLimitInfo
Information about how client should adjust the load to Bigtable.
ReadChangeStreamRequest
NOTE: This API is intended to be used by Apache Beam BigtableIO. Request message for Bigtable.ReadChangeStream.
ReadChangeStreamResponse
NOTE: This API is intended to be used by Apache Beam BigtableIO. Response message for Bigtable.ReadChangeStream.
ReadChangeStreamResponse.Types
Container for nested types declared in the ReadChangeStreamResponse message type.
ReadChangeStreamResponse.Types.CloseStream
A message indicating that the client should stop reading from the stream.
If status is OK and continuation_tokens
& new_partitions
are empty, the
stream has finished (for example if there was an end_time
specified).
If continuation_tokens
& new_partitions
are present, then a change in
partitioning requires the client to open a new stream for each token to
resume reading. Example:
[B, D) ends
|
v
new_partitions: [A, C) [C, E)
continuation_tokens.partitions: [B,C) [C,D)
^---^ ^---^
^ ^
| |
| StreamContinuationToken 2
|
StreamContinuationToken 1
To read the new partition [A,C), supply the continuation tokens whose
ranges cover the new partition, for example ContinuationToken[A,B) &
ContinuationToken[B,C).
ReadChangeStreamResponse.Types.DataChange
A message corresponding to one or more mutations to the partition
being streamed. A single logical DataChange
message may also be split
across a sequence of multiple individual messages. Messages other than
the first in a sequence will only have the type
and chunks
fields
populated, with the final message in the sequence also containing done
set to true.
ReadChangeStreamResponse.Types.DataChange.Types
Container for nested types declared in the DataChange message type.
ReadChangeStreamResponse.Types.Heartbeat
A periodic message with information that can be used to checkpoint the state of a stream.
ReadChangeStreamResponse.Types.MutationChunk
A partial or complete mutation.
ReadChangeStreamResponse.Types.MutationChunk.Types
Container for nested types declared in the MutationChunk message type.
ReadChangeStreamResponse.Types.MutationChunk.Types.ChunkInfo
Information about the chunking of this mutation.
Only SetCell
mutations can be chunked, and all chunks for a SetCell
will be delivered contiguously with no other mutation types interleaved.
ReadIterationStats
ReadIterationStats captures information about the iteration of rows or cells over the course of a read, e.g. how many results were scanned in a read operation versus the results returned.
ReadModifyWriteRowRequest
Request message for Bigtable.ReadModifyWriteRow.
ReadModifyWriteRowResponse
Response message for Bigtable.ReadModifyWriteRow.
ReadModifyWriteRule
Specifies an atomic read/modify/write operation on the latest value of the specified column.
ReadModifyWriteRules
Static class with convenience methods for creating various kinds of ReadModifyWriteRule instances.
ReadRowsRequest
Request message for Bigtable.ReadRows.
ReadRowsRequest.Types
Container for nested types declared in the ReadRowsRequest message type.
ReadRowsResponse
Response message for Bigtable.ReadRows.
ReadRowsResponse.Types
Container for nested types declared in the ReadRowsResponse message type.
ReadRowsResponse.Types.CellChunk
Specifies a piece of a row's contents returned as part of the read response stream.
ReadRowsStream
The stream of Row instances returned from the server.
RequestLatencyStats
RequestLatencyStats provides a measurement of the latency of the request as it interacts with different systems over its lifetime, e.g. how long the request took to execute within a frontend server.
RequestStats
RequestStats is the container for additional information pertaining to a single request, helpful for evaluating the performance of the sent request. Currently, there are the following supported methods:
- google.bigtable.v2.ReadRows
ResponseParams
Response metadata proto This is an experimental feature that will be used to get zone_id and cluster_id from response trailers to tag the metrics. This should not be used by customers directly
Row
Specifies the complete (requested) contents of a single row of a table. Rows which exceed 256MiB in size cannot be read in full.
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."
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 thatRE2(.)
is equivalent by default toRE2([^\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 20480 bytes, and RowFilters may not be nested within each other (in Chains or Interleaves) to a depth of more than 20.
RowFilter.Types
Container for nested types declared in the RowFilter message type.
RowFilter.Types.Chain
A RowFilter which sends rows through several RowFilters in sequence.
RowFilter.Types.Condition
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.
RowFilter.Types.Interleave
A RowFilter which sends each row to each of several component RowFilters and interleaves the results.
RowFilters
Static class with convenience methods for creating various kinds of RowFilter instances.
RowRange
Specifies a contiguous range of rows.
RowSet
Specifies a non-contiguous set of rows.
SampleRowKeysRequest
Request message for Bigtable.SampleRowKeys.
SampleRowKeysResponse
Response message for Bigtable.SampleRowKeys.
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.
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.
StreamPartition
NOTE: This API is intended to be used by Apache Beam BigtableIO. A partition of a change stream.
TimestampRange
Specified a contiguous range of microsecond timestamps.
ValueRange
Specifies a contiguous range of raw byte values.
Structs
BigtableVersion
A version which uniquely identifies a cell within a column.
Enums
ColumnRange.EndQualifierOneofCase
Enum of possible cases for the "end_qualifier" oneof.
ColumnRange.StartQualifierOneofCase
Enum of possible cases for the "start_qualifier" oneof.
Mutation.MutationOneofCase
Enum of possible cases for the "mutation" oneof.
ReadChangeStreamRequest.StartFromOneofCase
Enum of possible cases for the "start_from" oneof.
ReadChangeStreamResponse.StreamRecordOneofCase
Enum of possible cases for the "stream_record" oneof.
ReadChangeStreamResponse.Types.DataChange.Types.Type
The type of mutation.
ReadModifyWriteRule.RuleOneofCase
Enum of possible cases for the "rule" oneof.
ReadRowsRequest.Types.RequestStatsView
The desired view into RequestStats that should be returned in the response.
See also: RequestStats message.
ReadRowsResponse.Types.CellChunk.RowStatusOneofCase
Enum of possible cases for the "row_status" oneof.
RequestStats.StatsViewOneofCase
Enum of possible cases for the "stats_view" oneof.
RowFilter.FilterOneofCase
Enum of possible cases for the "filter" oneof.
RowRange.EndKeyOneofCase
Enum of possible cases for the "end_key" oneof.
RowRange.StartKeyOneofCase
Enum of possible cases for the "start_key" oneof.
ValueRange.EndValueOneofCase
Enum of possible cases for the "end_value" oneof.
ValueRange.StartValueOneofCase
Enum of possible cases for the "start_value" oneof.