Package com.google.cloud.bigtable.data.v2.models (2.51.0)
| GitHub Repository |
This package is not the recommended entry point to using this client library!
For this library, we recommend using com.google.cloud.bigtable for new applications.
Classes
| Class | Description |
|---|---|
| com.google.cloud.bigtable.data.v2.models.AddToCell | Representation of an AddToCell mod in a data change. |
| com.google.cloud.bigtable.data.v2.models.AuthorizedViewId |
An implementation of a TargetId for authorized views.
See com.google.cloud.bigtable.admin.v2.models.AuthorizedView for more details about an authorized view. |
| com.google.cloud.bigtable.data.v2.models.BulkMutation |
Represents a list of mutations for multiple rows. Each mutation contains multiple changes that
will be atomically applied to each row. However, ordering between rows is not guaranteed.
This class is meant for manual batching. |
| com.google.cloud.bigtable.data.v2.models.ChangeStreamContinuationToken | A simple wrapper for StreamContinuationToken. |
| com.google.cloud.bigtable.data.v2.models.ChangeStreamMutation | A ChangeStreamMutation represents a list of mods(represented by List<Entry>) targeted at a single row, which is concatenated by ChangeStreamRecordMerger. It represents a logical row mutation and can be converted to the original write request(i.e. RowMutation or RowMutationEntry. |
| com.google.cloud.bigtable.data.v2.models.CloseStream | A simple wrapper for ReadChangeStreamResponse.CloseStream. This message is received when the stream reading is finished(i.e. read past the stream end time), or an error has occurred. |
| com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation | Mutates a row atomically based on the output of a condition filter. |
| com.google.cloud.bigtable.data.v2.models.DefaultChangeStreamRecordAdapter | Default implementation of a ChangeStreamRecordAdapter that uses ChangeStreamRecords to represent change stream records. |
| com.google.cloud.bigtable.data.v2.models.DefaultRowAdapter | Default implementation of a RowAdapter that uses Rows to represent logical rows. |
| com.google.cloud.bigtable.data.v2.models.DefaultRowAdapter.DefaultRowBuilder | Internal implementation detail for DefaultRowAdapter. |
| com.google.cloud.bigtable.data.v2.models.DeleteCells | Representation of a DeleteCells mod in a data change. |
| com.google.cloud.bigtable.data.v2.models.DeleteFamily | Representation of a DeleteFamily mod in a data change. |
| com.google.cloud.bigtable.data.v2.models.Filters |
A Fluent DSL to create a hierarchy of filters for the CheckAndMutateRow RPCs and ReadRows Query.
Intended usage is to statically import, or in case of conflict, assign the static variable FILTERS and use its fluent API to build filters. |
| com.google.cloud.bigtable.data.v2.models.Filters.ChainFilter | DSL for adding filters to a chain. |
| com.google.cloud.bigtable.data.v2.models.Filters.ConditionFilter | DSL for configuring a conditional filter. |
| com.google.cloud.bigtable.data.v2.models.Filters.FamilyFilter | |
| com.google.cloud.bigtable.data.v2.models.Filters.InterleaveFilter | DSL for adding filters to the interleave list. |
| com.google.cloud.bigtable.data.v2.models.Filters.KeyFilter | |
| com.google.cloud.bigtable.data.v2.models.Filters.LimitFilter | |
| com.google.cloud.bigtable.data.v2.models.Filters.OffsetFilter | |
| com.google.cloud.bigtable.data.v2.models.Filters.QualifierFilter | |
| com.google.cloud.bigtable.data.v2.models.Filters.QualifierRangeFilter | Matches only cells from columns within the given range. |
| com.google.cloud.bigtable.data.v2.models.Filters.TimestampFilter | |
| com.google.cloud.bigtable.data.v2.models.Filters.TimestampRangeFilter | Matches only cells with microsecond timestamps within the given range. |
| com.google.cloud.bigtable.data.v2.models.Filters.ValueFilter | |
| com.google.cloud.bigtable.data.v2.models.Filters.ValueRangeFilter | Matches only cells with values that fall within the given value range. |
| com.google.cloud.bigtable.data.v2.models.Heartbeat | A simple wrapper for ReadChangeStreamResponse.Heartbeat. |
| com.google.cloud.bigtable.data.v2.models.KeyOffset | Represents the offset of a row key in a table. |
| com.google.cloud.bigtable.data.v2.models.MergeToCell | Representation of an MergeToCell mod in a data change. |
| com.google.cloud.bigtable.data.v2.models.MutateRowsException.FailedMutation | Identifies which mutation failed and the reason it failed. The mutation is identified by it's index in the original request's MutateRowsRequest#getEntriesList(). |
| com.google.cloud.bigtable.data.v2.models.Mutation | The concrete implementation of MutationApi that can be used to create and represent a list of mutations. It used by RowMutation and ConditionalRowMutation to encapsulate a list of mutations that will to be applied to a single row. |
| com.google.cloud.bigtable.data.v2.models.Query | A simple wrapper to construct a query for the ReadRows RPC. |
| com.google.cloud.bigtable.data.v2.models.Query.QueryPaginator | A Query Paginator that will split a query into small chunks. See Query#createPaginator(int) for example usage. |
| com.google.cloud.bigtable.data.v2.models.Range |
Range API.
This base class represents the API for all ranges in the Cloud Bigtable client. Please note this mutable type. It's intended to support fluent DSLs.For example: |
| com.google.cloud.bigtable.data.v2.models.Range.ByteStringRange | Concrete Range for ByteStrings |
| com.google.cloud.bigtable.data.v2.models.Range.TimestampRange | Concrete Range for timestamps |
| com.google.cloud.bigtable.data.v2.models.ReadChangeStreamQuery | A simple wrapper to construct a query for the ReadChangeStream RPC. |
| com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow | Wraps a ReadModifyWriteRowRequest. |
| com.google.cloud.bigtable.data.v2.models.Row |
Default representation of a logical row.
The cells contained within, will be sorted by the native order. Please see RowCell#compareByNative() for details. |
| com.google.cloud.bigtable.data.v2.models.RowCell | Default representation of a cell in a Row. |
| com.google.cloud.bigtable.data.v2.models.RowMutation | Represents a list of mutations targeted at a single row. It's meant to be used as an parameter for com.google.cloud.bigtable.data.v2.BigtableDataClient#mutateRowAsync(RowMutation). |
| com.google.cloud.bigtable.data.v2.models.RowMutationEntry |
Represents a list of mutations targeted at a single row. It is meant to be used as an parameter
for com.google.cloud.bigtable.data.v2.BigtableDataClient#newBulkMutationBatcher(String).
Note: The changes in the mutation will be applied atomically but the ordering between |
| com.google.cloud.bigtable.data.v2.models.SampleRowKeysRequest | Wraps a com.google.bigtable.v2.SampleRowKeysRequest. |
| com.google.cloud.bigtable.data.v2.models.SetCell | Representation of a SetCell mod in a data change, whose value is concatenated by ChangeStreamRecordMerger in case of SetCell value chunking. |
| com.google.cloud.bigtable.data.v2.models.TableId | An implementation of a TargetId for tables. |
| com.google.cloud.bigtable.data.v2.models.Value | Wrapper class for the com.google.bigtable.v2.Value protobuf message. See Also: com.google.bigtable.v2.Value |
| com.google.cloud.bigtable.data.v2.models.Value.IntValue | |
| com.google.cloud.bigtable.data.v2.models.Value.RawTimestamp | |
| com.google.cloud.bigtable.data.v2.models.Value.RawValue |
Interfaces
| Interface | Description |
|---|---|
| com.google.cloud.bigtable.data.v2.models.ChangeStreamRecord | Default representation of a change stream record, which can be a Heartbeat, a CloseStream, or a logical mutation. |
| com.google.cloud.bigtable.data.v2.models.ChangeStreamRecordAdapter | An extension point that allows end users to plug in a custom implementation of logical change stream records. This is useful in cases where the user would like to apply advanced client side filtering(for example, only keep DeleteFamily in the mutations). This adapter acts like a factory for a SAX style change stream record builder. |
| com.google.cloud.bigtable.data.v2.models.ChangeStreamRecordAdapter.ChangeStreamRecordBuilder |
A SAX style change stream record factory. It is responsible for creating one of the three types
of change stream record: heartbeat, close stream, and a change stream mutation.
State management is handled external to the implementation of this class: |
| com.google.cloud.bigtable.data.v2.models.Entry | Default representation of a mod in a data change, which can be a DeleteFamily, a DeleteCells, or a SetCell This class will be used by ChangeStreamMutation to represent a list of mods in a logical change stream mutation. |
| com.google.cloud.bigtable.data.v2.models.Filters.Filter | |
| com.google.cloud.bigtable.data.v2.models.MutationApi | The API for creating mutations for a single row. |
| com.google.cloud.bigtable.data.v2.models.RowAdapter | An extension point that allows end users to plug in a custom implementation of logical rows. This useful in cases where the user would like to apply advanced client side filtering of cells. This adapter acts like a factory for a SAX style row builder. |
| com.google.cloud.bigtable.data.v2.models.RowAdapter.RowBuilder | A SAX style row factory. It is responsible for creating two types of rows: standard data rows and special marker rows. Marker rows are emitted when skipping lots of rows due to filters. The server notifies the client of the last row it skipped to help client resume in case of error. |
| com.google.cloud.bigtable.data.v2.models.TargetId | TargetId defines the scope a data operation can be applied to. See Also: TableId, AuthorizedViewId |
Enums
Exceptions
| Exception | Description |
|---|---|
| com.google.cloud.bigtable.data.v2.models.MutateRowsException | Thrown by the MutateRows when at least one Mutation failed. If the last failure was caused by an RPC error (as opposed to a single entry failing), then this exception's cause will be set to that error and #getFailedMutations() will contain synthetic errors for all of the entries that were part of that RPC. |