Variables
ReadRowsRequest_RequestStatsView_name, ReadRowsRequest_RequestStatsView_value
var (
ReadRowsRequest_RequestStatsView_name = map[int32]string{
0: "REQUEST_STATS_VIEW_UNSPECIFIED",
1: "REQUEST_STATS_NONE",
2: "REQUEST_STATS_FULL",
}
ReadRowsRequest_RequestStatsView_value = map[string]int32{
"REQUEST_STATS_VIEW_UNSPECIFIED": 0,
"REQUEST_STATS_NONE": 1,
"REQUEST_STATS_FULL": 2,
}
)Enum value maps for ReadRowsRequest_RequestStatsView.
ReadChangeStreamResponse_DataChange_Type_name, ReadChangeStreamResponse_DataChange_Type_value
var (
ReadChangeStreamResponse_DataChange_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "USER",
2: "GARBAGE_COLLECTION",
3: "CONTINUATION",
}
ReadChangeStreamResponse_DataChange_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"USER": 1,
"GARBAGE_COLLECTION": 2,
"CONTINUATION": 3,
}
)Enum value maps for ReadChangeStreamResponse_DataChange_Type.
File_google_bigtable_v2_bigtable_proto
var File_google_bigtable_v2_bigtable_proto protoreflect.FileDescriptorFile_google_bigtable_v2_data_proto
var File_google_bigtable_v2_data_proto protoreflect.FileDescriptorFile_google_bigtable_v2_feature_flags_proto
var File_google_bigtable_v2_feature_flags_proto protoreflect.FileDescriptorFile_google_bigtable_v2_request_stats_proto
var File_google_bigtable_v2_request_stats_proto protoreflect.FileDescriptorFile_google_bigtable_v2_response_params_proto
var File_google_bigtable_v2_response_params_proto protoreflect.FileDescriptorFile_google_bigtable_v2_types_proto
var File_google_bigtable_v2_types_proto protoreflect.FileDescriptorFunctions
func RegisterBigtableServer
func RegisterBigtableServer(s *grpc.Server, srv BigtableServer)ArrayValue
type ArrayValue struct {
// The ordered elements in the array.
Values []*Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}ArrayValue is an ordered list of Value.
func (*ArrayValue) Descriptor
func (*ArrayValue) Descriptor() ([]byte, []int)Deprecated: Use ArrayValue.ProtoReflect.Descriptor instead.
func (*ArrayValue) GetValues
func (x *ArrayValue) GetValues() []*Valuefunc (*ArrayValue) ProtoMessage
func (*ArrayValue) ProtoMessage()func (*ArrayValue) ProtoReflect
func (x *ArrayValue) ProtoReflect() protoreflect.Messagefunc (*ArrayValue) Reset
func (x *ArrayValue) Reset()func (*ArrayValue) String
func (x *ArrayValue) String() stringBigtableClient
type BigtableClient interface {
// Streams back the contents of all requested rows in key order, optionally
// applying the same Reader filter to each. Depending on their size,
// rows and cells may be broken up across multiple responses, but
// atomicity of each row will still be preserved. See the
// ReadRowsResponse documentation for details.
ReadRows(ctx context.Context, in *ReadRowsRequest, opts ...grpc.CallOption) (Bigtable_ReadRowsClient, error)
// Returns a sample of row keys in the table. The returned row keys will
// delimit contiguous sections of the table of approximately equal size,
// which can be used to break up the data for distributed tasks like
// mapreduces.
SampleRowKeys(ctx context.Context, in *SampleRowKeysRequest, opts ...grpc.CallOption) (Bigtable_SampleRowKeysClient, error)
// Mutates a row atomically. Cells already present in the row are left
// unchanged unless explicitly changed by `mutation`.
MutateRow(ctx context.Context, in *MutateRowRequest, opts ...grpc.CallOption) (*MutateRowResponse, error)
// Mutates multiple rows in a batch. Each individual row is mutated
// atomically as in MutateRow, but the entire batch is not executed
// atomically.
MutateRows(ctx context.Context, in *MutateRowsRequest, opts ...grpc.CallOption) (Bigtable_MutateRowsClient, error)
// Mutates a row atomically based on the output of a predicate Reader filter.
CheckAndMutateRow(ctx context.Context, in *CheckAndMutateRowRequest, opts ...grpc.CallOption) (*CheckAndMutateRowResponse, error)
// Warm up associated instance metadata for this connection.
// This call is not required but may be useful for connection keep-alive.
PingAndWarm(ctx context.Context, in *PingAndWarmRequest, opts ...grpc.CallOption) (*PingAndWarmResponse, error)
// Modifies a row atomically on the server. The method reads the latest
// existing timestamp and value from the specified columns and writes a new
// entry based on pre-defined read/modify/write rules. The new value for the
// timestamp is the greater of the existing timestamp or the current server
// time. The method returns the new contents of all modified cells.
ReadModifyWriteRow(ctx context.Context, in *ReadModifyWriteRowRequest, opts ...grpc.CallOption) (*ReadModifyWriteRowResponse, error)
// NOTE: This API is intended to be used by Apache Beam BigtableIO.
// Returns the current list of partitions that make up the table's
// change stream. The union of partitions will cover the entire keyspace.
// Partitions can be read with `ReadChangeStream`.
GenerateInitialChangeStreamPartitions(ctx context.Context, in *GenerateInitialChangeStreamPartitionsRequest, opts ...grpc.CallOption) (Bigtable_GenerateInitialChangeStreamPartitionsClient, error)
// NOTE: This API is intended to be used by Apache Beam BigtableIO.
// Reads changes from a table's change stream. Changes will
// reflect both user-initiated mutations and mutations that are caused by
// garbage collection.
ReadChangeStream(ctx context.Context, in *ReadChangeStreamRequest, opts ...grpc.CallOption) (Bigtable_ReadChangeStreamClient, error)
// Executes a BTQL query against a particular Cloud Bigtable instance.
ExecuteQuery(ctx context.Context, in *ExecuteQueryRequest, opts ...grpc.CallOption) (Bigtable_ExecuteQueryClient, error)
}BigtableClient is the client API for Bigtable service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewBigtableClient
func NewBigtableClient(cc grpc.ClientConnInterface) BigtableClientBigtableServer
type BigtableServer interface {
// Streams back the contents of all requested rows in key order, optionally
// applying the same Reader filter to each. Depending on their size,
// rows and cells may be broken up across multiple responses, but
// atomicity of each row will still be preserved. See the
// ReadRowsResponse documentation for details.
ReadRows(*ReadRowsRequest, Bigtable_ReadRowsServer) error
// Returns a sample of row keys in the table. The returned row keys will
// delimit contiguous sections of the table of approximately equal size,
// which can be used to break up the data for distributed tasks like
// mapreduces.
SampleRowKeys(*SampleRowKeysRequest, Bigtable_SampleRowKeysServer) error
// Mutates a row atomically. Cells already present in the row are left
// unchanged unless explicitly changed by `mutation`.
MutateRow(context.Context, *MutateRowRequest) (*MutateRowResponse, error)
// Mutates multiple rows in a batch. Each individual row is mutated
// atomically as in MutateRow, but the entire batch is not executed
// atomically.
MutateRows(*MutateRowsRequest, Bigtable_MutateRowsServer) error
// Mutates a row atomically based on the output of a predicate Reader filter.
CheckAndMutateRow(context.Context, *CheckAndMutateRowRequest) (*CheckAndMutateRowResponse, error)
// Warm up associated instance metadata for this connection.
// This call is not required but may be useful for connection keep-alive.
PingAndWarm(context.Context, *PingAndWarmRequest) (*PingAndWarmResponse, error)
// Modifies a row atomically on the server. The method reads the latest
// existing timestamp and value from the specified columns and writes a new
// entry based on pre-defined read/modify/write rules. The new value for the
// timestamp is the greater of the existing timestamp or the current server
// time. The method returns the new contents of all modified cells.
ReadModifyWriteRow(context.Context, *ReadModifyWriteRowRequest) (*ReadModifyWriteRowResponse, error)
// NOTE: This API is intended to be used by Apache Beam BigtableIO.
// Returns the current list of partitions that make up the table's
// change stream. The union of partitions will cover the entire keyspace.
// Partitions can be read with `ReadChangeStream`.
GenerateInitialChangeStreamPartitions(*GenerateInitialChangeStreamPartitionsRequest, Bigtable_GenerateInitialChangeStreamPartitionsServer) error
// NOTE: This API is intended to be used by Apache Beam BigtableIO.
// Reads changes from a table's change stream. Changes will
// reflect both user-initiated mutations and mutations that are caused by
// garbage collection.
ReadChangeStream(*ReadChangeStreamRequest, Bigtable_ReadChangeStreamServer) error
// Executes a BTQL query against a particular Cloud Bigtable instance.
ExecuteQuery(*ExecuteQueryRequest, Bigtable_ExecuteQueryServer) error
}BigtableServer is the server API for Bigtable service.
Bigtable_ExecuteQueryClient
type Bigtable_ExecuteQueryClient interface {
Recv() (*ExecuteQueryResponse, error)
grpc.ClientStream
}Bigtable_ExecuteQueryServer
type Bigtable_ExecuteQueryServer interface {
Send(*ExecuteQueryResponse) error
grpc.ServerStream
}Bigtable_GenerateInitialChangeStreamPartitionsClient
type Bigtable_GenerateInitialChangeStreamPartitionsClient interface {
Recv() (*GenerateInitialChangeStreamPartitionsResponse, error)
grpc.ClientStream
}Bigtable_GenerateInitialChangeStreamPartitionsServer
type Bigtable_GenerateInitialChangeStreamPartitionsServer interface {
Send(*GenerateInitialChangeStreamPartitionsResponse) error
grpc.ServerStream
}Bigtable_MutateRowsClient
type Bigtable_MutateRowsClient interface {
Recv() (*MutateRowsResponse, error)
grpc.ClientStream
}Bigtable_MutateRowsServer
type Bigtable_MutateRowsServer interface {
Send(*MutateRowsResponse) error
grpc.ServerStream
}Bigtable_ReadChangeStreamClient
type Bigtable_ReadChangeStreamClient interface {
Recv() (*ReadChangeStreamResponse, error)
grpc.ClientStream
}Bigtable_ReadChangeStreamServer
type Bigtable_ReadChangeStreamServer interface {
Send(*ReadChangeStreamResponse) error
grpc.ServerStream
}Bigtable_ReadRowsClient
type Bigtable_ReadRowsClient interface {
Recv() (*ReadRowsResponse, error)
grpc.ClientStream
}Bigtable_ReadRowsServer
type Bigtable_ReadRowsServer interface {
Send(*ReadRowsResponse) error
grpc.ServerStream
}Bigtable_SampleRowKeysClient
type Bigtable_SampleRowKeysClient interface {
Recv() (*SampleRowKeysResponse, error)
grpc.ClientStream
}Bigtable_SampleRowKeysServer
type Bigtable_SampleRowKeysServer interface {
Send(*SampleRowKeysResponse) error
grpc.ServerStream
}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=timestampMicros,proto3" 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.v2.RowFilter].
Labels []string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty"`
// contains filtered or unexported fields
}Specifies (some of) the contents of a single row/column/timestamp of a table.
func (*Cell) Descriptor
Deprecated: Use Cell.ProtoReflect.Descriptor instead.
func (*Cell) GetLabels
func (*Cell) GetTimestampMicros
func (*Cell) GetValue
func (*Cell) ProtoMessage
func (*Cell) ProtoMessage()func (*Cell) ProtoReflect
func (x *Cell) ProtoReflect() protoreflect.Messagefunc (*Cell) Reset
func (x *Cell) Reset()func (*Cell) String
CheckAndMutateRowRequest
type CheckAndMutateRowRequest struct {
// Optional. The unique name of the table to which the conditional mutation
// should be applied.
//
// Values are of the form
// `projects/Request message for Bigtable.CheckAndMutateRow.
func (*CheckAndMutateRowRequest) Descriptor
func (*CheckAndMutateRowRequest) Descriptor() ([]byte, []int)Deprecated: Use CheckAndMutateRowRequest.ProtoReflect.Descriptor instead.
func (*CheckAndMutateRowRequest) GetAppProfileId
func (x *CheckAndMutateRowRequest) GetAppProfileId() stringfunc (*CheckAndMutateRowRequest) GetAuthorizedViewName
func (x *CheckAndMutateRowRequest) GetAuthorizedViewName() stringfunc (*CheckAndMutateRowRequest) GetFalseMutations
func (x *CheckAndMutateRowRequest) GetFalseMutations() []*Mutationfunc (*CheckAndMutateRowRequest) GetPredicateFilter
func (x *CheckAndMutateRowRequest) GetPredicateFilter() *RowFilterfunc (*CheckAndMutateRowRequest) GetRowKey
func (x *CheckAndMutateRowRequest) GetRowKey() []bytefunc (*CheckAndMutateRowRequest) GetTableName
func (x *CheckAndMutateRowRequest) GetTableName() stringfunc (*CheckAndMutateRowRequest) GetTrueMutations
func (x *CheckAndMutateRowRequest) GetTrueMutations() []*Mutationfunc (*CheckAndMutateRowRequest) ProtoMessage
func (*CheckAndMutateRowRequest) ProtoMessage()func (*CheckAndMutateRowRequest) ProtoReflect
func (x *CheckAndMutateRowRequest) ProtoReflect() protoreflect.Messagefunc (*CheckAndMutateRowRequest) Reset
func (x *CheckAndMutateRowRequest) Reset()func (*CheckAndMutateRowRequest) String
func (x *CheckAndMutateRowRequest) String() stringCheckAndMutateRowResponse
type CheckAndMutateRowResponse struct {
// Whether or not the request's `predicate_filter` yielded any results for
// the specified row.
PredicateMatched bool `protobuf:"varint,1,opt,name=predicate_matched,json=predicateMatched,proto3" json:"predicate_matched,omitempty"`
// contains filtered or unexported fields
}Response message for Bigtable.CheckAndMutateRow.
func (*CheckAndMutateRowResponse) Descriptor
func (*CheckAndMutateRowResponse) Descriptor() ([]byte, []int)Deprecated: Use CheckAndMutateRowResponse.ProtoReflect.Descriptor instead.
func (*CheckAndMutateRowResponse) GetPredicateMatched
func (x *CheckAndMutateRowResponse) GetPredicateMatched() boolfunc (*CheckAndMutateRowResponse) ProtoMessage
func (*CheckAndMutateRowResponse) ProtoMessage()func (*CheckAndMutateRowResponse) ProtoReflect
func (x *CheckAndMutateRowResponse) ProtoReflect() protoreflect.Messagefunc (*CheckAndMutateRowResponse) Reset
func (x *CheckAndMutateRowResponse) Reset()func (*CheckAndMutateRowResponse) String
func (x *CheckAndMutateRowResponse) String() stringColumn
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,proto3" json:"cells,omitempty"`
// contains filtered or unexported fields
}Specifies (some of) the contents of a single row/column intersection of a table.
func (*Column) Descriptor
Deprecated: Use Column.ProtoReflect.Descriptor instead.
func (*Column) GetCells
func (*Column) GetQualifier
func (*Column) ProtoMessage
func (*Column) ProtoMessage()func (*Column) ProtoReflect
func (x *Column) ProtoReflect() protoreflect.Messagefunc (*Column) Reset
func (x *Column) Reset()func (*Column) String
ColumnMetadata
type ColumnMetadata struct {
// The name of the column.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The type of the column.
Type *Type `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// contains filtered or unexported fields
}Describes a column in a Bigtable Query Language result set.
func (*ColumnMetadata) Descriptor
func (*ColumnMetadata) Descriptor() ([]byte, []int)Deprecated: Use ColumnMetadata.ProtoReflect.Descriptor instead.
func (*ColumnMetadata) GetName
func (x *ColumnMetadata) GetName() stringfunc (*ColumnMetadata) GetType
func (x *ColumnMetadata) GetType() *Typefunc (*ColumnMetadata) ProtoMessage
func (*ColumnMetadata) ProtoMessage()func (*ColumnMetadata) ProtoReflect
func (x *ColumnMetadata) ProtoReflect() protoreflect.Messagefunc (*ColumnMetadata) Reset
func (x *ColumnMetadata) Reset()func (*ColumnMetadata) String
func (x *ColumnMetadata) String() stringColumnRange
type ColumnRange struct {
// The name of the column family within which this range falls.
FamilyName string `protobuf:"bytes,1,opt,name=family_name,json=familyName,proto3" 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 assignable to StartQualifier:
//
// *ColumnRange_StartQualifierClosed
// *ColumnRange_StartQualifierOpen
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 assignable to EndQualifier:
//
// *ColumnRange_EndQualifierClosed
// *ColumnRange_EndQualifierOpen
EndQualifier isColumnRange_EndQualifier `protobuf_oneof:"end_qualifier"`
// contains filtered or unexported fields
}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) Descriptor
func (*ColumnRange) Descriptor() ([]byte, []int)Deprecated: Use ColumnRange.ProtoReflect.Descriptor instead.
func (*ColumnRange) GetEndQualifier
func (m *ColumnRange) GetEndQualifier() isColumnRange_EndQualifierfunc (*ColumnRange) GetEndQualifierClosed
func (x *ColumnRange) GetEndQualifierClosed() []bytefunc (*ColumnRange) GetEndQualifierOpen
func (x *ColumnRange) GetEndQualifierOpen() []bytefunc (*ColumnRange) GetFamilyName
func (x *ColumnRange) GetFamilyName() stringfunc (*ColumnRange) GetStartQualifier
func (m *ColumnRange) GetStartQualifier() isColumnRange_StartQualifierfunc (*ColumnRange) GetStartQualifierClosed
func (x *ColumnRange) GetStartQualifierClosed() []bytefunc (*ColumnRange) GetStartQualifierOpen
func (x *ColumnRange) GetStartQualifierOpen() []bytefunc (*ColumnRange) ProtoMessage
func (*ColumnRange) ProtoMessage()func (*ColumnRange) ProtoReflect
func (x *ColumnRange) ProtoReflect() protoreflect.Messagefunc (*ColumnRange) Reset
func (x *ColumnRange) Reset()func (*ColumnRange) String
func (x *ColumnRange) String() stringColumnRange_EndQualifierClosed
type ColumnRange_EndQualifierClosed struct {
// Used when giving an inclusive upper bound for the range.
EndQualifierClosed []byte `protobuf:"bytes,4,opt,name=end_qualifier_closed,json=endQualifierClosed,proto3,oneof"`
}ColumnRange_EndQualifierOpen
type ColumnRange_EndQualifierOpen struct {
// Used when giving an exclusive upper bound for the range.
EndQualifierOpen []byte `protobuf:"bytes,5,opt,name=end_qualifier_open,json=endQualifierOpen,proto3,oneof"`
}ColumnRange_StartQualifierClosed
type ColumnRange_StartQualifierClosed struct {
// Used when giving an inclusive lower bound for the range.
StartQualifierClosed []byte `protobuf:"bytes,2,opt,name=start_qualifier_closed,json=startQualifierClosed,proto3,oneof"`
}ColumnRange_StartQualifierOpen
type ColumnRange_StartQualifierOpen struct {
// Used when giving an exclusive lower bound for the range.
StartQualifierOpen []byte `protobuf:"bytes,3,opt,name=start_qualifier_open,json=startQualifierOpen,proto3,oneof"`
}ExecuteQueryRequest
type ExecuteQueryRequest struct {
InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName,proto3" json:"instance_name,omitempty"`
AppProfileId string `protobuf:"bytes,2,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
DataFormat isExecuteQueryRequest_DataFormat `protobuf_oneof:"data_format"`
ResumeToken []byte `protobuf:"bytes,8,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
Params map[string]*Value "" /* 153 byte string literal not displayed */
}Request message for Bigtable.ExecuteQuery
func (*ExecuteQueryRequest) Descriptor
func (*ExecuteQueryRequest) Descriptor() ([]byte, []int)Deprecated: Use ExecuteQueryRequest.ProtoReflect.Descriptor instead.
func (*ExecuteQueryRequest) GetAppProfileId
func (x *ExecuteQueryRequest) GetAppProfileId() stringfunc (*ExecuteQueryRequest) GetDataFormat
func (m *ExecuteQueryRequest) GetDataFormat() isExecuteQueryRequest_DataFormatfunc (*ExecuteQueryRequest) GetInstanceName
func (x *ExecuteQueryRequest) GetInstanceName() stringfunc (*ExecuteQueryRequest) GetParams
func (x *ExecuteQueryRequest) GetParams() map[string]*Valuefunc (*ExecuteQueryRequest) GetProtoFormat
func (x *ExecuteQueryRequest) GetProtoFormat() *ProtoFormatfunc (*ExecuteQueryRequest) GetQuery
func (x *ExecuteQueryRequest) GetQuery() stringfunc (*ExecuteQueryRequest) GetResumeToken
func (x *ExecuteQueryRequest) GetResumeToken() []bytefunc (*ExecuteQueryRequest) ProtoMessage
func (*ExecuteQueryRequest) ProtoMessage()func (*ExecuteQueryRequest) ProtoReflect
func (x *ExecuteQueryRequest) ProtoReflect() protoreflect.Messagefunc (*ExecuteQueryRequest) Reset
func (x *ExecuteQueryRequest) Reset()func (*ExecuteQueryRequest) String
func (x *ExecuteQueryRequest) String() stringExecuteQueryRequest_ProtoFormat
type ExecuteQueryRequest_ProtoFormat struct {
// Protocol buffer format as described by ProtoSchema and ProtoRows
// messages.
ProtoFormat *ProtoFormat `protobuf:"bytes,4,opt,name=proto_format,json=protoFormat,proto3,oneof"`
}ExecuteQueryResponse
type ExecuteQueryResponse struct {
// The first response streamed from the server is of type `ResultSetMetadata`
// and includes information about the columns and types of the result set.
// From there on, we stream `PartialResultSet` messages with no additional
// information. `PartialResultSet` will contain `resume_token` to restart the
// response if query interrupts. In case of resumption with `resume_token`,
// the server will not resend the ResultSetMetadata.
//
// Types that are assignable to Response:
//
// *ExecuteQueryResponse_Metadata
// *ExecuteQueryResponse_Results
Response isExecuteQueryResponse_Response `protobuf_oneof:"response"`
// contains filtered or unexported fields
}Response message for Bigtable.ExecuteQuery
func (*ExecuteQueryResponse) Descriptor
func (*ExecuteQueryResponse) Descriptor() ([]byte, []int)Deprecated: Use ExecuteQueryResponse.ProtoReflect.Descriptor instead.
func (*ExecuteQueryResponse) GetMetadata
func (x *ExecuteQueryResponse) GetMetadata() *ResultSetMetadatafunc (*ExecuteQueryResponse) GetResponse
func (m *ExecuteQueryResponse) GetResponse() isExecuteQueryResponse_Responsefunc (*ExecuteQueryResponse) GetResults
func (x *ExecuteQueryResponse) GetResults() *PartialResultSetfunc (*ExecuteQueryResponse) ProtoMessage
func (*ExecuteQueryResponse) ProtoMessage()func (*ExecuteQueryResponse) ProtoReflect
func (x *ExecuteQueryResponse) ProtoReflect() protoreflect.Messagefunc (*ExecuteQueryResponse) Reset
func (x *ExecuteQueryResponse) Reset()func (*ExecuteQueryResponse) String
func (x *ExecuteQueryResponse) String() stringExecuteQueryResponse_Metadata
type ExecuteQueryResponse_Metadata struct {
// Structure of rows in this response stream. The first (and only the first)
// response streamed from the server will be of this type.
Metadata *ResultSetMetadata `protobuf:"bytes,1,opt,name=metadata,proto3,oneof"`
}ExecuteQueryResponse_Results
type ExecuteQueryResponse_Results struct {
// A partial result set with row data potentially including additional
// instructions on how recent past and future partial responses should be
// interpreted.
Results *PartialResultSet `protobuf:"bytes,2,opt,name=results,proto3,oneof"`
}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,proto3" json:"name,omitempty"`
// Must not be empty. Sorted in order of increasing "qualifier".
Columns []*Column `protobuf:"bytes,2,rep,name=columns,proto3" json:"columns,omitempty"`
// contains filtered or unexported fields
}Specifies (some of) the contents of a single row/column family intersection of a table.
func (*Family) Descriptor
Deprecated: Use Family.ProtoReflect.Descriptor instead.
func (*Family) GetColumns
func (*Family) GetName
func (*Family) ProtoMessage
func (*Family) ProtoMessage()func (*Family) ProtoReflect
func (x *Family) ProtoReflect() protoreflect.Messagefunc (*Family) Reset
func (x *Family) Reset()func (*Family) String
FeatureFlags
type FeatureFlags struct {
ReverseScans bool `protobuf:"varint,1,opt,name=reverse_scans,json=reverseScans,proto3" json:"reverse_scans,omitempty"`
MutateRowsRateLimit bool `protobuf:"varint,3,opt,name=mutate_rows_rate_limit,json=mutateRowsRateLimit,proto3" json:"mutate_rows_rate_limit,omitempty"`
MutateRowsRateLimit2 bool `protobuf:"varint,5,opt,name=mutate_rows_rate_limit2,json=mutateRowsRateLimit2,proto3" json:"mutate_rows_rate_limit2,omitempty"`
LastScannedRowResponses bool "" /* 135 byte string literal not displayed */
RoutingCookie bool `protobuf:"varint,6,opt,name=routing_cookie,json=routingCookie,proto3" json:"routing_cookie,omitempty"`
RetryInfo bool `protobuf:"varint,7,opt,name=retry_info,json=retryInfo,proto3" json:"retry_info,omitempty"`
ClientSideMetricsEnabled bool "" /* 138 byte string literal not displayed */
}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.
func (*FeatureFlags) Descriptor
func (*FeatureFlags) Descriptor() ([]byte, []int)Deprecated: Use FeatureFlags.ProtoReflect.Descriptor instead.
func (*FeatureFlags) GetClientSideMetricsEnabled
func (x *FeatureFlags) GetClientSideMetricsEnabled() boolfunc (*FeatureFlags) GetLastScannedRowResponses
func (x *FeatureFlags) GetLastScannedRowResponses() boolfunc (*FeatureFlags) GetMutateRowsRateLimit
func (x *FeatureFlags) GetMutateRowsRateLimit() boolfunc (*FeatureFlags) GetMutateRowsRateLimit2
func (x *FeatureFlags) GetMutateRowsRateLimit2() boolfunc (*FeatureFlags) GetRetryInfo
func (x *FeatureFlags) GetRetryInfo() boolfunc (*FeatureFlags) GetReverseScans
func (x *FeatureFlags) GetReverseScans() boolfunc (*FeatureFlags) GetRoutingCookie
func (x *FeatureFlags) GetRoutingCookie() boolfunc (*FeatureFlags) ProtoMessage
func (*FeatureFlags) ProtoMessage()func (*FeatureFlags) ProtoReflect
func (x *FeatureFlags) ProtoReflect() protoreflect.Messagefunc (*FeatureFlags) Reset
func (x *FeatureFlags) Reset()func (*FeatureFlags) String
func (x *FeatureFlags) String() stringFullReadStatsView
type FullReadStatsView struct {
// Iteration stats describe how efficient the read is, e.g. comparing
// rows seen vs. rows returned or cells seen vs cells returned can provide an
// indication of read efficiency (the higher the ratio of seen to retuned the
// better).
ReadIterationStats *ReadIterationStats `protobuf:"bytes,1,opt,name=read_iteration_stats,json=readIterationStats,proto3" json:"read_iteration_stats,omitempty"`
// Request latency stats describe the time taken to complete a request, from
// the server side.
RequestLatencyStats *RequestLatencyStats `protobuf:"bytes,2,opt,name=request_latency_stats,json=requestLatencyStats,proto3" json:"request_latency_stats,omitempty"`
// contains filtered or unexported fields
}FullReadStatsView captures all known information about a read.
func (*FullReadStatsView) Descriptor
func (*FullReadStatsView) Descriptor() ([]byte, []int)Deprecated: Use FullReadStatsView.ProtoReflect.Descriptor instead.
func (*FullReadStatsView) GetReadIterationStats
func (x *FullReadStatsView) GetReadIterationStats() *ReadIterationStatsfunc (*FullReadStatsView) GetRequestLatencyStats
func (x *FullReadStatsView) GetRequestLatencyStats() *RequestLatencyStatsfunc (*FullReadStatsView) ProtoMessage
func (*FullReadStatsView) ProtoMessage()func (*FullReadStatsView) ProtoReflect
func (x *FullReadStatsView) ProtoReflect() protoreflect.Messagefunc (*FullReadStatsView) Reset
func (x *FullReadStatsView) Reset()func (*FullReadStatsView) String
func (x *FullReadStatsView) String() stringGenerateInitialChangeStreamPartitionsRequest
type GenerateInitialChangeStreamPartitionsRequest struct {
// Required. The unique name of the table from which to get change stream
// partitions. Values are of the form
// `projects/NOTE: This API is intended to be used by Apache Beam BigtableIO. Request message for Bigtable.GenerateInitialChangeStreamPartitions.
func (*GenerateInitialChangeStreamPartitionsRequest) Descriptor
func (*GenerateInitialChangeStreamPartitionsRequest) Descriptor() ([]byte, []int)Deprecated: Use GenerateInitialChangeStreamPartitionsRequest.ProtoReflect.Descriptor instead.
func (*GenerateInitialChangeStreamPartitionsRequest) GetAppProfileId
func (x *GenerateInitialChangeStreamPartitionsRequest) GetAppProfileId() stringfunc (*GenerateInitialChangeStreamPartitionsRequest) GetTableName
func (x *GenerateInitialChangeStreamPartitionsRequest) GetTableName() stringfunc (*GenerateInitialChangeStreamPartitionsRequest) ProtoMessage
func (*GenerateInitialChangeStreamPartitionsRequest) ProtoMessage()func (*GenerateInitialChangeStreamPartitionsRequest) ProtoReflect
func (x *GenerateInitialChangeStreamPartitionsRequest) ProtoReflect() protoreflect.Messagefunc (*GenerateInitialChangeStreamPartitionsRequest) Reset
func (x *GenerateInitialChangeStreamPartitionsRequest) Reset()func (*GenerateInitialChangeStreamPartitionsRequest) String
func (x *GenerateInitialChangeStreamPartitionsRequest) String() stringGenerateInitialChangeStreamPartitionsResponse
type GenerateInitialChangeStreamPartitionsResponse struct {
// A partition of the change stream.
Partition *StreamPartition `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"`
// contains filtered or unexported fields
}NOTE: This API is intended to be used by Apache Beam BigtableIO. Response message for Bigtable.GenerateInitialChangeStreamPartitions.
func (*GenerateInitialChangeStreamPartitionsResponse) Descriptor
func (*GenerateInitialChangeStreamPartitionsResponse) Descriptor() ([]byte, []int)Deprecated: Use GenerateInitialChangeStreamPartitionsResponse.ProtoReflect.Descriptor instead.
func (*GenerateInitialChangeStreamPartitionsResponse) GetPartition
func (x *GenerateInitialChangeStreamPartitionsResponse) GetPartition() *StreamPartitionfunc (*GenerateInitialChangeStreamPartitionsResponse) ProtoMessage
func (*GenerateInitialChangeStreamPartitionsResponse) ProtoMessage()func (*GenerateInitialChangeStreamPartitionsResponse) ProtoReflect
func (x *GenerateInitialChangeStreamPartitionsResponse) ProtoReflect() protoreflect.Messagefunc (*GenerateInitialChangeStreamPartitionsResponse) Reset
func (x *GenerateInitialChangeStreamPartitionsResponse) Reset()func (*GenerateInitialChangeStreamPartitionsResponse) String
func (x *GenerateInitialChangeStreamPartitionsResponse) String() stringMutateRowRequest
type MutateRowRequest struct {
// Optional. The unique name of the table to which the mutation should be
// applied.
//
// Values are of the form
// `projects/Request message for Bigtable.MutateRow.
func (*MutateRowRequest) Descriptor
func (*MutateRowRequest) Descriptor() ([]byte, []int)Deprecated: Use MutateRowRequest.ProtoReflect.Descriptor instead.
func (*MutateRowRequest) GetAppProfileId
func (x *MutateRowRequest) GetAppProfileId() stringfunc (*MutateRowRequest) GetAuthorizedViewName
func (x *MutateRowRequest) GetAuthorizedViewName() stringfunc (*MutateRowRequest) GetMutations
func (x *MutateRowRequest) GetMutations() []*Mutationfunc (*MutateRowRequest) GetRowKey
func (x *MutateRowRequest) GetRowKey() []bytefunc (*MutateRowRequest) GetTableName
func (x *MutateRowRequest) GetTableName() stringfunc (*MutateRowRequest) ProtoMessage
func (*MutateRowRequest) ProtoMessage()func (*MutateRowRequest) ProtoReflect
func (x *MutateRowRequest) ProtoReflect() protoreflect.Messagefunc (*MutateRowRequest) Reset
func (x *MutateRowRequest) Reset()func (*MutateRowRequest) String
func (x *MutateRowRequest) String() stringMutateRowResponse
type MutateRowResponse struct {
// contains filtered or unexported fields
}Response message for Bigtable.MutateRow.
func (*MutateRowResponse) Descriptor
func (*MutateRowResponse) Descriptor() ([]byte, []int)Deprecated: Use MutateRowResponse.ProtoReflect.Descriptor instead.
func (*MutateRowResponse) ProtoMessage
func (*MutateRowResponse) ProtoMessage()func (*MutateRowResponse) ProtoReflect
func (x *MutateRowResponse) ProtoReflect() protoreflect.Messagefunc (*MutateRowResponse) Reset
func (x *MutateRowResponse) Reset()func (*MutateRowResponse) String
func (x *MutateRowResponse) String() stringMutateRowsRequest
type MutateRowsRequest struct {
// Optional. The unique name of the table to which the mutations should be
// applied.
//
// Values are of the form
// `projects/Request message for BigtableService.MutateRows.
func (*MutateRowsRequest) Descriptor
func (*MutateRowsRequest) Descriptor() ([]byte, []int)Deprecated: Use MutateRowsRequest.ProtoReflect.Descriptor instead.
func (*MutateRowsRequest) GetAppProfileId
func (x *MutateRowsRequest) GetAppProfileId() stringfunc (*MutateRowsRequest) GetAuthorizedViewName
func (x *MutateRowsRequest) GetAuthorizedViewName() stringfunc (*MutateRowsRequest) GetEntries
func (x *MutateRowsRequest) GetEntries() []*MutateRowsRequest_Entryfunc (*MutateRowsRequest) GetTableName
func (x *MutateRowsRequest) GetTableName() stringfunc (*MutateRowsRequest) ProtoMessage
func (*MutateRowsRequest) ProtoMessage()func (*MutateRowsRequest) ProtoReflect
func (x *MutateRowsRequest) ProtoReflect() protoreflect.Messagefunc (*MutateRowsRequest) Reset
func (x *MutateRowsRequest) Reset()func (*MutateRowsRequest) String
func (x *MutateRowsRequest) String() stringMutateRowsRequest_Entry
type MutateRowsRequest_Entry struct {
// The key of the row to which the `mutations` should be applied.
RowKey []byte `protobuf:"bytes,1,opt,name=row_key,json=rowKey,proto3" json:"row_key,omitempty"`
// Required. Changes to be atomically applied to the specified row.
// Mutations are applied in order, meaning that earlier mutations can be
// masked by later ones. You must specify at least one mutation.
Mutations []*Mutation `protobuf:"bytes,2,rep,name=mutations,proto3" json:"mutations,omitempty"`
// contains filtered or unexported fields
}A mutation for a given row.
func (*MutateRowsRequest_Entry) Descriptor
func (*MutateRowsRequest_Entry) Descriptor() ([]byte, []int)Deprecated: Use MutateRowsRequest_Entry.ProtoReflect.Descriptor instead.
func (*MutateRowsRequest_Entry) GetMutations
func (x *MutateRowsRequest_Entry) GetMutations() []*Mutationfunc (*MutateRowsRequest_Entry) GetRowKey
func (x *MutateRowsRequest_Entry) GetRowKey() []bytefunc (*MutateRowsRequest_Entry) ProtoMessage
func (*MutateRowsRequest_Entry) ProtoMessage()func (*MutateRowsRequest_Entry) ProtoReflect
func (x *MutateRowsRequest_Entry) ProtoReflect() protoreflect.Messagefunc (*MutateRowsRequest_Entry) Reset
func (x *MutateRowsRequest_Entry) Reset()func (*MutateRowsRequest_Entry) String
func (x *MutateRowsRequest_Entry) String() stringMutateRowsResponse
type MutateRowsResponse struct {
// One or more results for Entries from the batch request.
Entries []*MutateRowsResponse_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
// Information about how client should limit the rate (QPS). Primirily used by
// supported official Cloud Bigtable clients. If unset, the rate limit info is
// not provided by the server.
RateLimitInfo *RateLimitInfo `protobuf:"bytes,3,opt,name=rate_limit_info,json=rateLimitInfo,proto3,oneof" json:"rate_limit_info,omitempty"`
// contains filtered or unexported fields
}Response message for BigtableService.MutateRows.
func (*MutateRowsResponse) Descriptor
func (*MutateRowsResponse) Descriptor() ([]byte, []int)Deprecated: Use MutateRowsResponse.ProtoReflect.Descriptor instead.
func (*MutateRowsResponse) GetEntries
func (x *MutateRowsResponse) GetEntries() []*MutateRowsResponse_Entryfunc (*MutateRowsResponse) GetRateLimitInfo
func (x *MutateRowsResponse) GetRateLimitInfo() *RateLimitInfofunc (*MutateRowsResponse) ProtoMessage
func (*MutateRowsResponse) ProtoMessage()func (*MutateRowsResponse) ProtoReflect
func (x *MutateRowsResponse) ProtoReflect() protoreflect.Messagefunc (*MutateRowsResponse) Reset
func (x *MutateRowsResponse) Reset()func (*MutateRowsResponse) String
func (x *MutateRowsResponse) String() stringMutateRowsResponse_Entry
type MutateRowsResponse_Entry struct {
// The index into the original request's `entries` list of the Entry
// for which a result is being reported.
Index int64 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"`
// The result of the request Entry identified by `index`.
// Depending on how requests are batched during execution, it is possible
// for one Entry to fail due to an error with another Entry. In the event
// that this occurs, the same error will be reported for both entries.
Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
// contains filtered or unexported fields
}The result of applying a passed mutation in the original request.
func (*MutateRowsResponse_Entry) Descriptor
func (*MutateRowsResponse_Entry) Descriptor() ([]byte, []int)Deprecated: Use MutateRowsResponse_Entry.ProtoReflect.Descriptor instead.
func (*MutateRowsResponse_Entry) GetIndex
func (x *MutateRowsResponse_Entry) GetIndex() int64func (*MutateRowsResponse_Entry) GetStatus
func (x *MutateRowsResponse_Entry) GetStatus() *status.Statusfunc (*MutateRowsResponse_Entry) ProtoMessage
func (*MutateRowsResponse_Entry) ProtoMessage()func (*MutateRowsResponse_Entry) ProtoReflect
func (x *MutateRowsResponse_Entry) ProtoReflect() protoreflect.Messagefunc (*MutateRowsResponse_Entry) Reset
func (x *MutateRowsResponse_Entry) Reset()func (*MutateRowsResponse_Entry) String
func (x *MutateRowsResponse_Entry) String() stringMutation
type Mutation struct {
// Which of the possible Mutation types to apply.
//
// Types that are assignable to Mutation:
//
// *Mutation_SetCell_
// *Mutation_AddToCell_
// *Mutation_MergeToCell_
// *Mutation_DeleteFromColumn_
// *Mutation_DeleteFromFamily_
// *Mutation_DeleteFromRow_
Mutation isMutation_Mutation `protobuf_oneof:"mutation"`
// contains filtered or unexported fields
}Specifies a particular change to be made to the contents of a row.
func (*Mutation) Descriptor
Deprecated: Use Mutation.ProtoReflect.Descriptor instead.
func (*Mutation) GetAddToCell
func (x *Mutation) GetAddToCell() *Mutation_AddToCellfunc (*Mutation) GetDeleteFromColumn
func (x *Mutation) GetDeleteFromColumn() *Mutation_DeleteFromColumnfunc (*Mutation) GetDeleteFromFamily
func (x *Mutation) GetDeleteFromFamily() *Mutation_DeleteFromFamilyfunc (*Mutation) GetDeleteFromRow
func (x *Mutation) GetDeleteFromRow() *Mutation_DeleteFromRowfunc (*Mutation) GetMergeToCell
func (x *Mutation) GetMergeToCell() *Mutation_MergeToCellfunc (*Mutation) GetMutation
func (m *Mutation) GetMutation() isMutation_Mutationfunc (*Mutation) GetSetCell
func (x *Mutation) GetSetCell() *Mutation_SetCellfunc (*Mutation) ProtoMessage
func (*Mutation) ProtoMessage()func (*Mutation) ProtoReflect
func (x *Mutation) ProtoReflect() protoreflect.Messagefunc (*Mutation) Reset
func (x *Mutation) Reset()func (*Mutation) String
Mutation_AddToCell
type Mutation_AddToCell struct {
// The name of the `Aggregate` family into which new data should be added.
// This must be a family with a `value_type` of `Aggregate`.
// Format: `[-_.a-zA-Z0-9]+`
FamilyName string `protobuf:"bytes,1,opt,name=family_name,json=familyName,proto3" json:"family_name,omitempty"`
// The qualifier of the column into which new data should be added. This
// must be a `raw_value`.
ColumnQualifier *Value `protobuf:"bytes,2,opt,name=column_qualifier,json=columnQualifier,proto3" json:"column_qualifier,omitempty"`
// The timestamp of the cell to which new data should be added. This must
// be a `raw_timestamp_micros` that matches the table's `granularity`.
Timestamp *Value `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// The input value to be accumulated into the specified cell. This must be
// compatible with the family's `value_type.input_type`.
Input *Value `protobuf:"bytes,4,opt,name=input,proto3" json:"input,omitempty"`
// contains filtered or unexported fields
}A Mutation which incrementally updates a cell in an Aggregate family.
func (*Mutation_AddToCell) Descriptor
func (*Mutation_AddToCell) Descriptor() ([]byte, []int)Deprecated: Use Mutation_AddToCell.ProtoReflect.Descriptor instead.
func (*Mutation_AddToCell) GetColumnQualifier
func (x *Mutation_AddToCell) GetColumnQualifier() *Valuefunc (*Mutation_AddToCell) GetFamilyName
func (x *Mutation_AddToCell) GetFamilyName() stringfunc (*Mutation_AddToCell) GetInput
func (x *Mutation_AddToCell) GetInput() *Valuefunc (*Mutation_AddToCell) GetTimestamp
func (x *Mutation_AddToCell) GetTimestamp() *Valuefunc (*Mutation_AddToCell) ProtoMessage
func (*Mutation_AddToCell) ProtoMessage()func (*Mutation_AddToCell) ProtoReflect
func (x *Mutation_AddToCell) ProtoReflect() protoreflect.Messagefunc (*Mutation_AddToCell) Reset
func (x *Mutation_AddToCell) Reset()func (*Mutation_AddToCell) String
func (x *Mutation_AddToCell) String() stringMutation_AddToCell_
type Mutation_AddToCell_ struct {
// Incrementally updates an `Aggregate` cell.
AddToCell *Mutation_AddToCell `protobuf:"bytes,5,opt,name=add_to_cell,json=addToCell,proto3,oneof"`
}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=familyName,proto3" 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,json=columnQualifier,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=timeRange,proto3" json:"time_range,omitempty"`
// contains filtered or unexported fields
}A Mutation which deletes cells from the specified column, optionally restricting the deletions to a given timestamp range.
func (*Mutation_DeleteFromColumn) Descriptor
func (*Mutation_DeleteFromColumn) Descriptor() ([]byte, []int)Deprecated: Use Mutation_DeleteFromColumn.ProtoReflect.Descriptor instead.
func (*Mutation_DeleteFromColumn) GetColumnQualifier
func (x *Mutation_DeleteFromColumn) GetColumnQualifier() []bytefunc (*Mutation_DeleteFromColumn) GetFamilyName
func (x *Mutation_DeleteFromColumn) GetFamilyName() stringfunc (*Mutation_DeleteFromColumn) GetTimeRange
func (x *Mutation_DeleteFromColumn) GetTimeRange() *TimestampRangefunc (*Mutation_DeleteFromColumn) ProtoMessage
func (*Mutation_DeleteFromColumn) ProtoMessage()func (*Mutation_DeleteFromColumn) ProtoReflect
func (x *Mutation_DeleteFromColumn) ProtoReflect() protoreflect.Messagefunc (*Mutation_DeleteFromColumn) Reset
func (x *Mutation_DeleteFromColumn) Reset()func (*Mutation_DeleteFromColumn) String
func (x *Mutation_DeleteFromColumn) String() stringMutation_DeleteFromColumn_
type Mutation_DeleteFromColumn_ struct {
// Deletes cells from a column.
DeleteFromColumn *Mutation_DeleteFromColumn `protobuf:"bytes,2,opt,name=delete_from_column,json=deleteFromColumn,proto3,oneof"`
}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=familyName,proto3" json:"family_name,omitempty"`
// contains filtered or unexported fields
}A Mutation which deletes all cells from the specified column family.
func (*Mutation_DeleteFromFamily) Descriptor
func (*Mutation_DeleteFromFamily) Descriptor() ([]byte, []int)Deprecated: Use Mutation_DeleteFromFamily.ProtoReflect.Descriptor instead.
func (*Mutation_DeleteFromFamily) GetFamilyName
func (x *Mutation_DeleteFromFamily) GetFamilyName() stringfunc (*Mutation_DeleteFromFamily) ProtoMessage
func (*Mutation_DeleteFromFamily) ProtoMessage()func (*Mutation_DeleteFromFamily) ProtoReflect
func (x *Mutation_DeleteFromFamily) ProtoReflect() protoreflect.Messagefunc (*Mutation_DeleteFromFamily) Reset
func (x *Mutation_DeleteFromFamily) Reset()func (*Mutation_DeleteFromFamily) String
func (x *Mutation_DeleteFromFamily) String() stringMutation_DeleteFromFamily_
type Mutation_DeleteFromFamily_ struct {
// Deletes cells from a column family.
DeleteFromFamily *Mutation_DeleteFromFamily `protobuf:"bytes,3,opt,name=delete_from_family,json=deleteFromFamily,proto3,oneof"`
}Mutation_DeleteFromRow
type Mutation_DeleteFromRow struct {
// contains filtered or unexported fields
}A Mutation which deletes all cells from the containing row.
func (*Mutation_DeleteFromRow) Descriptor
func (*Mutation_DeleteFromRow) Descriptor() ([]byte, []int)Deprecated: Use Mutation_DeleteFromRow.ProtoReflect.Descriptor instead.
func (*Mutation_DeleteFromRow) ProtoMessage
func (*Mutation_DeleteFromRow) ProtoMessage()func (*Mutation_DeleteFromRow) ProtoReflect
func (x *Mutation_DeleteFromRow) ProtoReflect() protoreflect.Messagefunc (*Mutation_DeleteFromRow) Reset
func (x *Mutation_DeleteFromRow) Reset()func (*Mutation_DeleteFromRow) String
func (x *Mutation_DeleteFromRow) String() stringMutation_DeleteFromRow_
type Mutation_DeleteFromRow_ struct {
// Deletes cells from the entire row.
DeleteFromRow *Mutation_DeleteFromRow `protobuf:"bytes,4,opt,name=delete_from_row,json=deleteFromRow,proto3,oneof"`
}Mutation_MergeToCell
type Mutation_MergeToCell struct {
// The name of the `Aggregate` family into which new data should be added.
// This must be a family with a `value_type` of `Aggregate`.
// Format: `[-_.a-zA-Z0-9]+`
FamilyName string `protobuf:"bytes,1,opt,name=family_name,json=familyName,proto3" json:"family_name,omitempty"`
// The qualifier of the column into which new data should be added. This
// must be a `raw_value`.
ColumnQualifier *Value `protobuf:"bytes,2,opt,name=column_qualifier,json=columnQualifier,proto3" json:"column_qualifier,omitempty"`
// The timestamp of the cell to which new data should be added. This must
// be a `raw_timestamp_micros` that matches the table's `granularity`.
Timestamp *Value `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// The input value to be merged into the specified cell. This must be
// compatible with the family's `value_type.state_type`. Merging `NULL` is
// allowed, but has no effect.
Input *Value `protobuf:"bytes,4,opt,name=input,proto3" json:"input,omitempty"`
// contains filtered or unexported fields
}A Mutation which merges accumulated state into a cell in an Aggregate
family.
func (*Mutation_MergeToCell) Descriptor
func (*Mutation_MergeToCell) Descriptor() ([]byte, []int)Deprecated: Use Mutation_MergeToCell.ProtoReflect.Descriptor instead.
func (*Mutation_MergeToCell) GetColumnQualifier
func (x *Mutation_MergeToCell) GetColumnQualifier() *Valuefunc (*Mutation_MergeToCell) GetFamilyName
func (x *Mutation_MergeToCell) GetFamilyName() stringfunc (*Mutation_MergeToCell) GetInput
func (x *Mutation_MergeToCell) GetInput() *Valuefunc (*Mutation_MergeToCell) GetTimestamp
func (x *Mutation_MergeToCell) GetTimestamp() *Valuefunc (*Mutation_MergeToCell) ProtoMessage
func (*Mutation_MergeToCell) ProtoMessage()func (*Mutation_MergeToCell) ProtoReflect
func (x *Mutation_MergeToCell) ProtoReflect() protoreflect.Messagefunc (*Mutation_MergeToCell) Reset
func (x *Mutation_MergeToCell) Reset()func (*Mutation_MergeToCell) String
func (x *Mutation_MergeToCell) String() stringMutation_MergeToCell_
type Mutation_MergeToCell_ struct {
// Merges accumulated state to an `Aggregate` cell.
MergeToCell *Mutation_MergeToCell `protobuf:"bytes,6,opt,name=merge_to_cell,json=mergeToCell,proto3,oneof"`
}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=familyName,proto3" 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,json=columnQualifier,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=timestampMicros,proto3" 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"`
// contains filtered or unexported fields
}A Mutation which sets the value of the specified cell.
func (*Mutation_SetCell) Descriptor
func (*Mutation_SetCell) Descriptor() ([]byte, []int)Deprecated: Use Mutation_SetCell.ProtoReflect.Descriptor instead.
func (*Mutation_SetCell) GetColumnQualifier
func (x *Mutation_SetCell) GetColumnQualifier() []bytefunc (*Mutation_SetCell) GetFamilyName
func (x *Mutation_SetCell) GetFamilyName() stringfunc (*Mutation_SetCell) GetTimestampMicros
func (x *Mutation_SetCell) GetTimestampMicros() int64func (*Mutation_SetCell) GetValue
func (x *Mutation_SetCell) GetValue() []bytefunc (*Mutation_SetCell) ProtoMessage
func (*Mutation_SetCell) ProtoMessage()func (*Mutation_SetCell) ProtoReflect
func (x *Mutation_SetCell) ProtoReflect() protoreflect.Messagefunc (*Mutation_SetCell) Reset
func (x *Mutation_SetCell) Reset()func (*Mutation_SetCell) String
func (x *Mutation_SetCell) String() stringMutation_SetCell_
type Mutation_SetCell_ struct {
// Set a cell's value.
SetCell *Mutation_SetCell `protobuf:"bytes,1,opt,name=set_cell,json=setCell,proto3,oneof"`
}PartialResultSet
type PartialResultSet struct {
// Partial Rows in one of the supported formats. It may require many
// PartialResultSets to stream a batch of rows that can decoded on the client.
// The client should buffer partial_rows until it gets a `resume_token`,
// at which point the batch is complete and can be decoded and yielded to the
// user. Each sub-message documents the appropriate way to combine results.
//
// Types that are assignable to PartialRows:
//
// *PartialResultSet_ProtoRowsBatch
PartialRows isPartialResultSet_PartialRows `protobuf_oneof:"partial_rows"`
// An opaque token sent by the server to allow query resumption and signal
// the client to accumulate `partial_rows` since the last non-empty
// `resume_token`. On resumption, the resumed query will return the remaining
// rows for this query.
//
// If there is a batch in progress, a non-empty `resume_token`
// means that that the batch of `partial_rows` will be complete after merging
// the `partial_rows` from this response. The client must only yield
// completed batches to the application, and must ensure that any future
// retries send the latest token to avoid returning duplicate data.
//
// The server may set 'resume_token' without a 'partial_rows'. If there is a
// batch in progress the client should yield it.
//
// The server will also send a sentinel `resume_token` when last batch of
// `partial_rows` is sent. If the client retries the ExecuteQueryRequest with
// the sentinel `resume_token`, the server will emit it again without any
// `partial_rows`, then return OK.
ResumeToken []byte `protobuf:"bytes,5,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
// Estimated size of a new batch. The server will always set this when
// returning the first `partial_rows` of a batch, and will not set it at any
// other time.
//
// The client can use this estimate to allocate an initial buffer for the
// batched results. This helps minimize the number of allocations required,
// though the buffer size may still need to be increased if the estimate is
// too low.
EstimatedBatchSize int32 `protobuf:"varint,4,opt,name=estimated_batch_size,json=estimatedBatchSize,proto3" json:"estimated_batch_size,omitempty"`
// contains filtered or unexported fields
}A partial result set from the streaming query API. CBT client will buffer partial_rows from result_sets until it gets a resumption_token.
func (*PartialResultSet) Descriptor
func (*PartialResultSet) Descriptor() ([]byte, []int)Deprecated: Use PartialResultSet.ProtoReflect.Descriptor instead.
func (*PartialResultSet) GetEstimatedBatchSize
func (x *PartialResultSet) GetEstimatedBatchSize() int32func (*PartialResultSet) GetPartialRows
func (m *PartialResultSet) GetPartialRows() isPartialResultSet_PartialRowsfunc (*PartialResultSet) GetProtoRowsBatch
func (x *PartialResultSet) GetProtoRowsBatch() *ProtoRowsBatchfunc (*PartialResultSet) GetResumeToken
func (x *PartialResultSet) GetResumeToken() []bytefunc (*PartialResultSet) ProtoMessage
func (*PartialResultSet) ProtoMessage()func (*PartialResultSet) ProtoReflect
func (x *PartialResultSet) ProtoReflect() protoreflect.Messagefunc (*PartialResultSet) Reset
func (x *PartialResultSet) Reset()func (*PartialResultSet) String
func (x *PartialResultSet) String() stringPartialResultSet_ProtoRowsBatch
type PartialResultSet_ProtoRowsBatch struct {
// Partial rows in serialized ProtoRows format.
ProtoRowsBatch *ProtoRowsBatch `protobuf:"bytes,3,opt,name=proto_rows_batch,json=protoRowsBatch,proto3,oneof"`
}PingAndWarmRequest
type PingAndWarmRequest struct {
// Required. The unique name of the instance to check permissions for as well
// as respond. Values are of the form
// `projects/Request message for client connection keep-alive and warming.
func (*PingAndWarmRequest) Descriptor
func (*PingAndWarmRequest) Descriptor() ([]byte, []int)Deprecated: Use PingAndWarmRequest.ProtoReflect.Descriptor instead.
func (*PingAndWarmRequest) GetAppProfileId
func (x *PingAndWarmRequest) GetAppProfileId() stringfunc (*PingAndWarmRequest) GetName
func (x *PingAndWarmRequest) GetName() stringfunc (*PingAndWarmRequest) ProtoMessage
func (*PingAndWarmRequest) ProtoMessage()func (*PingAndWarmRequest) ProtoReflect
func (x *PingAndWarmRequest) ProtoReflect() protoreflect.Messagefunc (*PingAndWarmRequest) Reset
func (x *PingAndWarmRequest) Reset()func (*PingAndWarmRequest) String
func (x *PingAndWarmRequest) String() stringPingAndWarmResponse
type PingAndWarmResponse struct {
// contains filtered or unexported fields
}Response message for Bigtable.PingAndWarm connection keepalive and warming.
func (*PingAndWarmResponse) Descriptor
func (*PingAndWarmResponse) Descriptor() ([]byte, []int)Deprecated: Use PingAndWarmResponse.ProtoReflect.Descriptor instead.
func (*PingAndWarmResponse) ProtoMessage
func (*PingAndWarmResponse) ProtoMessage()func (*PingAndWarmResponse) ProtoReflect
func (x *PingAndWarmResponse) ProtoReflect() protoreflect.Messagefunc (*PingAndWarmResponse) Reset
func (x *PingAndWarmResponse) Reset()func (*PingAndWarmResponse) String
func (x *PingAndWarmResponse) String() stringProtoFormat
type ProtoFormat struct {
// contains filtered or unexported fields
}Protocol buffers format descriptor, as described by Messages ProtoSchema and ProtoRows
func (*ProtoFormat) Descriptor
func (*ProtoFormat) Descriptor() ([]byte, []int)Deprecated: Use ProtoFormat.ProtoReflect.Descriptor instead.
func (*ProtoFormat) ProtoMessage
func (*ProtoFormat) ProtoMessage()func (*ProtoFormat) ProtoReflect
func (x *ProtoFormat) ProtoReflect() protoreflect.Messagefunc (*ProtoFormat) Reset
func (x *ProtoFormat) Reset()func (*ProtoFormat) String
func (x *ProtoFormat) String() stringProtoRows
type ProtoRows struct {
// A proto rows message consists of a list of values. Every N complete values
// defines a row, where N is equal to the number of entries in the
// `metadata.proto_schema.columns` value received in the first response.
Values []*Value `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}Rows represented in proto format.
This should be constructed by concatenating the batch_data from each
of the relevant ProtoRowsBatch messages and parsing the result as a
ProtoRows message.
func (*ProtoRows) Descriptor
Deprecated: Use ProtoRows.ProtoReflect.Descriptor instead.
func (*ProtoRows) GetValues
func (*ProtoRows) ProtoMessage
func (*ProtoRows) ProtoMessage()func (*ProtoRows) ProtoReflect
func (x *ProtoRows) ProtoReflect() protoreflect.Messagefunc (*ProtoRows) Reset
func (x *ProtoRows) Reset()func (*ProtoRows) String
ProtoRowsBatch
type ProtoRowsBatch struct {
// Merge partial results by concatenating these bytes, then parsing the
// overall value as a `ProtoRows` message.
BatchData []byte `protobuf:"bytes,1,opt,name=batch_data,json=batchData,proto3" json:"batch_data,omitempty"`
// contains filtered or unexported fields
}Batch of serialized ProtoRows.
func (*ProtoRowsBatch) Descriptor
func (*ProtoRowsBatch) Descriptor() ([]byte, []int)Deprecated: Use ProtoRowsBatch.ProtoReflect.Descriptor instead.
func (*ProtoRowsBatch) GetBatchData
func (x *ProtoRowsBatch) GetBatchData() []bytefunc (*ProtoRowsBatch) ProtoMessage
func (*ProtoRowsBatch) ProtoMessage()func (*ProtoRowsBatch) ProtoReflect
func (x *ProtoRowsBatch) ProtoReflect() protoreflect.Messagefunc (*ProtoRowsBatch) Reset
func (x *ProtoRowsBatch) Reset()func (*ProtoRowsBatch) String
func (x *ProtoRowsBatch) String() stringProtoSchema
type ProtoSchema struct {
// The columns in the result set.
Columns []*ColumnMetadata `protobuf:"bytes,1,rep,name=columns,proto3" json:"columns,omitempty"`
// contains filtered or unexported fields
}ResultSet schema in proto format
func (*ProtoSchema) Descriptor
func (*ProtoSchema) Descriptor() ([]byte, []int)Deprecated: Use ProtoSchema.ProtoReflect.Descriptor instead.
func (*ProtoSchema) GetColumns
func (x *ProtoSchema) GetColumns() []*ColumnMetadatafunc (*ProtoSchema) ProtoMessage
func (*ProtoSchema) ProtoMessage()func (*ProtoSchema) ProtoReflect
func (x *ProtoSchema) ProtoReflect() protoreflect.Messagefunc (*ProtoSchema) Reset
func (x *ProtoSchema) Reset()func (*ProtoSchema) String
func (x *ProtoSchema) String() stringRateLimitInfo
type RateLimitInfo struct {
// Time that clients should wait before adjusting the target rate again.
// If clients adjust rate too frequently, the impact of the previous
// adjustment may not have been taken into account and may
// over-throttle or under-throttle. If clients adjust rate too slowly, they
// will not be responsive to load changes on server side, and may
// over-throttle or under-throttle.
Period *durationpb.Duration `protobuf:"bytes,1,opt,name=period,proto3" json:"period,omitempty"`
// If it has been at least one `period` since the last load adjustment, the
// client should multiply the current load by this value to get the new target
// load. For example, if the current load is 100 and `factor` is 0.8, the new
// target load should be 80. After adjusting, the client should ignore
// `factor` until another `period` has passed.
//
// The client can measure its load using any unit that's comparable over time
// For example, QPS can be used as long as each request involves a similar
// amount of work.
Factor float64 `protobuf:"fixed64,2,opt,name=factor,proto3" json:"factor,omitempty"`
// contains filtered or unexported fields
}Information about how client should adjust the load to Bigtable.
func (*RateLimitInfo) Descriptor
func (*RateLimitInfo) Descriptor() ([]byte, []int)Deprecated: Use RateLimitInfo.ProtoReflect.Descriptor instead.
func (*RateLimitInfo) GetFactor
func (x *RateLimitInfo) GetFactor() float64func (*RateLimitInfo) GetPeriod
func (x *RateLimitInfo) GetPeriod() *durationpb.Durationfunc (*RateLimitInfo) ProtoMessage
func (*RateLimitInfo) ProtoMessage()func (*RateLimitInfo) ProtoReflect
func (x *RateLimitInfo) ProtoReflect() protoreflect.Messagefunc (*RateLimitInfo) Reset
func (x *RateLimitInfo) Reset()func (*RateLimitInfo) String
func (x *RateLimitInfo) String() stringReadChangeStreamRequest
type ReadChangeStreamRequest struct {
// Required. The unique name of the table from which to read a change stream.
// Values are of the form
// `projects/NOTE: This API is intended to be used by Apache Beam BigtableIO. Request message for Bigtable.ReadChangeStream.
func (*ReadChangeStreamRequest) Descriptor
func (*ReadChangeStreamRequest) Descriptor() ([]byte, []int)Deprecated: Use ReadChangeStreamRequest.ProtoReflect.Descriptor instead.
func (*ReadChangeStreamRequest) GetAppProfileId
func (x *ReadChangeStreamRequest) GetAppProfileId() stringfunc (*ReadChangeStreamRequest) GetContinuationTokens
func (x *ReadChangeStreamRequest) GetContinuationTokens() *StreamContinuationTokensfunc (*ReadChangeStreamRequest) GetEndTime
func (x *ReadChangeStreamRequest) GetEndTime() *timestamppb.Timestampfunc (*ReadChangeStreamRequest) GetHeartbeatDuration
func (x *ReadChangeStreamRequest) GetHeartbeatDuration() *durationpb.Durationfunc (*ReadChangeStreamRequest) GetPartition
func (x *ReadChangeStreamRequest) GetPartition() *StreamPartitionfunc (*ReadChangeStreamRequest) GetStartFrom
func (m *ReadChangeStreamRequest) GetStartFrom() isReadChangeStreamRequest_StartFromfunc (*ReadChangeStreamRequest) GetStartTime
func (x *ReadChangeStreamRequest) GetStartTime() *timestamppb.Timestampfunc (*ReadChangeStreamRequest) GetTableName
func (x *ReadChangeStreamRequest) GetTableName() stringfunc (*ReadChangeStreamRequest) ProtoMessage
func (*ReadChangeStreamRequest) ProtoMessage()func (*ReadChangeStreamRequest) ProtoReflect
func (x *ReadChangeStreamRequest) ProtoReflect() protoreflect.Messagefunc (*ReadChangeStreamRequest) Reset
func (x *ReadChangeStreamRequest) Reset()func (*ReadChangeStreamRequest) String
func (x *ReadChangeStreamRequest) String() stringReadChangeStreamRequest_ContinuationTokens
type ReadChangeStreamRequest_ContinuationTokens struct {
// Tokens that describe how to resume reading a stream where reading
// previously left off. If specified, changes will be read starting at the
// the position. Tokens are delivered on the stream as part of `Heartbeat`
// and `CloseStream` messages.
//
// If a single token is provided, the token’s partition must exactly match
// the request’s partition. If multiple tokens are provided, as in the case
// of a partition merge, the union of the token partitions must exactly
// cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
// returned.
ContinuationTokens *StreamContinuationTokens `protobuf:"bytes,6,opt,name=continuation_tokens,json=continuationTokens,proto3,oneof"`
}ReadChangeStreamRequest_StartTime
type ReadChangeStreamRequest_StartTime struct {
// Start reading the stream at the specified timestamp. This timestamp must
// be within the change stream retention period, less than or equal to the
// current time, and after change stream creation, whichever is greater.
// This value is inclusive and will be truncated to microsecond granularity.
StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3,oneof"`
}ReadChangeStreamResponse
type ReadChangeStreamResponse struct {
// The data or control message on the stream.
//
// Types that are assignable to StreamRecord:
//
// *ReadChangeStreamResponse_DataChange_
// *ReadChangeStreamResponse_Heartbeat_
// *ReadChangeStreamResponse_CloseStream_
StreamRecord isReadChangeStreamResponse_StreamRecord `protobuf_oneof:"stream_record"`
// contains filtered or unexported fields
}NOTE: This API is intended to be used by Apache Beam BigtableIO. Response message for Bigtable.ReadChangeStream.
func (*ReadChangeStreamResponse) Descriptor
func (*ReadChangeStreamResponse) Descriptor() ([]byte, []int)Deprecated: Use ReadChangeStreamResponse.ProtoReflect.Descriptor instead.
func (*ReadChangeStreamResponse) GetCloseStream
func (x *ReadChangeStreamResponse) GetCloseStream() *ReadChangeStreamResponse_CloseStreamfunc (*ReadChangeStreamResponse) GetDataChange
func (x *ReadChangeStreamResponse) GetDataChange() *ReadChangeStreamResponse_DataChangefunc (*ReadChangeStreamResponse) GetHeartbeat
func (x *ReadChangeStreamResponse) GetHeartbeat() *ReadChangeStreamResponse_Heartbeatfunc (*ReadChangeStreamResponse) GetStreamRecord
func (m *ReadChangeStreamResponse) GetStreamRecord() isReadChangeStreamResponse_StreamRecordfunc (*ReadChangeStreamResponse) ProtoMessage
func (*ReadChangeStreamResponse) ProtoMessage()func (*ReadChangeStreamResponse) ProtoReflect
func (x *ReadChangeStreamResponse) ProtoReflect() protoreflect.Messagefunc (*ReadChangeStreamResponse) Reset
func (x *ReadChangeStreamResponse) Reset()func (*ReadChangeStreamResponse) String
func (x *ReadChangeStreamResponse) String() stringReadChangeStreamResponse_CloseStream
type ReadChangeStreamResponse_CloseStream struct {
// The status of the stream.
Status *status.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
// If non-empty, contains the information needed to resume reading their
// associated partitions.
ContinuationTokens []*StreamContinuationToken `protobuf:"bytes,2,rep,name=continuation_tokens,json=continuationTokens,proto3" json:"continuation_tokens,omitempty"`
// If non-empty, contains the new partitions to start reading from, which
// are related to but not necessarily identical to the partitions for the
// above `continuation_tokens`.
NewPartitions []*StreamPartition `protobuf:"bytes,3,rep,name=new_partitions,json=newPartitions,proto3" json:"new_partitions,omitempty"`
// contains filtered or unexported fields
}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).
func (*ReadChangeStreamResponse_CloseStream) Descriptor
func (*ReadChangeStreamResponse_CloseStream) Descriptor() ([]byte, []int)Deprecated: Use ReadChangeStreamResponse_CloseStream.ProtoReflect.Descriptor instead.
func (*ReadChangeStreamResponse_CloseStream) GetContinuationTokens
func (x *ReadChangeStreamResponse_CloseStream) GetContinuationTokens() []*StreamContinuationTokenfunc (*ReadChangeStreamResponse_CloseStream) GetNewPartitions
func (x *ReadChangeStreamResponse_CloseStream) GetNewPartitions() []*StreamPartitionfunc (*ReadChangeStreamResponse_CloseStream) GetStatus
func (x *ReadChangeStreamResponse_CloseStream) GetStatus() *status.Statusfunc (*ReadChangeStreamResponse_CloseStream) ProtoMessage
func (*ReadChangeStreamResponse_CloseStream) ProtoMessage()func (*ReadChangeStreamResponse_CloseStream) ProtoReflect
func (x *ReadChangeStreamResponse_CloseStream) ProtoReflect() protoreflect.Messagefunc (*ReadChangeStreamResponse_CloseStream) Reset
func (x *ReadChangeStreamResponse_CloseStream) Reset()func (*ReadChangeStreamResponse_CloseStream) String
func (x *ReadChangeStreamResponse_CloseStream) String() stringReadChangeStreamResponse_CloseStream_
type ReadChangeStreamResponse_CloseStream_ struct {
// An indication that the stream should be closed.
CloseStream *ReadChangeStreamResponse_CloseStream `protobuf:"bytes,3,opt,name=close_stream,json=closeStream,proto3,oneof"`
}ReadChangeStreamResponse_DataChange
type ReadChangeStreamResponse_DataChange struct {
Type ReadChangeStreamResponse_DataChange_Type "" /* 127 byte string literal not displayed */
SourceClusterId string `protobuf:"bytes,2,opt,name=source_cluster_id,json=sourceClusterId,proto3" json:"source_cluster_id,omitempty"`
RowKey []byte `protobuf:"bytes,3,opt,name=row_key,json=rowKey,proto3" json:"row_key,omitempty"`
CommitTimestamp *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=commit_timestamp,json=commitTimestamp,proto3" json:"commit_timestamp,omitempty"`
Tiebreaker int32 `protobuf:"varint,5,opt,name=tiebreaker,proto3" json:"tiebreaker,omitempty"`
Chunks []*ReadChangeStreamResponse_MutationChunk `protobuf:"bytes,6,rep,name=chunks,proto3" json:"chunks,omitempty"`
Done bool `protobuf:"varint,8,opt,name=done,proto3" json:"done,omitempty"`
Token string `protobuf:"bytes,9,opt,name=token,proto3" json:"token,omitempty"`
EstimatedLowWatermark *timestamppb.Timestamp "" /* 127 byte string literal not displayed */
}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.
func (*ReadChangeStreamResponse_DataChange) Descriptor
func (*ReadChangeStreamResponse_DataChange) Descriptor() ([]byte, []int)Deprecated: Use ReadChangeStreamResponse_DataChange.ProtoReflect.Descriptor instead.
func (*ReadChangeStreamResponse_DataChange) GetChunks
func (x *ReadChangeStreamResponse_DataChange) GetChunks() []*ReadChangeStreamResponse_MutationChunkfunc (*ReadChangeStreamResponse_DataChange) GetCommitTimestamp
func (x *ReadChangeStreamResponse_DataChange) GetCommitTimestamp() *timestamppb.Timestampfunc (*ReadChangeStreamResponse_DataChange) GetDone
func (x *ReadChangeStreamResponse_DataChange) GetDone() boolfunc (*ReadChangeStreamResponse_DataChange) GetEstimatedLowWatermark
func (x *ReadChangeStreamResponse_DataChange) GetEstimatedLowWatermark() *timestamppb.Timestampfunc (*ReadChangeStreamResponse_DataChange) GetRowKey
func (x *ReadChangeStreamResponse_DataChange) GetRowKey() []bytefunc (*ReadChangeStreamResponse_DataChange) GetSourceClusterId
func (x *ReadChangeStreamResponse_DataChange) GetSourceClusterId() stringfunc (*ReadChangeStreamResponse_DataChange) GetTiebreaker
func (x *ReadChangeStreamResponse_DataChange) GetTiebreaker() int32func (*ReadChangeStreamResponse_DataChange) GetToken
func (x *ReadChangeStreamResponse_DataChange) GetToken() stringfunc (*ReadChangeStreamResponse_DataChange) GetType
func (x *ReadChangeStreamResponse_DataChange) GetType() ReadChangeStreamResponse_DataChange_Typefunc (*ReadChangeStreamResponse_DataChange) ProtoMessage
func (*ReadChangeStreamResponse_DataChange) ProtoMessage()func (*ReadChangeStreamResponse_DataChange) ProtoReflect
func (x *ReadChangeStreamResponse_DataChange) ProtoReflect() protoreflect.Messagefunc (*ReadChangeStreamResponse_DataChange) Reset
func (x *ReadChangeStreamResponse_DataChange) Reset()func (*ReadChangeStreamResponse_DataChange) String
func (x *ReadChangeStreamResponse_DataChange) String() stringReadChangeStreamResponse_DataChange_
type ReadChangeStreamResponse_DataChange_ struct {
// A mutation to the partition.
DataChange *ReadChangeStreamResponse_DataChange `protobuf:"bytes,1,opt,name=data_change,json=dataChange,proto3,oneof"`
}ReadChangeStreamResponse_DataChange_Type
type ReadChangeStreamResponse_DataChange_Type int32The type of mutation.
ReadChangeStreamResponse_DataChange_TYPE_UNSPECIFIED, ReadChangeStreamResponse_DataChange_USER, ReadChangeStreamResponse_DataChange_GARBAGE_COLLECTION, ReadChangeStreamResponse_DataChange_CONTINUATION
const (
// The type is unspecified.
ReadChangeStreamResponse_DataChange_TYPE_UNSPECIFIED ReadChangeStreamResponse_DataChange_Type = 0
// A user-initiated mutation.
ReadChangeStreamResponse_DataChange_USER ReadChangeStreamResponse_DataChange_Type = 1
// A system-initiated mutation as part of garbage collection.
// https://cloud.google.com/bigtable/docs/garbage-collection
ReadChangeStreamResponse_DataChange_GARBAGE_COLLECTION ReadChangeStreamResponse_DataChange_Type = 2
// This is a continuation of a multi-message change.
ReadChangeStreamResponse_DataChange_CONTINUATION ReadChangeStreamResponse_DataChange_Type = 3
)func (ReadChangeStreamResponse_DataChange_Type) Descriptor
func (ReadChangeStreamResponse_DataChange_Type) Descriptor() protoreflect.EnumDescriptorfunc (ReadChangeStreamResponse_DataChange_Type) Enum
func (ReadChangeStreamResponse_DataChange_Type) EnumDescriptor
func (ReadChangeStreamResponse_DataChange_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use ReadChangeStreamResponse_DataChange_Type.Descriptor instead.
func (ReadChangeStreamResponse_DataChange_Type) Number
func (x ReadChangeStreamResponse_DataChange_Type) Number() protoreflect.EnumNumberfunc (ReadChangeStreamResponse_DataChange_Type) String
func (x ReadChangeStreamResponse_DataChange_Type) String() stringfunc (ReadChangeStreamResponse_DataChange_Type) Type
func (ReadChangeStreamResponse_DataChange_Type) Type() protoreflect.EnumTypeReadChangeStreamResponse_Heartbeat
type ReadChangeStreamResponse_Heartbeat struct {
// A token that can be provided to a subsequent `ReadChangeStream` call
// to pick up reading at the current stream position.
ContinuationToken *StreamContinuationToken `protobuf:"bytes,1,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
// An estimate of the commit timestamp that is usually lower than or equal
// to any timestamp for a record that will be delivered in the future on the
// stream. It is possible that, under particular circumstances that a future
// record has a timestamp is is lower than a previously seen timestamp. For
// an example usage see
// https://beam.apache.org/documentation/basics/#watermarks
EstimatedLowWatermark *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=estimated_low_watermark,json=estimatedLowWatermark,proto3" json:"estimated_low_watermark,omitempty"`
// contains filtered or unexported fields
}A periodic message with information that can be used to checkpoint the state of a stream.
func (*ReadChangeStreamResponse_Heartbeat) Descriptor
func (*ReadChangeStreamResponse_Heartbeat) Descriptor() ([]byte, []int)Deprecated: Use ReadChangeStreamResponse_Heartbeat.ProtoReflect.Descriptor instead.
func (*ReadChangeStreamResponse_Heartbeat) GetContinuationToken
func (x *ReadChangeStreamResponse_Heartbeat) GetContinuationToken() *StreamContinuationTokenfunc (*ReadChangeStreamResponse_Heartbeat) GetEstimatedLowWatermark
func (x *ReadChangeStreamResponse_Heartbeat) GetEstimatedLowWatermark() *timestamppb.Timestampfunc (*ReadChangeStreamResponse_Heartbeat) ProtoMessage
func (*ReadChangeStreamResponse_Heartbeat) ProtoMessage()func (*ReadChangeStreamResponse_Heartbeat) ProtoReflect
func (x *ReadChangeStreamResponse_Heartbeat) ProtoReflect() protoreflect.Messagefunc (*ReadChangeStreamResponse_Heartbeat) Reset
func (x *ReadChangeStreamResponse_Heartbeat) Reset()func (*ReadChangeStreamResponse_Heartbeat) String
func (x *ReadChangeStreamResponse_Heartbeat) String() stringReadChangeStreamResponse_Heartbeat_
type ReadChangeStreamResponse_Heartbeat_ struct {
// A periodic heartbeat message.
Heartbeat *ReadChangeStreamResponse_Heartbeat `protobuf:"bytes,2,opt,name=heartbeat,proto3,oneof"`
}ReadChangeStreamResponse_MutationChunk
type ReadChangeStreamResponse_MutationChunk struct {
// If set, then the mutation is a `SetCell` with a chunked value across
// multiple messages.
ChunkInfo *ReadChangeStreamResponse_MutationChunk_ChunkInfo `protobuf:"bytes,1,opt,name=chunk_info,json=chunkInfo,proto3" json:"chunk_info,omitempty"`
// If this is a continuation of a chunked message (`chunked_value_offset` >
// 0), ignore all fields except the `SetCell`'s value and merge it with
// the previous message by concatenating the value fields.
Mutation *Mutation `protobuf:"bytes,2,opt,name=mutation,proto3" json:"mutation,omitempty"`
// contains filtered or unexported fields
}A partial or complete mutation.
func (*ReadChangeStreamResponse_MutationChunk) Descriptor
func (*ReadChangeStreamResponse_MutationChunk) Descriptor() ([]byte, []int)Deprecated: Use ReadChangeStreamResponse_MutationChunk.ProtoReflect.Descriptor instead.
func (*ReadChangeStreamResponse_MutationChunk) GetChunkInfo
func (x *ReadChangeStreamResponse_MutationChunk) GetChunkInfo() *ReadChangeStreamResponse_MutationChunk_ChunkInfofunc (*ReadChangeStreamResponse_MutationChunk) GetMutation
func (x *ReadChangeStreamResponse_MutationChunk) GetMutation() *Mutationfunc (*ReadChangeStreamResponse_MutationChunk) ProtoMessage
func (*ReadChangeStreamResponse_MutationChunk) ProtoMessage()func (*ReadChangeStreamResponse_MutationChunk) ProtoReflect
func (x *ReadChangeStreamResponse_MutationChunk) ProtoReflect() protoreflect.Messagefunc (*ReadChangeStreamResponse_MutationChunk) Reset
func (x *ReadChangeStreamResponse_MutationChunk) Reset()func (*ReadChangeStreamResponse_MutationChunk) String
func (x *ReadChangeStreamResponse_MutationChunk) String() stringReadChangeStreamResponse_MutationChunk_ChunkInfo
type ReadChangeStreamResponse_MutationChunk_ChunkInfo struct {
// The total value size of all the chunks that make up the `SetCell`.
ChunkedValueSize int32 `protobuf:"varint,1,opt,name=chunked_value_size,json=chunkedValueSize,proto3" json:"chunked_value_size,omitempty"`
// The byte offset of this chunk into the total value size of the
// mutation.
ChunkedValueOffset int32 `protobuf:"varint,2,opt,name=chunked_value_offset,json=chunkedValueOffset,proto3" json:"chunked_value_offset,omitempty"`
// When true, this is the last chunk of a chunked `SetCell`.
LastChunk bool `protobuf:"varint,3,opt,name=last_chunk,json=lastChunk,proto3" json:"last_chunk,omitempty"`
// contains filtered or unexported fields
}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.
func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) Descriptor
func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) Descriptor() ([]byte, []int)Deprecated: Use ReadChangeStreamResponse_MutationChunk_ChunkInfo.ProtoReflect.Descriptor instead.
func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetChunkedValueOffset
func (x *ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetChunkedValueOffset() int32func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetChunkedValueSize
func (x *ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetChunkedValueSize() int32func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetLastChunk
func (x *ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetLastChunk() boolfunc (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) ProtoMessage
func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) ProtoMessage()func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) ProtoReflect
func (x *ReadChangeStreamResponse_MutationChunk_ChunkInfo) ProtoReflect() protoreflect.Messagefunc (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) Reset
func (x *ReadChangeStreamResponse_MutationChunk_ChunkInfo) Reset()func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) String
func (x *ReadChangeStreamResponse_MutationChunk_ChunkInfo) String() stringReadIterationStats
type ReadIterationStats struct {
// The rows seen (scanned) as part of the request. This includes the count of
// rows returned, as captured below.
RowsSeenCount int64 `protobuf:"varint,1,opt,name=rows_seen_count,json=rowsSeenCount,proto3" json:"rows_seen_count,omitempty"`
// The rows returned as part of the request.
RowsReturnedCount int64 `protobuf:"varint,2,opt,name=rows_returned_count,json=rowsReturnedCount,proto3" json:"rows_returned_count,omitempty"`
// The cells seen (scanned) as part of the request. This includes the count of
// cells returned, as captured below.
CellsSeenCount int64 `protobuf:"varint,3,opt,name=cells_seen_count,json=cellsSeenCount,proto3" json:"cells_seen_count,omitempty"`
// The cells returned as part of the request.
CellsReturnedCount int64 `protobuf:"varint,4,opt,name=cells_returned_count,json=cellsReturnedCount,proto3" json:"cells_returned_count,omitempty"`
// contains filtered or unexported fields
}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.
func (*ReadIterationStats) Descriptor
func (*ReadIterationStats) Descriptor() ([]byte, []int)Deprecated: Use ReadIterationStats.ProtoReflect.Descriptor instead.
func (*ReadIterationStats) GetCellsReturnedCount
func (x *ReadIterationStats) GetCellsReturnedCount() int64func (*ReadIterationStats) GetCellsSeenCount
func (x *ReadIterationStats) GetCellsSeenCount() int64func (*ReadIterationStats) GetRowsReturnedCount
func (x *ReadIterationStats) GetRowsReturnedCount() int64func (*ReadIterationStats) GetRowsSeenCount
func (x *ReadIterationStats) GetRowsSeenCount() int64func (*ReadIterationStats) ProtoMessage
func (*ReadIterationStats) ProtoMessage()func (*ReadIterationStats) ProtoReflect
func (x *ReadIterationStats) ProtoReflect() protoreflect.Messagefunc (*ReadIterationStats) Reset
func (x *ReadIterationStats) Reset()func (*ReadIterationStats) String
func (x *ReadIterationStats) String() stringReadModifyWriteRowRequest
type ReadModifyWriteRowRequest struct {
// Optional. The unique name of the table to which the read/modify/write rules
// should be applied.
//
// Values are of the form
// `projects/Request message for Bigtable.ReadModifyWriteRow.
func (*ReadModifyWriteRowRequest) Descriptor
func (*ReadModifyWriteRowRequest) Descriptor() ([]byte, []int)Deprecated: Use ReadModifyWriteRowRequest.ProtoReflect.Descriptor instead.
func (*ReadModifyWriteRowRequest) GetAppProfileId
func (x *ReadModifyWriteRowRequest) GetAppProfileId() stringfunc (*ReadModifyWriteRowRequest) GetAuthorizedViewName
func (x *ReadModifyWriteRowRequest) GetAuthorizedViewName() stringfunc (*ReadModifyWriteRowRequest) GetRowKey
func (x *ReadModifyWriteRowRequest) GetRowKey() []bytefunc (*ReadModifyWriteRowRequest) GetRules
func (x *ReadModifyWriteRowRequest) GetRules() []*ReadModifyWriteRulefunc (*ReadModifyWriteRowRequest) GetTableName
func (x *ReadModifyWriteRowRequest) GetTableName() stringfunc (*ReadModifyWriteRowRequest) ProtoMessage
func (*ReadModifyWriteRowRequest) ProtoMessage()func (*ReadModifyWriteRowRequest) ProtoReflect
func (x *ReadModifyWriteRowRequest) ProtoReflect() protoreflect.Messagefunc (*ReadModifyWriteRowRequest) Reset
func (x *ReadModifyWriteRowRequest) Reset()func (*ReadModifyWriteRowRequest) String
func (x *ReadModifyWriteRowRequest) String() stringReadModifyWriteRowResponse
type ReadModifyWriteRowResponse struct {
// A Row containing the new contents of all cells modified by the request.
Row *Row `protobuf:"bytes,1,opt,name=row,proto3" json:"row,omitempty"`
// contains filtered or unexported fields
}Response message for Bigtable.ReadModifyWriteRow.
func (*ReadModifyWriteRowResponse) Descriptor
func (*ReadModifyWriteRowResponse) Descriptor() ([]byte, []int)Deprecated: Use ReadModifyWriteRowResponse.ProtoReflect.Descriptor instead.
func (*ReadModifyWriteRowResponse) GetRow
func (x *ReadModifyWriteRowResponse) GetRow() *Rowfunc (*ReadModifyWriteRowResponse) ProtoMessage
func (*ReadModifyWriteRowResponse) ProtoMessage()func (*ReadModifyWriteRowResponse) ProtoReflect
func (x *ReadModifyWriteRowResponse) ProtoReflect() protoreflect.Messagefunc (*ReadModifyWriteRowResponse) Reset
func (x *ReadModifyWriteRowResponse) Reset()func (*ReadModifyWriteRowResponse) String
func (x *ReadModifyWriteRowResponse) String() stringReadModifyWriteRule
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=familyName,proto3" 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,json=columnQualifier,proto3" json:"column_qualifier,omitempty"`
// The rule used to determine the column's new latest value from its current
// latest value.
//
// Types that are assignable to Rule:
//
// *ReadModifyWriteRule_AppendValue
// *ReadModifyWriteRule_IncrementAmount
Rule isReadModifyWriteRule_Rule `protobuf_oneof:"rule"`
// contains filtered or unexported fields
}Specifies an atomic read/modify/write operation on the latest value of the specified column.
func (*ReadModifyWriteRule) Descriptor
func (*ReadModifyWriteRule) Descriptor() ([]byte, []int)Deprecated: Use ReadModifyWriteRule.ProtoReflect.Descriptor instead.
func (*ReadModifyWriteRule) GetAppendValue
func (x *ReadModifyWriteRule) GetAppendValue() []bytefunc (*ReadModifyWriteRule) GetColumnQualifier
func (x *ReadModifyWriteRule) GetColumnQualifier() []bytefunc (*ReadModifyWriteRule) GetFamilyName
func (x *ReadModifyWriteRule) GetFamilyName() stringfunc (*ReadModifyWriteRule) GetIncrementAmount
func (x *ReadModifyWriteRule) GetIncrementAmount() int64func (*ReadModifyWriteRule) GetRule
func (m *ReadModifyWriteRule) GetRule() isReadModifyWriteRule_Rulefunc (*ReadModifyWriteRule) ProtoMessage
func (*ReadModifyWriteRule) ProtoMessage()func (*ReadModifyWriteRule) ProtoReflect
func (x *ReadModifyWriteRule) ProtoReflect() protoreflect.Messagefunc (*ReadModifyWriteRule) Reset
func (x *ReadModifyWriteRule) Reset()func (*ReadModifyWriteRule) String
func (x *ReadModifyWriteRule) String() stringReadModifyWriteRule_AppendValue
type ReadModifyWriteRule_AppendValue struct {
// Rule specifying that `append_value` be appended to the existing value.
// If the targeted cell is unset, it will be treated as containing the
// empty string.
AppendValue []byte `protobuf:"bytes,3,opt,name=append_value,json=appendValue,proto3,oneof"`
}ReadModifyWriteRule_IncrementAmount
type ReadModifyWriteRule_IncrementAmount struct {
// Rule specifying that `increment_amount` be added to the existing value.
// If the targeted cell is unset, it will be treated as containing a zero.
// Otherwise, the targeted cell must contain an 8-byte value (interpreted
// as a 64-bit big-endian signed integer), or the entire request will fail.
IncrementAmount int64 `protobuf:"varint,4,opt,name=increment_amount,json=incrementAmount,proto3,oneof"`
}ReadRowsRequest
type ReadRowsRequest struct {
TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
AuthorizedViewName string `protobuf:"bytes,9,opt,name=authorized_view_name,json=authorizedViewName,proto3" json:"authorized_view_name,omitempty"`
AppProfileId string `protobuf:"bytes,5,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
Rows *RowSet `protobuf:"bytes,2,opt,name=rows,proto3" json:"rows,omitempty"`
Filter *RowFilter `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
RowsLimit int64 `protobuf:"varint,4,opt,name=rows_limit,json=rowsLimit,proto3" json:"rows_limit,omitempty"`
RequestStatsView ReadRowsRequest_RequestStatsView "" /* 169 byte string literal not displayed */
Reversed bool `protobuf:"varint,7,opt,name=reversed,proto3" json:"reversed,omitempty"`
}Request message for Bigtable.ReadRows.
func (*ReadRowsRequest) Descriptor
func (*ReadRowsRequest) Descriptor() ([]byte, []int)Deprecated: Use ReadRowsRequest.ProtoReflect.Descriptor instead.
func (*ReadRowsRequest) GetAppProfileId
func (x *ReadRowsRequest) GetAppProfileId() stringfunc (*ReadRowsRequest) GetAuthorizedViewName
func (x *ReadRowsRequest) GetAuthorizedViewName() stringfunc (*ReadRowsRequest) GetFilter
func (x *ReadRowsRequest) GetFilter() *RowFilterfunc (*ReadRowsRequest) GetRequestStatsView
func (x *ReadRowsRequest) GetRequestStatsView() ReadRowsRequest_RequestStatsViewfunc (*ReadRowsRequest) GetReversed
func (x *ReadRowsRequest) GetReversed() boolfunc (*ReadRowsRequest) GetRows
func (x *ReadRowsRequest) GetRows() *RowSetfunc (*ReadRowsRequest) GetRowsLimit
func (x *ReadRowsRequest) GetRowsLimit() int64func (*ReadRowsRequest) GetTableName
func (x *ReadRowsRequest) GetTableName() stringfunc (*ReadRowsRequest) ProtoMessage
func (*ReadRowsRequest) ProtoMessage()func (*ReadRowsRequest) ProtoReflect
func (x *ReadRowsRequest) ProtoReflect() protoreflect.Messagefunc (*ReadRowsRequest) Reset
func (x *ReadRowsRequest) Reset()func (*ReadRowsRequest) String
func (x *ReadRowsRequest) String() stringReadRowsRequest_RequestStatsView
type ReadRowsRequest_RequestStatsView int32The desired view into RequestStats that should be returned in the response.
See also: RequestStats message.
ReadRowsRequest_REQUEST_STATS_VIEW_UNSPECIFIED, ReadRowsRequest_REQUEST_STATS_NONE, ReadRowsRequest_REQUEST_STATS_FULL
const (
// The default / unset value. The API will default to the NONE option below.
ReadRowsRequest_REQUEST_STATS_VIEW_UNSPECIFIED ReadRowsRequest_RequestStatsView = 0
// Do not include any RequestStats in the response. This will leave the
// RequestStats embedded message unset in the response.
ReadRowsRequest_REQUEST_STATS_NONE ReadRowsRequest_RequestStatsView = 1
// Include the full set of available RequestStats in the response,
// applicable to this read.
ReadRowsRequest_REQUEST_STATS_FULL ReadRowsRequest_RequestStatsView = 2
)func (ReadRowsRequest_RequestStatsView) Descriptor
func (ReadRowsRequest_RequestStatsView) Descriptor() protoreflect.EnumDescriptorfunc (ReadRowsRequest_RequestStatsView) Enum
func (x ReadRowsRequest_RequestStatsView) Enum() *ReadRowsRequest_RequestStatsViewfunc (ReadRowsRequest_RequestStatsView) EnumDescriptor
func (ReadRowsRequest_RequestStatsView) EnumDescriptor() ([]byte, []int)Deprecated: Use ReadRowsRequest_RequestStatsView.Descriptor instead.
func (ReadRowsRequest_RequestStatsView) Number
func (x ReadRowsRequest_RequestStatsView) Number() protoreflect.EnumNumberfunc (ReadRowsRequest_RequestStatsView) String
func (x ReadRowsRequest_RequestStatsView) String() stringfunc (ReadRowsRequest_RequestStatsView) Type
func (ReadRowsRequest_RequestStatsView) Type() protoreflect.EnumTypeReadRowsResponse
type ReadRowsResponse struct {
// A collection of a row's contents as part of the read request.
Chunks []*ReadRowsResponse_CellChunk `protobuf:"bytes,1,rep,name=chunks,proto3" json:"chunks,omitempty"`
// Optionally the server might return the row key of the last row it
// has scanned. The client can use this to construct a more
// efficient retry request if needed: any row keys or portions of
// ranges less than this row key can be dropped from the request.
// This is primarily useful for cases where the server has read a
// lot of data that was filtered out since the last committed row
// key, allowing the client to skip that work on a retry.
LastScannedRowKey []byte `protobuf:"bytes,2,opt,name=last_scanned_row_key,json=lastScannedRowKey,proto3" json:"last_scanned_row_key,omitempty"`
// If requested, provide enhanced query performance statistics. The semantics
// dictate:
// - request_stats is empty on every (streamed) response, except
// - request_stats has non-empty information after all chunks have been
// streamed, where the ReadRowsResponse message only contains
// request_stats.
// - For example, if a read request would have returned an empty
// response instead a single ReadRowsResponse is streamed with empty
// chunks and request_stats filled.
//
// Visually, response messages will stream as follows:
//
// ... -> {chunks: [...]} -> {chunks: [], request_stats: {...}}
// \______________________/ \________________________________/
// Primary response Trailer of RequestStats info
//
// Or if the read did not return any values:
//
// {chunks: [], request_stats: {...}}
// \________________________________/
// Trailer of RequestStats info
RequestStats *RequestStats `protobuf:"bytes,3,opt,name=request_stats,json=requestStats,proto3" json:"request_stats,omitempty"`
// contains filtered or unexported fields
}Response message for Bigtable.ReadRows.
func (*ReadRowsResponse) Descriptor
func (*ReadRowsResponse) Descriptor() ([]byte, []int)Deprecated: Use ReadRowsResponse.ProtoReflect.Descriptor instead.
func (*ReadRowsResponse) GetChunks
func (x *ReadRowsResponse) GetChunks() []*ReadRowsResponse_CellChunkfunc (*ReadRowsResponse) GetLastScannedRowKey
func (x *ReadRowsResponse) GetLastScannedRowKey() []bytefunc (*ReadRowsResponse) GetRequestStats
func (x *ReadRowsResponse) GetRequestStats() *RequestStatsfunc (*ReadRowsResponse) ProtoMessage
func (*ReadRowsResponse) ProtoMessage()func (*ReadRowsResponse) ProtoReflect
func (x *ReadRowsResponse) ProtoReflect() protoreflect.Messagefunc (*ReadRowsResponse) Reset
func (x *ReadRowsResponse) Reset()func (*ReadRowsResponse) String
func (x *ReadRowsResponse) String() stringReadRowsResponse_CellChunk
type ReadRowsResponse_CellChunk struct {
// The row key for this chunk of data. If the row key is empty,
// this CellChunk is a continuation of the same row as the previous
// CellChunk in the response stream, even if that CellChunk was in a
// previous ReadRowsResponse message.
RowKey []byte `protobuf:"bytes,1,opt,name=row_key,json=rowKey,proto3" json:"row_key,omitempty"`
// The column family name for this chunk of data. If this message
// is not present this CellChunk is a continuation of the same column
// family as the previous CellChunk. The empty string can occur as a
// column family name in a response so clients must check
// explicitly for the presence of this message, not just for
// `family_name.value` being non-empty.
FamilyName *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=family_name,json=familyName,proto3" json:"family_name,omitempty"`
// The column qualifier for this chunk of data. If this message
// is not present, this CellChunk is a continuation of the same column
// as the previous CellChunk. Column qualifiers may be empty so
// clients must check for the presence of this message, not just
// for `qualifier.value` being non-empty.
Qualifier *wrapperspb.BytesValue `protobuf:"bytes,3,opt,name=qualifier,proto3" json:"qualifier,omitempty"`
// 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. Timestamps are only set in the first CellChunk per cell
// (for cells split into multiple chunks).
TimestampMicros int64 `protobuf:"varint,4,opt,name=timestamp_micros,json=timestampMicros,proto3" json:"timestamp_micros,omitempty"`
// Labels applied to the cell by a
// [RowFilter][google.bigtable.v2.RowFilter]. Labels are only set
// on the first CellChunk per cell.
Labels []string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty"`
// The value stored in the cell. Cell values can be split across
// multiple CellChunks. In that case only the value field will be
// set in CellChunks after the first: the timestamp and labels
// will only be present in the first CellChunk, even if the first
// CellChunk came in a previous ReadRowsResponse.
Value []byte `protobuf:"bytes,6,opt,name=value,proto3" json:"value,omitempty"`
// If this CellChunk is part of a chunked cell value and this is
// not the final chunk of that cell, value_size will be set to the
// total length of the cell value. The client can use this size
// to pre-allocate memory to hold the full cell value.
ValueSize int32 `protobuf:"varint,7,opt,name=value_size,json=valueSize,proto3" json:"value_size,omitempty"`
// Signals to the client concerning previous CellChunks received.
//
// Types that are assignable to RowStatus:
//
// *ReadRowsResponse_CellChunk_ResetRow
// *ReadRowsResponse_CellChunk_CommitRow
RowStatus isReadRowsResponse_CellChunk_RowStatus `protobuf_oneof:"row_status"`
// contains filtered or unexported fields
}Specifies a piece of a row's contents returned as part of the read response stream.
func (*ReadRowsResponse_CellChunk) Descriptor
func (*ReadRowsResponse_CellChunk) Descriptor() ([]byte, []int)Deprecated: Use ReadRowsResponse_CellChunk.ProtoReflect.Descriptor instead.
func (*ReadRowsResponse_CellChunk) GetCommitRow
func (x *ReadRowsResponse_CellChunk) GetCommitRow() boolfunc (*ReadRowsResponse_CellChunk) GetFamilyName
func (x *ReadRowsResponse_CellChunk) GetFamilyName() *wrapperspb.StringValuefunc (*ReadRowsResponse_CellChunk) GetLabels
func (x *ReadRowsResponse_CellChunk) GetLabels() []stringfunc (*ReadRowsResponse_CellChunk) GetQualifier
func (x *ReadRowsResponse_CellChunk) GetQualifier() *wrapperspb.BytesValuefunc (*ReadRowsResponse_CellChunk) GetResetRow
func (x *ReadRowsResponse_CellChunk) GetResetRow() boolfunc (*ReadRowsResponse_CellChunk) GetRowKey
func (x *ReadRowsResponse_CellChunk) GetRowKey() []bytefunc (*ReadRowsResponse_CellChunk) GetRowStatus
func (m *ReadRowsResponse_CellChunk) GetRowStatus() isReadRowsResponse_CellChunk_RowStatusfunc (*ReadRowsResponse_CellChunk) GetTimestampMicros
func (x *ReadRowsResponse_CellChunk) GetTimestampMicros() int64func (*ReadRowsResponse_CellChunk) GetValue
func (x *ReadRowsResponse_CellChunk) GetValue() []bytefunc (*ReadRowsResponse_CellChunk) GetValueSize
func (x *ReadRowsResponse_CellChunk) GetValueSize() int32func (*ReadRowsResponse_CellChunk) ProtoMessage
func (*ReadRowsResponse_CellChunk) ProtoMessage()func (*ReadRowsResponse_CellChunk) ProtoReflect
func (x *ReadRowsResponse_CellChunk) ProtoReflect() protoreflect.Messagefunc (*ReadRowsResponse_CellChunk) Reset
func (x *ReadRowsResponse_CellChunk) Reset()func (*ReadRowsResponse_CellChunk) String
func (x *ReadRowsResponse_CellChunk) String() stringReadRowsResponse_CellChunk_CommitRow
type ReadRowsResponse_CellChunk_CommitRow struct {
// Indicates that the client can safely process all previous chunks for
// `row_key`, as its data has been fully read.
CommitRow bool `protobuf:"varint,9,opt,name=commit_row,json=commitRow,proto3,oneof"`
}ReadRowsResponse_CellChunk_ResetRow
type ReadRowsResponse_CellChunk_ResetRow struct {
// Indicates that the client should drop all previous chunks for
// `row_key`, as it will be re-read from the beginning.
ResetRow bool `protobuf:"varint,8,opt,name=reset_row,json=resetRow,proto3,oneof"`
}RequestLatencyStats
type RequestLatencyStats struct {
// The latency measured by the frontend server handling this request, from
// when the request was received, to when this value is sent back in the
// response. For more context on the component that is measuring this latency,
// see: https://cloud.google.com/bigtable/docs/overview
//
// Note: This value may be slightly shorter than the value reported into
// aggregate latency metrics in Monitoring for this request
// (https://cloud.google.com/bigtable/docs/monitoring-instance) as this value
// needs to be sent in the response before the latency measurement including
// that transmission is finalized.
//
// Note: This value includes the end-to-end latency of contacting nodes in
// the targeted cluster, e.g. measuring from when the first byte arrives at
// the frontend server, to when this value is sent back as the last value in
// the response, including any latency incurred by contacting nodes, waiting
// for results from nodes, and finally sending results from nodes back to the
// caller.
FrontendServerLatency *durationpb.Duration `protobuf:"bytes,1,opt,name=frontend_server_latency,json=frontendServerLatency,proto3" json:"frontend_server_latency,omitempty"`
// contains filtered or unexported fields
}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.
func (*RequestLatencyStats) Descriptor
func (*RequestLatencyStats) Descriptor() ([]byte, []int)Deprecated: Use RequestLatencyStats.ProtoReflect.Descriptor instead.
func (*RequestLatencyStats) GetFrontendServerLatency
func (x *RequestLatencyStats) GetFrontendServerLatency() *durationpb.Durationfunc (*RequestLatencyStats) ProtoMessage
func (*RequestLatencyStats) ProtoMessage()func (*RequestLatencyStats) ProtoReflect
func (x *RequestLatencyStats) ProtoReflect() protoreflect.Messagefunc (*RequestLatencyStats) Reset
func (x *RequestLatencyStats) Reset()func (*RequestLatencyStats) String
func (x *RequestLatencyStats) String() stringRequestStats
type RequestStats struct {
// Information pertaining to each request type received. The type is chosen
// based on the requested view.
//
// See the messages above for additional context.
//
// Types that are assignable to StatsView:
//
// *RequestStats_FullReadStatsView
StatsView isRequestStats_StatsView `protobuf_oneof:"stats_view"`
// contains filtered or unexported fields
}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
func (*RequestStats) Descriptor
func (*RequestStats) Descriptor() ([]byte, []int)Deprecated: Use RequestStats.ProtoReflect.Descriptor instead.
func (*RequestStats) GetFullReadStatsView
func (x *RequestStats) GetFullReadStatsView() *FullReadStatsViewfunc (*RequestStats) GetStatsView
func (m *RequestStats) GetStatsView() isRequestStats_StatsViewfunc (*RequestStats) ProtoMessage
func (*RequestStats) ProtoMessage()func (*RequestStats) ProtoReflect
func (x *RequestStats) ProtoReflect() protoreflect.Messagefunc (*RequestStats) Reset
func (x *RequestStats) Reset()func (*RequestStats) String
func (x *RequestStats) String() stringRequestStats_FullReadStatsView
type RequestStats_FullReadStatsView struct {
// Available with the ReadRowsRequest.RequestStatsView.REQUEST_STATS_FULL
// view, see package google.bigtable.v2.
FullReadStatsView *FullReadStatsView `protobuf:"bytes,1,opt,name=full_read_stats_view,json=fullReadStatsView,proto3,oneof"`
}ResponseParams
type ResponseParams struct {
// The cloud bigtable zone associated with the cluster.
ZoneId *string `protobuf:"bytes,1,opt,name=zone_id,json=zoneId,proto3,oneof" json:"zone_id,omitempty"`
// Identifier for a cluster that represents set of
// bigtable resources.
ClusterId *string `protobuf:"bytes,2,opt,name=cluster_id,json=clusterId,proto3,oneof" json:"cluster_id,omitempty"`
// contains filtered or unexported fields
}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
func (*ResponseParams) Descriptor
func (*ResponseParams) Descriptor() ([]byte, []int)Deprecated: Use ResponseParams.ProtoReflect.Descriptor instead.
func (*ResponseParams) GetClusterId
func (x *ResponseParams) GetClusterId() stringfunc (*ResponseParams) GetZoneId
func (x *ResponseParams) GetZoneId() stringfunc (*ResponseParams) ProtoMessage
func (*ResponseParams) ProtoMessage()func (*ResponseParams) ProtoReflect
func (x *ResponseParams) ProtoReflect() protoreflect.Messagefunc (*ResponseParams) Reset
func (x *ResponseParams) Reset()func (*ResponseParams) String
func (x *ResponseParams) String() stringResultSetMetadata
type ResultSetMetadata struct {
// The schema of the ResultSet, contains ordered list of column names
// with types
//
// Types that are assignable to Schema:
//
// *ResultSetMetadata_ProtoSchema
Schema isResultSetMetadata_Schema `protobuf_oneof:"schema"`
// contains filtered or unexported fields
}Describes the structure of a Bigtable result set.
func (*ResultSetMetadata) Descriptor
func (*ResultSetMetadata) Descriptor() ([]byte, []int)Deprecated: Use ResultSetMetadata.ProtoReflect.Descriptor instead.
func (*ResultSetMetadata) GetProtoSchema
func (x *ResultSetMetadata) GetProtoSchema() *ProtoSchemafunc (*ResultSetMetadata) GetSchema
func (m *ResultSetMetadata) GetSchema() isResultSetMetadata_Schemafunc (*ResultSetMetadata) ProtoMessage
func (*ResultSetMetadata) ProtoMessage()func (*ResultSetMetadata) ProtoReflect
func (x *ResultSetMetadata) ProtoReflect() protoreflect.Messagefunc (*ResultSetMetadata) Reset
func (x *ResultSetMetadata) Reset()func (*ResultSetMetadata) String
func (x *ResultSetMetadata) String() stringResultSetMetadata_ProtoSchema
type ResultSetMetadata_ProtoSchema struct {
// Schema in proto format
ProtoSchema *ProtoSchema `protobuf:"bytes,1,opt,name=proto_schema,json=protoSchema,proto3,oneof"`
}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,proto3" json:"families,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
Deprecated: Use Row.ProtoReflect.Descriptor instead.
func (*Row) GetFamilies
func (*Row) GetKey
func (*Row) ProtoMessage
func (*Row) ProtoMessage()func (*Row) ProtoReflect
func (x *Row) ProtoReflect() protoreflect.Messagefunc (*Row) Reset
func (x *Row) Reset()func (*Row) String
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 assignable 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"`
// contains filtered or unexported fields
}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\\Cin 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.
func (*RowFilter) Descriptor
Deprecated: Use RowFilter.ProtoReflect.Descriptor instead.
func (*RowFilter) GetApplyLabelTransformer
func (*RowFilter) GetBlockAllFilter
func (*RowFilter) GetCellsPerColumnLimitFilter
func (*RowFilter) GetCellsPerRowLimitFilter
func (*RowFilter) GetCellsPerRowOffsetFilter
func (*RowFilter) GetChain
func (x *RowFilter) GetChain() *RowFilter_Chainfunc (*RowFilter) GetColumnQualifierRegexFilter
func (*RowFilter) GetColumnRangeFilter
func (x *RowFilter) GetColumnRangeFilter() *ColumnRangefunc (*RowFilter) GetCondition
func (x *RowFilter) GetCondition() *RowFilter_Conditionfunc (*RowFilter) GetFamilyNameRegexFilter
func (*RowFilter) GetFilter
func (m *RowFilter) GetFilter() isRowFilter_Filterfunc (*RowFilter) GetInterleave
func (x *RowFilter) GetInterleave() *RowFilter_Interleavefunc (*RowFilter) GetPassAllFilter
func (*RowFilter) GetRowKeyRegexFilter
func (*RowFilter) GetRowSampleFilter
func (*RowFilter) GetSink
func (*RowFilter) GetStripValueTransformer
func (*RowFilter) GetTimestampRangeFilter
func (x *RowFilter) GetTimestampRangeFilter() *TimestampRangefunc (*RowFilter) GetValueRangeFilter
func (x *RowFilter) GetValueRangeFilter() *ValueRangefunc (*RowFilter) GetValueRegexFilter
func (*RowFilter) ProtoMessage
func (*RowFilter) ProtoMessage()func (*RowFilter) ProtoReflect
func (x *RowFilter) ProtoReflect() protoreflect.Messagefunc (*RowFilter) Reset
func (x *RowFilter) Reset()func (*RowFilter) String
RowFilter_ApplyLabelTransformer
type RowFilter_ApplyLabelTransformer struct {
// 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.
ApplyLabelTransformer string `protobuf:"bytes,19,opt,name=apply_label_transformer,json=applyLabelTransformer,proto3,oneof"`
}RowFilter_BlockAllFilter
type RowFilter_BlockAllFilter struct {
// Does not match any cells, regardless of input. Useful for temporarily
// disabling just part of a filter.
BlockAllFilter bool `protobuf:"varint,18,opt,name=block_all_filter,json=blockAllFilter,proto3,oneof"`
}RowFilter_CellsPerColumnLimitFilter
type RowFilter_CellsPerColumnLimitFilter struct {
// 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.
CellsPerColumnLimitFilter int32 `protobuf:"varint,12,opt,name=cells_per_column_limit_filter,json=cellsPerColumnLimitFilter,proto3,oneof"`
}RowFilter_CellsPerRowLimitFilter
type RowFilter_CellsPerRowLimitFilter struct {
// 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.
CellsPerRowLimitFilter int32 `protobuf:"varint,11,opt,name=cells_per_row_limit_filter,json=cellsPerRowLimitFilter,proto3,oneof"`
}RowFilter_CellsPerRowOffsetFilter
type RowFilter_CellsPerRowOffsetFilter struct {
// 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.
CellsPerRowOffsetFilter int32 `protobuf:"varint,10,opt,name=cells_per_row_offset_filter,json=cellsPerRowOffsetFilter,proto3,oneof"`
}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,proto3" json:"filters,omitempty"`
// contains filtered or unexported fields
}A RowFilter which sends rows through several RowFilters in sequence.
func (*RowFilter_Chain) Descriptor
func (*RowFilter_Chain) Descriptor() ([]byte, []int)Deprecated: Use RowFilter_Chain.ProtoReflect.Descriptor instead.
func (*RowFilter_Chain) GetFilters
func (x *RowFilter_Chain) GetFilters() []*RowFilterfunc (*RowFilter_Chain) ProtoMessage
func (*RowFilter_Chain) ProtoMessage()func (*RowFilter_Chain) ProtoReflect
func (x *RowFilter_Chain) ProtoReflect() protoreflect.Messagefunc (*RowFilter_Chain) Reset
func (x *RowFilter_Chain) Reset()func (*RowFilter_Chain) String
func (x *RowFilter_Chain) String() stringRowFilter_Chain_
type RowFilter_Chain_ struct {
// Applies several RowFilters to the data in sequence, progressively
// narrowing the results.
Chain *RowFilter_Chain `protobuf:"bytes,1,opt,name=chain,proto3,oneof"`
}RowFilter_ColumnQualifierRegexFilter
type RowFilter_ColumnQualifierRegexFilter struct {
// 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.
ColumnQualifierRegexFilter []byte `protobuf:"bytes,6,opt,name=column_qualifier_regex_filter,json=columnQualifierRegexFilter,proto3,oneof"`
}RowFilter_ColumnRangeFilter
type RowFilter_ColumnRangeFilter struct {
// Matches only cells from columns within the given range.
ColumnRangeFilter *ColumnRange `protobuf:"bytes,7,opt,name=column_range_filter,json=columnRangeFilter,proto3,oneof"`
}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=predicateFilter,proto3" 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=trueFilter,proto3" 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=falseFilter,proto3" json:"false_filter,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*RowFilter_Condition) Descriptor() ([]byte, []int)Deprecated: Use RowFilter_Condition.ProtoReflect.Descriptor instead.
func (*RowFilter_Condition) GetFalseFilter
func (x *RowFilter_Condition) GetFalseFilter() *RowFilterfunc (*RowFilter_Condition) GetPredicateFilter
func (x *RowFilter_Condition) GetPredicateFilter() *RowFilterfunc (*RowFilter_Condition) GetTrueFilter
func (x *RowFilter_Condition) GetTrueFilter() *RowFilterfunc (*RowFilter_Condition) ProtoMessage
func (*RowFilter_Condition) ProtoMessage()func (*RowFilter_Condition) ProtoReflect
func (x *RowFilter_Condition) ProtoReflect() protoreflect.Messagefunc (*RowFilter_Condition) Reset
func (x *RowFilter_Condition) Reset()func (*RowFilter_Condition) String
func (x *RowFilter_Condition) String() stringRowFilter_Condition_
type RowFilter_Condition_ struct {
// Applies one of two possible RowFilters to the data based on the output of
// a predicate RowFilter.
Condition *RowFilter_Condition `protobuf:"bytes,3,opt,name=condition,proto3,oneof"`
}RowFilter_FamilyNameRegexFilter
type RowFilter_FamilyNameRegexFilter struct {
// 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.
FamilyNameRegexFilter string `protobuf:"bytes,5,opt,name=family_name_regex_filter,json=familyNameRegexFilter,proto3,oneof"`
}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,proto3" json:"filters,omitempty"`
// contains filtered or unexported fields
}A RowFilter which sends each row to each of several component RowFilters and interleaves the results.
func (*RowFilter_Interleave) Descriptor
func (*RowFilter_Interleave) Descriptor() ([]byte, []int)Deprecated: Use RowFilter_Interleave.ProtoReflect.Descriptor instead.
func (*RowFilter_Interleave) GetFilters
func (x *RowFilter_Interleave) GetFilters() []*RowFilterfunc (*RowFilter_Interleave) ProtoMessage
func (*RowFilter_Interleave) ProtoMessage()func (*RowFilter_Interleave) ProtoReflect
func (x *RowFilter_Interleave) ProtoReflect() protoreflect.Messagefunc (*RowFilter_Interleave) Reset
func (x *RowFilter_Interleave) Reset()func (*RowFilter_Interleave) String
func (x *RowFilter_Interleave) String() stringRowFilter_Interleave_
type RowFilter_Interleave_ struct {
// Applies several RowFilters to the data in parallel and combines the
// results.
Interleave *RowFilter_Interleave `protobuf:"bytes,2,opt,name=interleave,proto3,oneof"`
}RowFilter_PassAllFilter
type RowFilter_PassAllFilter struct {
// Matches all cells, regardless of input. Functionally equivalent to
// leaving `filter` unset, but included for completeness.
PassAllFilter bool `protobuf:"varint,17,opt,name=pass_all_filter,json=passAllFilter,proto3,oneof"`
}RowFilter_RowKeyRegexFilter
type RowFilter_RowKeyRegexFilter struct {
// 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.
RowKeyRegexFilter []byte `protobuf:"bytes,4,opt,name=row_key_regex_filter,json=rowKeyRegexFilter,proto3,oneof"`
}RowFilter_RowSampleFilter
type RowFilter_RowSampleFilter struct {
// Matches all cells from a row with probability p, and matches no cells
// from the row with probability 1-p.
RowSampleFilter float64 `protobuf:"fixed64,14,opt,name=row_sample_filter,json=rowSampleFilter,proto3,oneof"`
}RowFilter_Sink
type RowFilter_Sink struct {
// 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][google.bigtable.v2.RowFilter.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][google.bigtable.v2.RowFilter.Condition].
Sink bool `protobuf:"varint,16,opt,name=sink,proto3,oneof"`
}RowFilter_StripValueTransformer
type RowFilter_StripValueTransformer struct {
// Replaces each cell's value with the empty string.
StripValueTransformer bool `protobuf:"varint,13,opt,name=strip_value_transformer,json=stripValueTransformer,proto3,oneof"`
}RowFilter_TimestampRangeFilter
type RowFilter_TimestampRangeFilter struct {
// Matches only cells with timestamps within the given range.
TimestampRangeFilter *TimestampRange `protobuf:"bytes,8,opt,name=timestamp_range_filter,json=timestampRangeFilter,proto3,oneof"`
}RowFilter_ValueRangeFilter
type RowFilter_ValueRangeFilter struct {
// Matches only cells with values that fall within the given range.
ValueRangeFilter *ValueRange `protobuf:"bytes,15,opt,name=value_range_filter,json=valueRangeFilter,proto3,oneof"`
}RowFilter_ValueRegexFilter
type RowFilter_ValueRegexFilter struct {
// 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.
ValueRegexFilter []byte `protobuf:"bytes,9,opt,name=value_regex_filter,json=valueRegexFilter,proto3,oneof"`
}RowRange
type RowRange struct {
// The row key at which to start the range.
// If neither field is set, interpreted as the empty string, inclusive.
//
// Types that are assignable to StartKey:
//
// *RowRange_StartKeyClosed
// *RowRange_StartKeyOpen
StartKey isRowRange_StartKey `protobuf_oneof:"start_key"`
// The row key at which to end the range.
// If neither field is set, interpreted as the infinite row key, exclusive.
//
// Types that are assignable to EndKey:
//
// *RowRange_EndKeyOpen
// *RowRange_EndKeyClosed
EndKey isRowRange_EndKey `protobuf_oneof:"end_key"`
// contains filtered or unexported fields
}Specifies a contiguous range of rows.
func (*RowRange) Descriptor
Deprecated: Use RowRange.ProtoReflect.Descriptor instead.
func (*RowRange) GetEndKey
func (m *RowRange) GetEndKey() isRowRange_EndKeyfunc (*RowRange) GetEndKeyClosed
func (*RowRange) GetEndKeyOpen
func (*RowRange) GetStartKey
func (m *RowRange) GetStartKey() isRowRange_StartKeyfunc (*RowRange) GetStartKeyClosed
func (*RowRange) GetStartKeyOpen
func (*RowRange) ProtoMessage
func (*RowRange) ProtoMessage()func (*RowRange) ProtoReflect
func (x *RowRange) ProtoReflect() protoreflect.Messagefunc (*RowRange) Reset
func (x *RowRange) Reset()func (*RowRange) String
RowRange_EndKeyClosed
type RowRange_EndKeyClosed struct {
// Used when giving an inclusive upper bound for the range.
EndKeyClosed []byte `protobuf:"bytes,4,opt,name=end_key_closed,json=endKeyClosed,proto3,oneof"`
}RowRange_EndKeyOpen
type RowRange_EndKeyOpen struct {
// Used when giving an exclusive upper bound for the range.
EndKeyOpen []byte `protobuf:"bytes,3,opt,name=end_key_open,json=endKeyOpen,proto3,oneof"`
}RowRange_StartKeyClosed
type RowRange_StartKeyClosed struct {
// Used when giving an inclusive lower bound for the range.
StartKeyClosed []byte `protobuf:"bytes,1,opt,name=start_key_closed,json=startKeyClosed,proto3,oneof"`
}RowRange_StartKeyOpen
type RowRange_StartKeyOpen struct {
// Used when giving an exclusive lower bound for the range.
StartKeyOpen []byte `protobuf:"bytes,2,opt,name=start_key_open,json=startKeyOpen,proto3,oneof"`
}RowSet
type RowSet struct {
// Single rows included in the set.
RowKeys [][]byte `protobuf:"bytes,1,rep,name=row_keys,json=rowKeys,proto3" json:"row_keys,omitempty"`
// Contiguous row ranges included in the set.
RowRanges []*RowRange `protobuf:"bytes,2,rep,name=row_ranges,json=rowRanges,proto3" json:"row_ranges,omitempty"`
// contains filtered or unexported fields
}Specifies a non-contiguous set of rows.
func (*RowSet) Descriptor
Deprecated: Use RowSet.ProtoReflect.Descriptor instead.
func (*RowSet) GetRowKeys
func (*RowSet) GetRowRanges
func (*RowSet) ProtoMessage
func (*RowSet) ProtoMessage()func (*RowSet) ProtoReflect
func (x *RowSet) ProtoReflect() protoreflect.Messagefunc (*RowSet) Reset
func (x *RowSet) Reset()func (*RowSet) String
SampleRowKeysRequest
type SampleRowKeysRequest struct {
// Optional. The unique name of the table from which to sample row keys.
//
// Values are of the form
// `projects/Request message for Bigtable.SampleRowKeys.
func (*SampleRowKeysRequest) Descriptor
func (*SampleRowKeysRequest) Descriptor() ([]byte, []int)Deprecated: Use SampleRowKeysRequest.ProtoReflect.Descriptor instead.
func (*SampleRowKeysRequest) GetAppProfileId
func (x *SampleRowKeysRequest) GetAppProfileId() stringfunc (*SampleRowKeysRequest) GetAuthorizedViewName
func (x *SampleRowKeysRequest) GetAuthorizedViewName() stringfunc (*SampleRowKeysRequest) GetTableName
func (x *SampleRowKeysRequest) GetTableName() stringfunc (*SampleRowKeysRequest) ProtoMessage
func (*SampleRowKeysRequest) ProtoMessage()func (*SampleRowKeysRequest) ProtoReflect
func (x *SampleRowKeysRequest) ProtoReflect() protoreflect.Messagefunc (*SampleRowKeysRequest) Reset
func (x *SampleRowKeysRequest) Reset()func (*SampleRowKeysRequest) String
func (x *SampleRowKeysRequest) String() stringSampleRowKeysResponse
type SampleRowKeysResponse struct {
// Sorted streamed sequence of sample row keys in the table. The table might
// have contents before the first row key in the list and after the last one,
// but a key containing the empty string indicates "end of table" and will be
// the last response given, if present.
// Note that row keys in this list may not have ever been written to or read
// from, and users should therefore not make any assumptions about the row key
// structure that are specific to their use case.
RowKey []byte `protobuf:"bytes,1,opt,name=row_key,json=rowKey,proto3" json:"row_key,omitempty"`
// Approximate total storage space used by all rows in the table which precede
// `row_key`. Buffering the contents of all rows between two subsequent
// samples would require space roughly equal to the difference in their
// `offset_bytes` fields.
OffsetBytes int64 `protobuf:"varint,2,opt,name=offset_bytes,json=offsetBytes,proto3" json:"offset_bytes,omitempty"`
// contains filtered or unexported fields
}Response message for Bigtable.SampleRowKeys.
func (*SampleRowKeysResponse) Descriptor
func (*SampleRowKeysResponse) Descriptor() ([]byte, []int)Deprecated: Use SampleRowKeysResponse.ProtoReflect.Descriptor instead.
func (*SampleRowKeysResponse) GetOffsetBytes
func (x *SampleRowKeysResponse) GetOffsetBytes() int64func (*SampleRowKeysResponse) GetRowKey
func (x *SampleRowKeysResponse) GetRowKey() []bytefunc (*SampleRowKeysResponse) ProtoMessage
func (*SampleRowKeysResponse) ProtoMessage()func (*SampleRowKeysResponse) ProtoReflect
func (x *SampleRowKeysResponse) ProtoReflect() protoreflect.Messagefunc (*SampleRowKeysResponse) Reset
func (x *SampleRowKeysResponse) Reset()func (*SampleRowKeysResponse) String
func (x *SampleRowKeysResponse) String() stringStreamContinuationToken
type StreamContinuationToken struct {
// The partition that this token applies to.
Partition *StreamPartition `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"`
// An encoded position in the stream to restart reading from.
Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
// contains filtered or unexported fields
}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.
func (*StreamContinuationToken) Descriptor
func (*StreamContinuationToken) Descriptor() ([]byte, []int)Deprecated: Use StreamContinuationToken.ProtoReflect.Descriptor instead.
func (*StreamContinuationToken) GetPartition
func (x *StreamContinuationToken) GetPartition() *StreamPartitionfunc (*StreamContinuationToken) GetToken
func (x *StreamContinuationToken) GetToken() stringfunc (*StreamContinuationToken) ProtoMessage
func (*StreamContinuationToken) ProtoMessage()func (*StreamContinuationToken) ProtoReflect
func (x *StreamContinuationToken) ProtoReflect() protoreflect.Messagefunc (*StreamContinuationToken) Reset
func (x *StreamContinuationToken) Reset()func (*StreamContinuationToken) String
func (x *StreamContinuationToken) String() stringStreamContinuationTokens
type StreamContinuationTokens struct {
// List of continuation tokens.
Tokens []*StreamContinuationToken `protobuf:"bytes,1,rep,name=tokens,proto3" json:"tokens,omitempty"`
// contains filtered or unexported fields
}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.
func (*StreamContinuationTokens) Descriptor
func (*StreamContinuationTokens) Descriptor() ([]byte, []int)Deprecated: Use StreamContinuationTokens.ProtoReflect.Descriptor instead.
func (*StreamContinuationTokens) GetTokens
func (x *StreamContinuationTokens) GetTokens() []*StreamContinuationTokenfunc (*StreamContinuationTokens) ProtoMessage
func (*StreamContinuationTokens) ProtoMessage()func (*StreamContinuationTokens) ProtoReflect
func (x *StreamContinuationTokens) ProtoReflect() protoreflect.Messagefunc (*StreamContinuationTokens) Reset
func (x *StreamContinuationTokens) Reset()func (*StreamContinuationTokens) String
func (x *StreamContinuationTokens) String() stringStreamPartition
type StreamPartition struct {
// The row range covered by this partition and is specified by
// [`start_key_closed`, `end_key_open`).
RowRange *RowRange `protobuf:"bytes,1,opt,name=row_range,json=rowRange,proto3" json:"row_range,omitempty"`
// contains filtered or unexported fields
}NOTE: This API is intended to be used by Apache Beam BigtableIO. A partition of a change stream.
func (*StreamPartition) Descriptor
func (*StreamPartition) Descriptor() ([]byte, []int)Deprecated: Use StreamPartition.ProtoReflect.Descriptor instead.
func (*StreamPartition) GetRowRange
func (x *StreamPartition) GetRowRange() *RowRangefunc (*StreamPartition) ProtoMessage
func (*StreamPartition) ProtoMessage()func (*StreamPartition) ProtoReflect
func (x *StreamPartition) ProtoReflect() protoreflect.Messagefunc (*StreamPartition) Reset
func (x *StreamPartition) Reset()func (*StreamPartition) String
func (x *StreamPartition) String() stringTimestampRange
type TimestampRange struct {
// Inclusive lower bound. If left empty, interpreted as 0.
StartTimestampMicros int64 `protobuf:"varint,1,opt,name=start_timestamp_micros,json=startTimestampMicros,proto3" 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=endTimestampMicros,proto3" json:"end_timestamp_micros,omitempty"`
// contains filtered or unexported fields
}Specified a contiguous range of microsecond timestamps.
func (*TimestampRange) Descriptor
func (*TimestampRange) Descriptor() ([]byte, []int)Deprecated: Use TimestampRange.ProtoReflect.Descriptor instead.
func (*TimestampRange) GetEndTimestampMicros
func (x *TimestampRange) GetEndTimestampMicros() int64func (*TimestampRange) GetStartTimestampMicros
func (x *TimestampRange) GetStartTimestampMicros() int64func (*TimestampRange) ProtoMessage
func (*TimestampRange) ProtoMessage()func (*TimestampRange) ProtoReflect
func (x *TimestampRange) ProtoReflect() protoreflect.Messagefunc (*TimestampRange) Reset
func (x *TimestampRange) Reset()func (*TimestampRange) String
func (x *TimestampRange) String() stringType
type Type struct {
// The kind of type that this represents.
//
// Types that are assignable to Kind:
//
// *Type_BytesType
// *Type_StringType
// *Type_Int64Type
// *Type_Float32Type
// *Type_Float64Type
// *Type_BoolType
// *Type_TimestampType
// *Type_DateType
// *Type_AggregateType
// *Type_StructType
// *Type_ArrayType
// *Type_MapType
Kind isType_Kind `protobuf_oneof:"kind"`
// contains filtered or unexported fields
}Type represents the type of data that is written to, read from, or stored
in Bigtable. It is heavily based on the GoogleSQL standard to help maintain
familiarity and consistency across products and features.
For compatibility with Bigtable's existing untyped APIs, each Type includes
an Encoding which describes how to convert to/from the underlying data.
Each encoding also defines the following properties:
- Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, not the decoded type.
- Example: BYTES values sort in the same order as their raw encodings.
- Counterexample: Encoding INT64 as a fixed-width decimal string does
not preserve sort order when dealing with negative numbers.
INT64(1) > INT64(-1), butSTRING("-00001") > STRING("00001). - Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins?
- Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign.
- Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends.
- Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?
func (*Type) Descriptor
Deprecated: Use Type.ProtoReflect.Descriptor instead.
func (*Type) GetAggregateType
func (x *Type) GetAggregateType() *Type_Aggregatefunc (*Type) GetArrayType
func (x *Type) GetArrayType() *Type_Arrayfunc (*Type) GetBoolType
func (*Type) GetBytesType
func (x *Type) GetBytesType() *Type_Bytesfunc (*Type) GetDateType
func (*Type) GetFloat32Type
func (x *Type) GetFloat32Type() *Type_Float32func (*Type) GetFloat64Type
func (x *Type) GetFloat64Type() *Type_Float64func (*Type) GetInt64Type
func (x *Type) GetInt64Type() *Type_Int64func (*Type) GetKind
func (m *Type) GetKind() isType_Kindfunc (*Type) GetMapType
func (*Type) GetStringType
func (x *Type) GetStringType() *Type_Stringfunc (*Type) GetStructType
func (x *Type) GetStructType() *Type_Structfunc (*Type) GetTimestampType
func (x *Type) GetTimestampType() *Type_Timestampfunc (*Type) ProtoMessage
func (*Type) ProtoMessage()func (*Type) ProtoReflect
func (x *Type) ProtoReflect() protoreflect.Messagefunc (*Type) Reset
func (x *Type) Reset()func (*Type) String
Type_Aggregate
type Type_Aggregate struct {
// Type of the inputs that are accumulated by this `Aggregate`, which must
// specify a full encoding.
// Use `AddInput` mutations to accumulate new inputs.
InputType *Type `protobuf:"bytes,1,opt,name=input_type,json=inputType,proto3" json:"input_type,omitempty"`
// Output only. Type that holds the internal accumulator state for the
// `Aggregate`. This is a function of the `input_type` and `aggregator`
// chosen, and will always specify a full encoding.
StateType *Type `protobuf:"bytes,2,opt,name=state_type,json=stateType,proto3" json:"state_type,omitempty"`
// Which aggregator function to use. The configured types must match.
//
// Types that are assignable to Aggregator:
//
// *Type_Aggregate_Sum_
// *Type_Aggregate_HllppUniqueCount
// *Type_Aggregate_Max_
// *Type_Aggregate_Min_
Aggregator isType_Aggregate_Aggregator `protobuf_oneof:"aggregator"`
// contains filtered or unexported fields
}A value that combines incremental updates into a summarized value.
Data is never directly written or read using type Aggregate. Writes will
provide either the input_type or state_type, and reads will always
return the state_type .
func (*Type_Aggregate) Descriptor
func (*Type_Aggregate) Descriptor() ([]byte, []int)Deprecated: Use Type_Aggregate.ProtoReflect.Descriptor instead.
func (*Type_Aggregate) GetAggregator
func (m *Type_Aggregate) GetAggregator() isType_Aggregate_Aggregatorfunc (*Type_Aggregate) GetHllppUniqueCount
func (x *Type_Aggregate) GetHllppUniqueCount() *Type_Aggregate_HyperLogLogPlusPlusUniqueCountfunc (*Type_Aggregate) GetInputType
func (x *Type_Aggregate) GetInputType() *Typefunc (*Type_Aggregate) GetMax
func (x *Type_Aggregate) GetMax() *Type_Aggregate_Maxfunc (*Type_Aggregate) GetMin
func (x *Type_Aggregate) GetMin() *Type_Aggregate_Minfunc (*Type_Aggregate) GetStateType
func (x *Type_Aggregate) GetStateType() *Typefunc (*Type_Aggregate) GetSum
func (x *Type_Aggregate) GetSum() *Type_Aggregate_Sumfunc (*Type_Aggregate) ProtoMessage
func (*Type_Aggregate) ProtoMessage()func (*Type_Aggregate) ProtoReflect
func (x *Type_Aggregate) ProtoReflect() protoreflect.Messagefunc (*Type_Aggregate) Reset
func (x *Type_Aggregate) Reset()func (*Type_Aggregate) String
func (x *Type_Aggregate) String() stringType_AggregateType
type Type_AggregateType struct {
// Aggregate
AggregateType *Type_Aggregate `protobuf:"bytes,6,opt,name=aggregate_type,json=aggregateType,proto3,oneof"`
}Type_Aggregate_HllppUniqueCount
type Type_Aggregate_HllppUniqueCount struct {
// HyperLogLogPlusPlusUniqueCount aggregator.
HllppUniqueCount *Type_Aggregate_HyperLogLogPlusPlusUniqueCount `protobuf:"bytes,5,opt,name=hllpp_unique_count,json=hllppUniqueCount,proto3,oneof"`
}Type_Aggregate_HyperLogLogPlusPlusUniqueCount
type Type_Aggregate_HyperLogLogPlusPlusUniqueCount struct {
// contains filtered or unexported fields
}Computes an approximate unique count over the input values. When using
raw data as input, be careful to use a consistent encoding. Otherwise
the same value encoded differently could count more than once, or two
distinct values could count as identical.
Input: Any, or omit for Raw
State: TBD
Special state conversions: Int64 (the unique count estimate)
func (*Type_Aggregate_HyperLogLogPlusPlusUniqueCount) Descriptor
func (*Type_Aggregate_HyperLogLogPlusPlusUniqueCount) Descriptor() ([]byte, []int)Deprecated: Use Type_Aggregate_HyperLogLogPlusPlusUniqueCount.ProtoReflect.Descriptor instead.
func (*Type_Aggregate_HyperLogLogPlusPlusUniqueCount) ProtoMessage
func (*Type_Aggregate_HyperLogLogPlusPlusUniqueCount) ProtoMessage()func (*Type_Aggregate_HyperLogLogPlusPlusUniqueCount) ProtoReflect
func (x *Type_Aggregate_HyperLogLogPlusPlusUniqueCount) ProtoReflect() protoreflect.Messagefunc (*Type_Aggregate_HyperLogLogPlusPlusUniqueCount) Reset
func (x *Type_Aggregate_HyperLogLogPlusPlusUniqueCount) Reset()func (*Type_Aggregate_HyperLogLogPlusPlusUniqueCount) String
func (x *Type_Aggregate_HyperLogLogPlusPlusUniqueCount) String() stringType_Aggregate_Max
type Type_Aggregate_Max struct {
// contains filtered or unexported fields
}Computes the max of the input values.
Allowed input: Int64
State: same as input
func (*Type_Aggregate_Max) Descriptor
func (*Type_Aggregate_Max) Descriptor() ([]byte, []int)Deprecated: Use Type_Aggregate_Max.ProtoReflect.Descriptor instead.
func (*Type_Aggregate_Max) ProtoMessage
func (*Type_Aggregate_Max) ProtoMessage()func (*Type_Aggregate_Max) ProtoReflect
func (x *Type_Aggregate_Max) ProtoReflect() protoreflect.Messagefunc (*Type_Aggregate_Max) Reset
func (x *Type_Aggregate_Max) Reset()func (*Type_Aggregate_Max) String
func (x *Type_Aggregate_Max) String() stringType_Aggregate_Max_
type Type_Aggregate_Max_ struct {
// Max aggregator.
Max *Type_Aggregate_Max `protobuf:"bytes,6,opt,name=max,proto3,oneof"`
}Type_Aggregate_Min
type Type_Aggregate_Min struct {
// contains filtered or unexported fields
}Computes the min of the input values.
Allowed input: Int64
State: same as input
func (*Type_Aggregate_Min) Descriptor
func (*Type_Aggregate_Min) Descriptor() ([]byte, []int)Deprecated: Use Type_Aggregate_Min.ProtoReflect.Descriptor instead.
func (*Type_Aggregate_Min) ProtoMessage
func (*Type_Aggregate_Min) ProtoMessage()func (*Type_Aggregate_Min) ProtoReflect
func (x *Type_Aggregate_Min) ProtoReflect() protoreflect.Messagefunc (*Type_Aggregate_Min) Reset
func (x *Type_Aggregate_Min) Reset()func (*Type_Aggregate_Min) String
func (x *Type_Aggregate_Min) String() stringType_Aggregate_Min_
type Type_Aggregate_Min_ struct {
// Min aggregator.
Min *Type_Aggregate_Min `protobuf:"bytes,7,opt,name=min,proto3,oneof"`
}Type_Aggregate_Sum
type Type_Aggregate_Sum struct {
// contains filtered or unexported fields
}Computes the sum of the input values.
Allowed input: Int64
State: same as input
func (*Type_Aggregate_Sum) Descriptor
func (*Type_Aggregate_Sum) Descriptor() ([]byte, []int)Deprecated: Use Type_Aggregate_Sum.ProtoReflect.Descriptor instead.
func (*Type_Aggregate_Sum) ProtoMessage
func (*Type_Aggregate_Sum) ProtoMessage()func (*Type_Aggregate_Sum) ProtoReflect
func (x *Type_Aggregate_Sum) ProtoReflect() protoreflect.Messagefunc (*Type_Aggregate_Sum) Reset
func (x *Type_Aggregate_Sum) Reset()func (*Type_Aggregate_Sum) String
func (x *Type_Aggregate_Sum) String() stringType_Aggregate_Sum_
type Type_Aggregate_Sum_ struct {
// Sum aggregator.
Sum *Type_Aggregate_Sum `protobuf:"bytes,4,opt,name=sum,proto3,oneof"`
}Type_Array
type Type_Array struct {
// The type of the elements in the array. This must not be `Array`.
ElementType *Type `protobuf:"bytes,1,opt,name=element_type,json=elementType,proto3" json:"element_type,omitempty"`
// contains filtered or unexported fields
}An ordered list of elements of a given type.
Values of type Array are stored in Value.array_value.
func (*Type_Array) Descriptor
func (*Type_Array) Descriptor() ([]byte, []int)Deprecated: Use Type_Array.ProtoReflect.Descriptor instead.
func (*Type_Array) GetElementType
func (x *Type_Array) GetElementType() *Typefunc (*Type_Array) ProtoMessage
func (*Type_Array) ProtoMessage()func (*Type_Array) ProtoReflect
func (x *Type_Array) ProtoReflect() protoreflect.Messagefunc (*Type_Array) Reset
func (x *Type_Array) Reset()func (*Type_Array) String
func (x *Type_Array) String() stringType_ArrayType
type Type_ArrayType struct {
// Array
ArrayType *Type_Array `protobuf:"bytes,3,opt,name=array_type,json=arrayType,proto3,oneof"`
}Type_Bool
type Type_Bool struct {
// contains filtered or unexported fields
}bool
Values of type Bool are stored in Value.bool_value.
func (*Type_Bool) Descriptor
Deprecated: Use Type_Bool.ProtoReflect.Descriptor instead.
func (*Type_Bool) ProtoMessage
func (*Type_Bool) ProtoMessage()func (*Type_Bool) ProtoReflect
func (x *Type_Bool) ProtoReflect() protoreflect.Messagefunc (*Type_Bool) Reset
func (x *Type_Bool) Reset()func (*Type_Bool) String
Type_BoolType
type Type_BoolType struct {
// Bool
BoolType *Type_Bool `protobuf:"bytes,8,opt,name=bool_type,json=boolType,proto3,oneof"`
}Type_Bytes
type Type_Bytes struct {
// The encoding to use when converting to/from lower level types.
Encoding *Type_Bytes_Encoding `protobuf:"bytes,1,opt,name=encoding,proto3" json:"encoding,omitempty"`
// contains filtered or unexported fields
}Bytes
Values of type Bytes are stored in Value.bytes_value.
func (*Type_Bytes) Descriptor
func (*Type_Bytes) Descriptor() ([]byte, []int)Deprecated: Use Type_Bytes.ProtoReflect.Descriptor instead.
func (*Type_Bytes) GetEncoding
func (x *Type_Bytes) GetEncoding() *Type_Bytes_Encodingfunc (*Type_Bytes) ProtoMessage
func (*Type_Bytes) ProtoMessage()func (*Type_Bytes) ProtoReflect
func (x *Type_Bytes) ProtoReflect() protoreflect.Messagefunc (*Type_Bytes) Reset
func (x *Type_Bytes) Reset()func (*Type_Bytes) String
func (x *Type_Bytes) String() stringType_BytesType
type Type_BytesType struct {
// Bytes
BytesType *Type_Bytes `protobuf:"bytes,1,opt,name=bytes_type,json=bytesType,proto3,oneof"`
}Type_Bytes_Encoding
type Type_Bytes_Encoding struct {
// Which encoding to use.
//
// Types that are assignable to Encoding:
//
// *Type_Bytes_Encoding_Raw_
Encoding isType_Bytes_Encoding_Encoding `protobuf_oneof:"encoding"`
// contains filtered or unexported fields
}Rules used to convert to/from lower level types.
func (*Type_Bytes_Encoding) Descriptor
func (*Type_Bytes_Encoding) Descriptor() ([]byte, []int)Deprecated: Use Type_Bytes_Encoding.ProtoReflect.Descriptor instead.
func (*Type_Bytes_Encoding) GetEncoding
func (m *Type_Bytes_Encoding) GetEncoding() isType_Bytes_Encoding_Encodingfunc (*Type_Bytes_Encoding) GetRaw
func (x *Type_Bytes_Encoding) GetRaw() *Type_Bytes_Encoding_Rawfunc (*Type_Bytes_Encoding) ProtoMessage
func (*Type_Bytes_Encoding) ProtoMessage()func (*Type_Bytes_Encoding) ProtoReflect
func (x *Type_Bytes_Encoding) ProtoReflect() protoreflect.Messagefunc (*Type_Bytes_Encoding) Reset
func (x *Type_Bytes_Encoding) Reset()func (*Type_Bytes_Encoding) String
func (x *Type_Bytes_Encoding) String() stringType_Bytes_Encoding_Raw
type Type_Bytes_Encoding_Raw struct {
// contains filtered or unexported fields
}Leaves the value "as-is"
- Order-preserving? Yes
- Self-delimiting? No
- Compatibility? N/A
func (*Type_Bytes_Encoding_Raw) Descriptor
func (*Type_Bytes_Encoding_Raw) Descriptor() ([]byte, []int)Deprecated: Use Type_Bytes_Encoding_Raw.ProtoReflect.Descriptor instead.
func (*Type_Bytes_Encoding_Raw) ProtoMessage
func (*Type_Bytes_Encoding_Raw) ProtoMessage()func (*Type_Bytes_Encoding_Raw) ProtoReflect
func (x *Type_Bytes_Encoding_Raw) ProtoReflect() protoreflect.Messagefunc (*Type_Bytes_Encoding_Raw) Reset
func (x *Type_Bytes_Encoding_Raw) Reset()func (*Type_Bytes_Encoding_Raw) String
func (x *Type_Bytes_Encoding_Raw) String() stringType_Bytes_Encoding_Raw_
type Type_Bytes_Encoding_Raw_ struct {
// Use `Raw` encoding.
Raw *Type_Bytes_Encoding_Raw `protobuf:"bytes,1,opt,name=raw,proto3,oneof"`
}Type_Date
type Type_Date struct {
// contains filtered or unexported fields
}Date
Values of type Date are stored in Value.date_value.
func (*Type_Date) Descriptor
Deprecated: Use Type_Date.ProtoReflect.Descriptor instead.
func (*Type_Date) ProtoMessage
func (*Type_Date) ProtoMessage()func (*Type_Date) ProtoReflect
func (x *Type_Date) ProtoReflect() protoreflect.Messagefunc (*Type_Date) Reset
func (x *Type_Date) Reset()func (*Type_Date) String
Type_DateType
type Type_DateType struct {
// Date
DateType *Type_Date `protobuf:"bytes,11,opt,name=date_type,json=dateType,proto3,oneof"`
}Type_Float32
type Type_Float32 struct {
// contains filtered or unexported fields
}Float32
Values of type Float32 are stored in Value.float_value.
func (*Type_Float32) Descriptor
func (*Type_Float32) Descriptor() ([]byte, []int)Deprecated: Use Type_Float32.ProtoReflect.Descriptor instead.
func (*Type_Float32) ProtoMessage
func (*Type_Float32) ProtoMessage()func (*Type_Float32) ProtoReflect
func (x *Type_Float32) ProtoReflect() protoreflect.Messagefunc (*Type_Float32) Reset
func (x *Type_Float32) Reset()func (*Type_Float32) String
func (x *Type_Float32) String() stringType_Float32Type
type Type_Float32Type struct {
// Float32
Float32Type *Type_Float32 `protobuf:"bytes,12,opt,name=float32_type,json=float32Type,proto3,oneof"`
}Type_Float64
type Type_Float64 struct {
// contains filtered or unexported fields
}Float64
Values of type Float64 are stored in Value.float_value.
func (*Type_Float64) Descriptor
func (*Type_Float64) Descriptor() ([]byte, []int)Deprecated: Use Type_Float64.ProtoReflect.Descriptor instead.
func (*Type_Float64) ProtoMessage
func (*Type_Float64) ProtoMessage()func (*Type_Float64) ProtoReflect
func (x *Type_Float64) ProtoReflect() protoreflect.Messagefunc (*Type_Float64) Reset
func (x *Type_Float64) Reset()func (*Type_Float64) String
func (x *Type_Float64) String() stringType_Float64Type
type Type_Float64Type struct {
// Float64
Float64Type *Type_Float64 `protobuf:"bytes,9,opt,name=float64_type,json=float64Type,proto3,oneof"`
}Type_Int64
type Type_Int64 struct {
// The encoding to use when converting to/from lower level types.
Encoding *Type_Int64_Encoding `protobuf:"bytes,1,opt,name=encoding,proto3" json:"encoding,omitempty"`
// contains filtered or unexported fields
}Int64
Values of type Int64 are stored in Value.int_value.
func (*Type_Int64) Descriptor
func (*Type_Int64) Descriptor() ([]byte, []int)Deprecated: Use Type_Int64.ProtoReflect.Descriptor instead.
func (*Type_Int64) GetEncoding
func (x *Type_Int64) GetEncoding() *Type_Int64_Encodingfunc (*Type_Int64) ProtoMessage
func (*Type_Int64) ProtoMessage()func (*Type_Int64) ProtoReflect
func (x *Type_Int64) ProtoReflect() protoreflect.Messagefunc (*Type_Int64) Reset
func (x *Type_Int64) Reset()func (*Type_Int64) String
func (x *Type_Int64) String() stringType_Int64Type
type Type_Int64Type struct {
// Int64
Int64Type *Type_Int64 `protobuf:"bytes,5,opt,name=int64_type,json=int64Type,proto3,oneof"`
}Type_Int64_Encoding
type Type_Int64_Encoding struct {
// Which encoding to use.
//
// Types that are assignable to Encoding:
//
// *Type_Int64_Encoding_BigEndianBytes_
Encoding isType_Int64_Encoding_Encoding `protobuf_oneof:"encoding"`
// contains filtered or unexported fields
}Rules used to convert to/from lower level types.
func (*Type_Int64_Encoding) Descriptor
func (*Type_Int64_Encoding) Descriptor() ([]byte, []int)Deprecated: Use Type_Int64_Encoding.ProtoReflect.Descriptor instead.
func (*Type_Int64_Encoding) GetBigEndianBytes
func (x *Type_Int64_Encoding) GetBigEndianBytes() *Type_Int64_Encoding_BigEndianBytesfunc (*Type_Int64_Encoding) GetEncoding
func (m *Type_Int64_Encoding) GetEncoding() isType_Int64_Encoding_Encodingfunc (*Type_Int64_Encoding) ProtoMessage
func (*Type_Int64_Encoding) ProtoMessage()func (*Type_Int64_Encoding) ProtoReflect
func (x *Type_Int64_Encoding) ProtoReflect() protoreflect.Messagefunc (*Type_Int64_Encoding) Reset
func (x *Type_Int64_Encoding) Reset()func (*Type_Int64_Encoding) String
func (x *Type_Int64_Encoding) String() stringType_Int64_Encoding_BigEndianBytes
type Type_Int64_Encoding_BigEndianBytes struct {
// Deprecated: ignored if set.
BytesType *Type_Bytes `protobuf:"bytes,1,opt,name=bytes_type,json=bytesType,proto3" json:"bytes_type,omitempty"`
// contains filtered or unexported fields
}Encodes the value as an 8-byte big endian twos complement Bytes
value.
- Order-preserving? No (positive values only)
- Self-delimiting? Yes
- Compatibility?
- BigQuery Federation
BINARYencoding - HBase
Bytes.toBytes - Java
ByteBuffer.putLong()withByteOrder.BIG_ENDIAN
- BigQuery Federation
func (*Type_Int64_Encoding_BigEndianBytes) Descriptor
func (*Type_Int64_Encoding_BigEndianBytes) Descriptor() ([]byte, []int)Deprecated: Use Type_Int64_Encoding_BigEndianBytes.ProtoReflect.Descriptor instead.
func (*Type_Int64_Encoding_BigEndianBytes) GetBytesType
func (x *Type_Int64_Encoding_BigEndianBytes) GetBytesType() *Type_Bytesfunc (*Type_Int64_Encoding_BigEndianBytes) ProtoMessage
func (*Type_Int64_Encoding_BigEndianBytes) ProtoMessage()func (*Type_Int64_Encoding_BigEndianBytes) ProtoReflect
func (x *Type_Int64_Encoding_BigEndianBytes) ProtoReflect() protoreflect.Messagefunc (*Type_Int64_Encoding_BigEndianBytes) Reset
func (x *Type_Int64_Encoding_BigEndianBytes) Reset()func (*Type_Int64_Encoding_BigEndianBytes) String
func (x *Type_Int64_Encoding_BigEndianBytes) String() stringType_Int64_Encoding_BigEndianBytes_
type Type_Int64_Encoding_BigEndianBytes_ struct {
// Use `BigEndianBytes` encoding.
BigEndianBytes *Type_Int64_Encoding_BigEndianBytes `protobuf:"bytes,1,opt,name=big_endian_bytes,json=bigEndianBytes,proto3,oneof"`
}Type_Map
type Type_Map struct {
// The type of a map key.
// Only `Bytes`, `String`, and `Int64` are allowed as key types.
KeyType *Type `protobuf:"bytes,1,opt,name=key_type,json=keyType,proto3" json:"key_type,omitempty"`
// The type of the values in a map.
ValueType *Type `protobuf:"bytes,2,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
// contains filtered or unexported fields
}A mapping of keys to values of a given type.
Values of type Map are stored in a Value.array_value where each entry
is another Value.array_value with two elements (the key and the value,
in that order).
Normally encoded Map values won't have repeated keys, however, clients are
expected to handle the case in which they do. If the same key appears
multiple times, the last value takes precedence.
func (*Type_Map) Descriptor
Deprecated: Use Type_Map.ProtoReflect.Descriptor instead.
func (*Type_Map) GetKeyType
func (*Type_Map) GetValueType
func (*Type_Map) ProtoMessage
func (*Type_Map) ProtoMessage()func (*Type_Map) ProtoReflect
func (x *Type_Map) ProtoReflect() protoreflect.Messagefunc (*Type_Map) Reset
func (x *Type_Map) Reset()func (*Type_Map) String
Type_MapType
type Type_MapType struct {
// Map
MapType *Type_Map `protobuf:"bytes,4,opt,name=map_type,json=mapType,proto3,oneof"`
}Type_String
type Type_String struct {
// The encoding to use when converting to/from lower level types.
Encoding *Type_String_Encoding `protobuf:"bytes,1,opt,name=encoding,proto3" json:"encoding,omitempty"`
// contains filtered or unexported fields
}String
Values of type String are stored in Value.string_value.
func (*Type_String) Descriptor
func (*Type_String) Descriptor() ([]byte, []int)Deprecated: Use Type_String.ProtoReflect.Descriptor instead.
func (*Type_String) GetEncoding
func (x *Type_String) GetEncoding() *Type_String_Encodingfunc (*Type_String) ProtoMessage
func (*Type_String) ProtoMessage()func (*Type_String) ProtoReflect
func (x *Type_String) ProtoReflect() protoreflect.Messagefunc (*Type_String) Reset
func (x *Type_String) Reset()func (*Type_String) String
func (x *Type_String) String() stringType_StringType
type Type_StringType struct {
// String
StringType *Type_String `protobuf:"bytes,2,opt,name=string_type,json=stringType,proto3,oneof"`
}Type_String_Encoding
type Type_String_Encoding struct {
// Which encoding to use.
//
// Types that are assignable to Encoding:
//
// *Type_String_Encoding_Utf8Raw_
// *Type_String_Encoding_Utf8Bytes_
Encoding isType_String_Encoding_Encoding `protobuf_oneof:"encoding"`
// contains filtered or unexported fields
}Rules used to convert to/from lower level types.
func (*Type_String_Encoding) Descriptor
func (*Type_String_Encoding) Descriptor() ([]byte, []int)Deprecated: Use Type_String_Encoding.ProtoReflect.Descriptor instead.
func (*Type_String_Encoding) GetEncoding
func (m *Type_String_Encoding) GetEncoding() isType_String_Encoding_Encodingfunc (*Type_String_Encoding) GetUtf8Bytes
func (x *Type_String_Encoding) GetUtf8Bytes() *Type_String_Encoding_Utf8Bytesfunc (*Type_String_Encoding) GetUtf8Raw
func (x *Type_String_Encoding) GetUtf8Raw() *Type_String_Encoding_Utf8RawDeprecated: Marked as deprecated in google/bigtable/v2/types.proto.
func (*Type_String_Encoding) ProtoMessage
func (*Type_String_Encoding) ProtoMessage()func (*Type_String_Encoding) ProtoReflect
func (x *Type_String_Encoding) ProtoReflect() protoreflect.Messagefunc (*Type_String_Encoding) Reset
func (x *Type_String_Encoding) Reset()func (*Type_String_Encoding) String
func (x *Type_String_Encoding) String() stringType_String_Encoding_Utf8Bytes
type Type_String_Encoding_Utf8Bytes struct {
// contains filtered or unexported fields
}UTF-8 encoding
- Order-preserving? Yes (code point order)
- Self-delimiting? No
- Compatibility?
- BigQuery Federation
TEXTencoding - HBase
Bytes.toBytes - Java
String#getBytes(StandardCharsets.UTF_8)
- BigQuery Federation
func (*Type_String_Encoding_Utf8Bytes) Descriptor
func (*Type_String_Encoding_Utf8Bytes) Descriptor() ([]byte, []int)Deprecated: Use Type_String_Encoding_Utf8Bytes.ProtoReflect.Descriptor instead.
func (*Type_String_Encoding_Utf8Bytes) ProtoMessage
func (*Type_String_Encoding_Utf8Bytes) ProtoMessage()func (*Type_String_Encoding_Utf8Bytes) ProtoReflect
func (x *Type_String_Encoding_Utf8Bytes) ProtoReflect() protoreflect.Messagefunc (*Type_String_Encoding_Utf8Bytes) Reset
func (x *Type_String_Encoding_Utf8Bytes) Reset()func (*Type_String_Encoding_Utf8Bytes) String
func (x *Type_String_Encoding_Utf8Bytes) String() stringType_String_Encoding_Utf8Bytes_
type Type_String_Encoding_Utf8Bytes_ struct {
// Use `Utf8Bytes` encoding.
Utf8Bytes *Type_String_Encoding_Utf8Bytes `protobuf:"bytes,2,opt,name=utf8_bytes,json=utf8Bytes,proto3,oneof"`
}Type_String_Encoding_Utf8Raw (deprecated)
type Type_String_Encoding_Utf8Raw struct {
// contains filtered or unexported fields
}Deprecated: prefer the equivalent Utf8Bytes.
Deprecated: Marked as deprecated in google/bigtable/v2/types.proto.
func (*Type_String_Encoding_Utf8Raw) Descriptor (deprecated)
func (*Type_String_Encoding_Utf8Raw) Descriptor() ([]byte, []int)Deprecated: Use Type_String_Encoding_Utf8Raw.ProtoReflect.Descriptor instead.
func (*Type_String_Encoding_Utf8Raw) ProtoMessage (deprecated)
func (*Type_String_Encoding_Utf8Raw) ProtoMessage()func (*Type_String_Encoding_Utf8Raw) ProtoReflect (deprecated)
func (x *Type_String_Encoding_Utf8Raw) ProtoReflect() protoreflect.Messagefunc (*Type_String_Encoding_Utf8Raw) Reset (deprecated)
func (x *Type_String_Encoding_Utf8Raw) Reset()func (*Type_String_Encoding_Utf8Raw) String (deprecated)
func (x *Type_String_Encoding_Utf8Raw) String() stringType_String_Encoding_Utf8Raw_
type Type_String_Encoding_Utf8Raw_ struct {
// Deprecated: if set, converts to an empty `utf8_bytes`.
//
// Deprecated: Marked as deprecated in google/bigtable/v2/types.proto.
Utf8Raw *Type_String_Encoding_Utf8Raw `protobuf:"bytes,1,opt,name=utf8_raw,json=utf8Raw,proto3,oneof"`
}Type_Struct
type Type_Struct struct {
// The names and types of the fields in this struct.
Fields []*Type_Struct_Field `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty"`
// contains filtered or unexported fields
}A structured data value, consisting of fields which map to dynamically
typed values.
Values of type Struct are stored in Value.array_value where entries are
in the same order and number as field_types.
func (*Type_Struct) Descriptor
func (*Type_Struct) Descriptor() ([]byte, []int)Deprecated: Use Type_Struct.ProtoReflect.Descriptor instead.
func (*Type_Struct) GetFields
func (x *Type_Struct) GetFields() []*Type_Struct_Fieldfunc (*Type_Struct) ProtoMessage
func (*Type_Struct) ProtoMessage()func (*Type_Struct) ProtoReflect
func (x *Type_Struct) ProtoReflect() protoreflect.Messagefunc (*Type_Struct) Reset
func (x *Type_Struct) Reset()func (*Type_Struct) String
func (x *Type_Struct) String() stringType_StructType
type Type_StructType struct {
// Struct
StructType *Type_Struct `protobuf:"bytes,7,opt,name=struct_type,json=structType,proto3,oneof"`
}Type_Struct_Field
type Type_Struct_Field struct {
// The field name (optional). Fields without a `field_name` are considered
// anonymous and cannot be referenced by name.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// The type of values in this field.
Type *Type `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// contains filtered or unexported fields
}A struct field and its type.
func (*Type_Struct_Field) Descriptor
func (*Type_Struct_Field) Descriptor() ([]byte, []int)Deprecated: Use Type_Struct_Field.ProtoReflect.Descriptor instead.
func (*Type_Struct_Field) GetFieldName
func (x *Type_Struct_Field) GetFieldName() stringfunc (*Type_Struct_Field) GetType
func (x *Type_Struct_Field) GetType() *Typefunc (*Type_Struct_Field) ProtoMessage
func (*Type_Struct_Field) ProtoMessage()func (*Type_Struct_Field) ProtoReflect
func (x *Type_Struct_Field) ProtoReflect() protoreflect.Messagefunc (*Type_Struct_Field) Reset
func (x *Type_Struct_Field) Reset()func (*Type_Struct_Field) String
func (x *Type_Struct_Field) String() stringType_Timestamp
type Type_Timestamp struct {
// contains filtered or unexported fields
}Timestamp
Values of type Timestamp are stored in Value.timestamp_value.
func (*Type_Timestamp) Descriptor
func (*Type_Timestamp) Descriptor() ([]byte, []int)Deprecated: Use Type_Timestamp.ProtoReflect.Descriptor instead.
func (*Type_Timestamp) ProtoMessage
func (*Type_Timestamp) ProtoMessage()func (*Type_Timestamp) ProtoReflect
func (x *Type_Timestamp) ProtoReflect() protoreflect.Messagefunc (*Type_Timestamp) Reset
func (x *Type_Timestamp) Reset()func (*Type_Timestamp) String
func (x *Type_Timestamp) String() stringType_TimestampType
type Type_TimestampType struct {
// Timestamp
TimestampType *Type_Timestamp `protobuf:"bytes,10,opt,name=timestamp_type,json=timestampType,proto3,oneof"`
}UnimplementedBigtableServer
type UnimplementedBigtableServer struct {
}UnimplementedBigtableServer can be embedded to have forward compatible implementations.
func (*UnimplementedBigtableServer) CheckAndMutateRow
func (*UnimplementedBigtableServer) CheckAndMutateRow(context.Context, *CheckAndMutateRowRequest) (*CheckAndMutateRowResponse, error)func (*UnimplementedBigtableServer) ExecuteQuery
func (*UnimplementedBigtableServer) ExecuteQuery(*ExecuteQueryRequest, Bigtable_ExecuteQueryServer) errorfunc (*UnimplementedBigtableServer) GenerateInitialChangeStreamPartitions
func (*UnimplementedBigtableServer) GenerateInitialChangeStreamPartitions(*GenerateInitialChangeStreamPartitionsRequest, Bigtable_GenerateInitialChangeStreamPartitionsServer) errorfunc (*UnimplementedBigtableServer) MutateRow
func (*UnimplementedBigtableServer) MutateRow(context.Context, *MutateRowRequest) (*MutateRowResponse, error)func (*UnimplementedBigtableServer) MutateRows
func (*UnimplementedBigtableServer) MutateRows(*MutateRowsRequest, Bigtable_MutateRowsServer) errorfunc (*UnimplementedBigtableServer) PingAndWarm
func (*UnimplementedBigtableServer) PingAndWarm(context.Context, *PingAndWarmRequest) (*PingAndWarmResponse, error)func (*UnimplementedBigtableServer) ReadChangeStream
func (*UnimplementedBigtableServer) ReadChangeStream(*ReadChangeStreamRequest, Bigtable_ReadChangeStreamServer) errorfunc (*UnimplementedBigtableServer) ReadModifyWriteRow
func (*UnimplementedBigtableServer) ReadModifyWriteRow(context.Context, *ReadModifyWriteRowRequest) (*ReadModifyWriteRowResponse, error)func (*UnimplementedBigtableServer) ReadRows
func (*UnimplementedBigtableServer) ReadRows(*ReadRowsRequest, Bigtable_ReadRowsServer) errorfunc (*UnimplementedBigtableServer) SampleRowKeys
func (*UnimplementedBigtableServer) SampleRowKeys(*SampleRowKeysRequest, Bigtable_SampleRowKeysServer) errorValue
type Value struct {
// The verified `Type` of this `Value`, if it cannot be inferred.
//
// Read results will never specify the encoding for `type` since the value
// will already have been decoded by the server. Furthermore, the `type` will
// be omitted entirely if it can be inferred from a previous response. The
// exact semantics for inferring `type` will vary, and are therefore
// documented separately for each read method.
//
// When using composite types (Struct, Array, Map) only the outermost `Value`
// will specify the `type`. This top-level `type` will define the types for
// any nested `Struct' fields, `Array` elements, or `Map` key/value pairs.
// If a nested `Value` provides a `type` on write, the request will be
// rejected with INVALID_ARGUMENT.
Type *Type `protobuf:"bytes,7,opt,name=type,proto3" json:"type,omitempty"`
// Options for transporting values within the protobuf type system. A given
// `kind` may support more than one `type` and vice versa. On write, this is
// roughly analogous to a GoogleSQL literal.
//
// The value is `NULL` if none of the fields in `kind` is set. If `type` is
// also omitted on write, we will infer it based on the schema.
//
// Types that are assignable to Kind:
//
// *Value_RawValue
// *Value_RawTimestampMicros
// *Value_BytesValue
// *Value_StringValue
// *Value_IntValue
// *Value_BoolValue
// *Value_FloatValue
// *Value_TimestampValue
// *Value_DateValue
// *Value_ArrayValue
Kind isValue_Kind `protobuf_oneof:"kind"`
// contains filtered or unexported fields
}Value represents a dynamically typed value.
The typed fields in Value are used as a transport encoding for the actual
value (which may be of a more complex type). See the documentation of the
Type message for more details.
func (*Value) Descriptor
Deprecated: Use Value.ProtoReflect.Descriptor instead.
func (*Value) GetArrayValue
func (x *Value) GetArrayValue() *ArrayValuefunc (*Value) GetBoolValue
func (*Value) GetBytesValue
func (*Value) GetDateValue
func (*Value) GetFloatValue
func (*Value) GetIntValue
func (*Value) GetKind
func (m *Value) GetKind() isValue_Kindfunc (*Value) GetRawTimestampMicros
func (*Value) GetRawValue
func (*Value) GetStringValue
func (*Value) GetTimestampValue
func (x *Value) GetTimestampValue() *timestamppb.Timestampfunc (*Value) GetType
func (*Value) ProtoMessage
func (*Value) ProtoMessage()func (*Value) ProtoReflect
func (x *Value) ProtoReflect() protoreflect.Messagefunc (*Value) Reset
func (x *Value) Reset()func (*Value) String
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 assignable to StartValue:
//
// *ValueRange_StartValueClosed
// *ValueRange_StartValueOpen
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 assignable to EndValue:
//
// *ValueRange_EndValueClosed
// *ValueRange_EndValueOpen
EndValue isValueRange_EndValue `protobuf_oneof:"end_value"`
// contains filtered or unexported fields
}Specifies a contiguous range of raw byte values.
func (*ValueRange) Descriptor
func (*ValueRange) Descriptor() ([]byte, []int)Deprecated: Use ValueRange.ProtoReflect.Descriptor instead.
func (*ValueRange) GetEndValue
func (m *ValueRange) GetEndValue() isValueRange_EndValuefunc (*ValueRange) GetEndValueClosed
func (x *ValueRange) GetEndValueClosed() []bytefunc (*ValueRange) GetEndValueOpen
func (x *ValueRange) GetEndValueOpen() []bytefunc (*ValueRange) GetStartValue
func (m *ValueRange) GetStartValue() isValueRange_StartValuefunc (*ValueRange) GetStartValueClosed
func (x *ValueRange) GetStartValueClosed() []bytefunc (*ValueRange) GetStartValueOpen
func (x *ValueRange) GetStartValueOpen() []bytefunc (*ValueRange) ProtoMessage
func (*ValueRange) ProtoMessage()func (*ValueRange) ProtoReflect
func (x *ValueRange) ProtoReflect() protoreflect.Messagefunc (*ValueRange) Reset
func (x *ValueRange) Reset()func (*ValueRange) String
func (x *ValueRange) String() stringValueRange_EndValueClosed
type ValueRange_EndValueClosed struct {
// Used when giving an inclusive upper bound for the range.
EndValueClosed []byte `protobuf:"bytes,3,opt,name=end_value_closed,json=endValueClosed,proto3,oneof"`
}ValueRange_EndValueOpen
type ValueRange_EndValueOpen struct {
// Used when giving an exclusive upper bound for the range.
EndValueOpen []byte `protobuf:"bytes,4,opt,name=end_value_open,json=endValueOpen,proto3,oneof"`
}ValueRange_StartValueClosed
type ValueRange_StartValueClosed struct {
// Used when giving an inclusive lower bound for the range.
StartValueClosed []byte `protobuf:"bytes,1,opt,name=start_value_closed,json=startValueClosed,proto3,oneof"`
}ValueRange_StartValueOpen
type ValueRange_StartValueOpen struct {
// Used when giving an exclusive lower bound for the range.
StartValueOpen []byte `protobuf:"bytes,2,opt,name=start_value_open,json=startValueOpen,proto3,oneof"`
}Value_ArrayValue
type Value_ArrayValue struct {
// Represents a typed value transported as a sequence of values.
// To differentiate between `Struct`, `Array`, and `Map`, the outermost
// `Value` must provide an explicit `type` on write. This `type` will
// apply recursively to the nested `Struct` fields, `Array` elements,
// or `Map` key/value pairs, which *must not* supply their own `type`.
ArrayValue *ArrayValue `protobuf:"bytes,4,opt,name=array_value,json=arrayValue,proto3,oneof"`
}Value_BoolValue
type Value_BoolValue struct {
// Represents a typed value transported as a boolean.
BoolValue bool `protobuf:"varint,10,opt,name=bool_value,json=boolValue,proto3,oneof"`
}Value_BytesValue
type Value_BytesValue struct {
// Represents a typed value transported as a byte sequence.
BytesValue []byte `protobuf:"bytes,2,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}Value_DateValue
type Value_DateValue struct {
// Represents a typed value transported as a date.
DateValue *date.Date `protobuf:"bytes,13,opt,name=date_value,json=dateValue,proto3,oneof"`
}Value_FloatValue
type Value_FloatValue struct {
// Represents a typed value transported as a floating point number.
FloatValue float64 `protobuf:"fixed64,11,opt,name=float_value,json=floatValue,proto3,oneof"`
}Value_IntValue
type Value_IntValue struct {
// Represents a typed value transported as an integer.
IntValue int64 `protobuf:"varint,6,opt,name=int_value,json=intValue,proto3,oneof"`
}Value_RawTimestampMicros
type Value_RawTimestampMicros struct {
// Represents a raw cell timestamp with no type information.
// The `type` field must be omitted.
RawTimestampMicros int64 `protobuf:"varint,9,opt,name=raw_timestamp_micros,json=rawTimestampMicros,proto3,oneof"`
}Value_RawValue
type Value_RawValue struct {
// Represents a raw byte sequence with no type information.
// The `type` field must be omitted.
RawValue []byte `protobuf:"bytes,8,opt,name=raw_value,json=rawValue,proto3,oneof"`
}Value_StringValue
type Value_StringValue struct {
// Represents a typed value transported as a string.
StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3,oneof"`
}Value_TimestampValue
type Value_TimestampValue struct {
// Represents a typed value transported as a timestamp.
TimestampValue *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=timestamp_value,json=timestampValue,proto3,oneof"`
}