Documentation
¶
Overview ¶
Package google_bigtable_v1 is a generated protocol buffer package.
It is generated from these files:
google.golang.org/cloud/bigtable/internal/service_proto/bigtable_service_messages.proto google.golang.org/cloud/bigtable/internal/service_proto/bigtable_service.proto
It has these top-level messages:
ReadRowsRequest ReadRowsResponse SampleRowKeysRequest SampleRowKeysResponse MutateRowRequest CheckAndMutateRowRequest CheckAndMutateRowResponse ReadModifyWriteRowRequest
Index ¶
- func RegisterBigtableServiceServer(s *grpc.Server, srv BigtableServiceServer)
- type BigtableServiceClient
- type BigtableServiceServer
- type BigtableService_ReadRowsClient
- type BigtableService_ReadRowsServer
- type BigtableService_SampleRowKeysClient
- type BigtableService_SampleRowKeysServer
- type CheckAndMutateRowRequest
- func (*CheckAndMutateRowRequest) Descriptor() ([]byte, []int)
- func (m *CheckAndMutateRowRequest) GetFalseMutations() []*google_bigtable_v11.Mutation
- func (m *CheckAndMutateRowRequest) GetPredicateFilter() *google_bigtable_v11.RowFilter
- func (m *CheckAndMutateRowRequest) GetTrueMutations() []*google_bigtable_v11.Mutation
- func (*CheckAndMutateRowRequest) ProtoMessage()
- func (m *CheckAndMutateRowRequest) Reset()
- func (m *CheckAndMutateRowRequest) String() string
- type CheckAndMutateRowResponse
- type MutateRowRequest
- type ReadModifyWriteRowRequest
- type ReadRowsRequest
- func (*ReadRowsRequest) Descriptor() ([]byte, []int)
- func (m *ReadRowsRequest) GetFilter() *google_bigtable_v11.RowFilter
- func (m *ReadRowsRequest) GetRowKey() []byte
- func (m *ReadRowsRequest) GetRowRange() *google_bigtable_v11.RowRange
- func (m *ReadRowsRequest) GetTarget() isReadRowsRequest_Target
- func (*ReadRowsRequest) ProtoMessage()
- func (m *ReadRowsRequest) Reset()
- func (m *ReadRowsRequest) String() string
- func (*ReadRowsRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type ReadRowsRequest_RowKey
- type ReadRowsRequest_RowRange
- type ReadRowsResponse
- type ReadRowsResponse_Chunk
- func (*ReadRowsResponse_Chunk) Descriptor() ([]byte, []int)
- func (m *ReadRowsResponse_Chunk) GetChunk() isReadRowsResponse_Chunk_Chunk
- func (m *ReadRowsResponse_Chunk) GetCommitRow() bool
- func (m *ReadRowsResponse_Chunk) GetResetRow() bool
- func (m *ReadRowsResponse_Chunk) GetRowContents() *google_bigtable_v11.Family
- func (*ReadRowsResponse_Chunk) ProtoMessage()
- func (m *ReadRowsResponse_Chunk) Reset()
- func (m *ReadRowsResponse_Chunk) String() string
- func (*ReadRowsResponse_Chunk) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type ReadRowsResponse_Chunk_CommitRow
- type ReadRowsResponse_Chunk_ResetRow
- type ReadRowsResponse_Chunk_RowContents
- type SampleRowKeysRequest
- type SampleRowKeysResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterBigtableServiceServer ¶
func RegisterBigtableServiceServer(s *grpc.Server, srv BigtableServiceServer)
Types ¶
type BigtableServiceClient ¶
type BigtableServiceClient interface {
// Streams back the contents of all requested rows, optionally applying
// the same Reader filter to each. Depending on their size, rows may be
// broken up across multiple responses, but atomicity of each row will still
// be preserved.
ReadRows(ctx context.Context, in *ReadRowsRequest, opts ...grpc.CallOption) (BigtableService_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) (BigtableService_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) (*google_protobuf.Empty, 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)
// Modifies a row atomically, reading the latest existing timestamp/value from
// the specified columns and writing a new value at
// max(existing timestamp, current server time) based on pre-defined
// read/modify/write rules. Returns the new contents of all modified cells.
ReadModifyWriteRow(ctx context.Context, in *ReadModifyWriteRowRequest, opts ...grpc.CallOption) (*google_bigtable_v11.Row, error)
}
func NewBigtableServiceClient ¶
func NewBigtableServiceClient(cc *grpc.ClientConn) BigtableServiceClient
type BigtableServiceServer ¶
type BigtableServiceServer interface {
// Streams back the contents of all requested rows, optionally applying
// the same Reader filter to each. Depending on their size, rows may be
// broken up across multiple responses, but atomicity of each row will still
// be preserved.
ReadRows(*ReadRowsRequest, BigtableService_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, BigtableService_SampleRowKeysServer) error
// Mutates a row atomically. Cells already present in the row are left
// unchanged unless explicitly changed by 'mutation'.
MutateRow(context.Context, *MutateRowRequest) (*google_protobuf.Empty, error)
// Mutates a row atomically based on the output of a predicate Reader filter.
CheckAndMutateRow(context.Context, *CheckAndMutateRowRequest) (*CheckAndMutateRowResponse, error)
// Modifies a row atomically, reading the latest existing timestamp/value from
// the specified columns and writing a new value at
// max(existing timestamp, current server time) based on pre-defined
// read/modify/write rules. Returns the new contents of all modified cells.
ReadModifyWriteRow(context.Context, *ReadModifyWriteRowRequest) (*google_bigtable_v11.Row, error)
}
type BigtableService_ReadRowsClient ¶
type BigtableService_ReadRowsClient interface {
Recv() (*ReadRowsResponse, error)
grpc.ClientStream
}
type BigtableService_ReadRowsServer ¶
type BigtableService_ReadRowsServer interface {
Send(*ReadRowsResponse) error
grpc.ServerStream
}
type BigtableService_SampleRowKeysClient ¶
type BigtableService_SampleRowKeysClient interface {
Recv() (*SampleRowKeysResponse, error)
grpc.ClientStream
}
type BigtableService_SampleRowKeysServer ¶
type BigtableService_SampleRowKeysServer interface {
Send(*SampleRowKeysResponse) error
grpc.ServerStream
}
type CheckAndMutateRowRequest ¶
type CheckAndMutateRowRequest struct {
// The unique name of the table to which the conditional mutation should be
// applied.
TableName string `protobuf:"bytes,1,opt,name=table_name" json:"table_name,omitempty"`
// The key of the row to which the conditional mutation should be applied.
RowKey []byte `protobuf:"bytes,2,opt,name=row_key,proto3" json:"row_key,omitempty"`
// The filter to be applied to the contents of the specified row. Depending
// on whether or not any results are yielded, either "true_mutations" or
// "false_mutations" will be executed. If unset, checks that the row contains
// any values at all.
PredicateFilter *google_bigtable_v11.RowFilter `protobuf:"bytes,6,opt,name=predicate_filter" json:"predicate_filter,omitempty"`
// Changes to be atomically applied to the specified row if "predicate_filter"
// yields at least one cell when applied to "row_key". Entries are applied in
// order, meaning that earlier mutations can be masked by later ones.
// Must contain at least one entry if "false_mutations" is empty, and at most
// 100000.
TrueMutations []*google_bigtable_v11.Mutation `protobuf:"bytes,4,rep,name=true_mutations" json:"true_mutations,omitempty"`
// Changes to be atomically applied to the specified row if "predicate_filter"
// does not yield any cells when applied to "row_key". Entries are applied in
// order, meaning that earlier mutations can be masked by later ones.
// Must contain at least one entry if "true_mutations" is empty, and at most
// 100000.
FalseMutations []*google_bigtable_v11.Mutation `protobuf:"bytes,5,rep,name=false_mutations" json:"false_mutations,omitempty"`
}
Request message for BigtableService.CheckAndMutateRowRequest
func (*CheckAndMutateRowRequest) Descriptor ¶
func (*CheckAndMutateRowRequest) Descriptor() ([]byte, []int)
func (*CheckAndMutateRowRequest) GetFalseMutations ¶
func (m *CheckAndMutateRowRequest) GetFalseMutations() []*google_bigtable_v11.Mutation
func (*CheckAndMutateRowRequest) GetPredicateFilter ¶
func (m *CheckAndMutateRowRequest) GetPredicateFilter() *google_bigtable_v11.RowFilter
func (*CheckAndMutateRowRequest) GetTrueMutations ¶
func (m *CheckAndMutateRowRequest) GetTrueMutations() []*google_bigtable_v11.Mutation
func (*CheckAndMutateRowRequest) ProtoMessage ¶
func (*CheckAndMutateRowRequest) ProtoMessage()
func (*CheckAndMutateRowRequest) Reset ¶
func (m *CheckAndMutateRowRequest) Reset()
func (*CheckAndMutateRowRequest) String ¶
func (m *CheckAndMutateRowRequest) String() string
type CheckAndMutateRowResponse ¶
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:"predicate_matched,omitempty"`
}
Response message for BigtableService.CheckAndMutateRowRequest.
func (*CheckAndMutateRowResponse) Descriptor ¶
func (*CheckAndMutateRowResponse) Descriptor() ([]byte, []int)
func (*CheckAndMutateRowResponse) ProtoMessage ¶
func (*CheckAndMutateRowResponse) ProtoMessage()
func (*CheckAndMutateRowResponse) Reset ¶
func (m *CheckAndMutateRowResponse) Reset()
func (*CheckAndMutateRowResponse) String ¶
func (m *CheckAndMutateRowResponse) String() string
type MutateRowRequest ¶
type MutateRowRequest struct {
// The unique name of the table to which the mutation should be applied.
TableName string `protobuf:"bytes,1,opt,name=table_name" json:"table_name,omitempty"`
// The key of the row to which the mutation should be applied.
RowKey []byte `protobuf:"bytes,2,opt,name=row_key,proto3" json:"row_key,omitempty"`
// Changes to be atomically applied to the specified row. Entries are applied
// in order, meaning that earlier mutations can be masked by later ones.
// Must contain at least one entry and at most 100000.
Mutations []*google_bigtable_v11.Mutation `protobuf:"bytes,3,rep,name=mutations" json:"mutations,omitempty"`
}
Request message for BigtableService.MutateRow.
func (*MutateRowRequest) Descriptor ¶
func (*MutateRowRequest) Descriptor() ([]byte, []int)
func (*MutateRowRequest) GetMutations ¶
func (m *MutateRowRequest) GetMutations() []*google_bigtable_v11.Mutation
func (*MutateRowRequest) ProtoMessage ¶
func (*MutateRowRequest) ProtoMessage()
func (*MutateRowRequest) Reset ¶
func (m *MutateRowRequest) Reset()
func (*MutateRowRequest) String ¶
func (m *MutateRowRequest) String() string
type ReadModifyWriteRowRequest ¶
type ReadModifyWriteRowRequest struct {
// The unique name of the table to which the read/modify/write rules should be
// applied.
TableName string `protobuf:"bytes,1,opt,name=table_name" json:"table_name,omitempty"`
// The key of the row to which the read/modify/write rules should be applied.
RowKey []byte `protobuf:"bytes,2,opt,name=row_key,proto3" json:"row_key,omitempty"`
// Rules specifying how the specified row's contents are to be transformed
// into writes. Entries are applied in order, meaning that earlier rules will
// affect the results of later ones.
Rules []*google_bigtable_v11.ReadModifyWriteRule `protobuf:"bytes,3,rep,name=rules" json:"rules,omitempty"`
}
Request message for BigtableService.ReadModifyWriteRowRequest.
func (*ReadModifyWriteRowRequest) Descriptor ¶
func (*ReadModifyWriteRowRequest) Descriptor() ([]byte, []int)
func (*ReadModifyWriteRowRequest) GetRules ¶
func (m *ReadModifyWriteRowRequest) GetRules() []*google_bigtable_v11.ReadModifyWriteRule
func (*ReadModifyWriteRowRequest) ProtoMessage ¶
func (*ReadModifyWriteRowRequest) ProtoMessage()
func (*ReadModifyWriteRowRequest) Reset ¶
func (m *ReadModifyWriteRowRequest) Reset()
func (*ReadModifyWriteRowRequest) String ¶
func (m *ReadModifyWriteRowRequest) String() string
type ReadRowsRequest ¶
type ReadRowsRequest struct {
// The unique name of the table from which to read.
TableName string `protobuf:"bytes,1,opt,name=table_name" json:"table_name,omitempty"`
// If neither row_key nor row_range is set, reads from all rows.
//
// Types that are valid to be assigned to Target:
// *ReadRowsRequest_RowKey
// *ReadRowsRequest_RowRange
Target isReadRowsRequest_Target `protobuf_oneof:"target"`
// The filter to apply to the contents of the specified row(s). If unset,
// reads the entire table.
Filter *google_bigtable_v11.RowFilter `protobuf:"bytes,5,opt,name=filter" json:"filter,omitempty"`
// By default, rows are read sequentially, producing results which are
// guaranteed to arrive in increasing row order. Setting
// "allow_row_interleaving" to true allows multiple rows to be interleaved in
// the response stream, which increases throughput but breaks this guarantee,
// and may force the client to use more memory to buffer partially-received
// rows. Cannot be set to true when specifying "num_rows_limit".
AllowRowInterleaving bool `protobuf:"varint,6,opt,name=allow_row_interleaving" json:"allow_row_interleaving,omitempty"`
// The read will terminate after committing to N rows' worth of results. The
// default (zero) is to return all results.
// Note that "allow_row_interleaving" cannot be set to true when this is set.
NumRowsLimit int64 `protobuf:"varint,7,opt,name=num_rows_limit" json:"num_rows_limit,omitempty"`
}
Request message for BigtableServer.ReadRows.
func (*ReadRowsRequest) Descriptor ¶
func (*ReadRowsRequest) Descriptor() ([]byte, []int)
func (*ReadRowsRequest) GetFilter ¶
func (m *ReadRowsRequest) GetFilter() *google_bigtable_v11.RowFilter
func (*ReadRowsRequest) GetRowKey ¶
func (m *ReadRowsRequest) GetRowKey() []byte
func (*ReadRowsRequest) GetRowRange ¶
func (m *ReadRowsRequest) GetRowRange() *google_bigtable_v11.RowRange
func (*ReadRowsRequest) GetTarget ¶
func (m *ReadRowsRequest) GetTarget() isReadRowsRequest_Target
func (*ReadRowsRequest) ProtoMessage ¶
func (*ReadRowsRequest) ProtoMessage()
func (*ReadRowsRequest) Reset ¶
func (m *ReadRowsRequest) Reset()
func (*ReadRowsRequest) String ¶
func (m *ReadRowsRequest) String() string
func (*ReadRowsRequest) XXX_OneofFuncs ¶
func (*ReadRowsRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type ReadRowsRequest_RowKey ¶
type ReadRowsRequest_RowKey struct {
RowKey []byte `protobuf:"bytes,2,opt,name=row_key,proto3,oneof"`
}
type ReadRowsRequest_RowRange ¶
type ReadRowsRequest_RowRange struct {
RowRange *google_bigtable_v11.RowRange `protobuf:"bytes,3,opt,name=row_range,oneof"`
}
type ReadRowsResponse ¶
type ReadRowsResponse struct {
// The key of the row for which we're receiving data.
// Results will be received in increasing row key order, unless
// "allow_row_interleaving" was specified in the request.
RowKey []byte `protobuf:"bytes,1,opt,name=row_key,proto3" json:"row_key,omitempty"`
// One or more chunks of the row specified by "row_key".
Chunks []*ReadRowsResponse_Chunk `protobuf:"bytes,2,rep,name=chunks" json:"chunks,omitempty"`
}
Response message for BigtableService.ReadRows.
func (*ReadRowsResponse) Descriptor ¶
func (*ReadRowsResponse) Descriptor() ([]byte, []int)
func (*ReadRowsResponse) GetChunks ¶
func (m *ReadRowsResponse) GetChunks() []*ReadRowsResponse_Chunk
func (*ReadRowsResponse) ProtoMessage ¶
func (*ReadRowsResponse) ProtoMessage()
func (*ReadRowsResponse) Reset ¶
func (m *ReadRowsResponse) Reset()
func (*ReadRowsResponse) String ¶
func (m *ReadRowsResponse) String() string
type ReadRowsResponse_Chunk ¶
type ReadRowsResponse_Chunk struct {
// Types that are valid to be assigned to Chunk:
// *ReadRowsResponse_Chunk_RowContents
// *ReadRowsResponse_Chunk_ResetRow
// *ReadRowsResponse_Chunk_CommitRow
Chunk isReadRowsResponse_Chunk_Chunk `protobuf_oneof:"chunk"`
}
Specifies a piece of a row's contents returned as part of the read response stream.
func (*ReadRowsResponse_Chunk) Descriptor ¶
func (*ReadRowsResponse_Chunk) Descriptor() ([]byte, []int)
func (*ReadRowsResponse_Chunk) GetChunk ¶
func (m *ReadRowsResponse_Chunk) GetChunk() isReadRowsResponse_Chunk_Chunk
func (*ReadRowsResponse_Chunk) GetCommitRow ¶
func (m *ReadRowsResponse_Chunk) GetCommitRow() bool
func (*ReadRowsResponse_Chunk) GetResetRow ¶
func (m *ReadRowsResponse_Chunk) GetResetRow() bool
func (*ReadRowsResponse_Chunk) GetRowContents ¶
func (m *ReadRowsResponse_Chunk) GetRowContents() *google_bigtable_v11.Family
func (*ReadRowsResponse_Chunk) ProtoMessage ¶
func (*ReadRowsResponse_Chunk) ProtoMessage()
func (*ReadRowsResponse_Chunk) Reset ¶
func (m *ReadRowsResponse_Chunk) Reset()
func (*ReadRowsResponse_Chunk) String ¶
func (m *ReadRowsResponse_Chunk) String() string
func (*ReadRowsResponse_Chunk) XXX_OneofFuncs ¶
func (*ReadRowsResponse_Chunk) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type ReadRowsResponse_Chunk_CommitRow ¶
type ReadRowsResponse_Chunk_CommitRow struct {
CommitRow bool `protobuf:"varint,3,opt,name=commit_row,oneof"`
}
type ReadRowsResponse_Chunk_ResetRow ¶
type ReadRowsResponse_Chunk_ResetRow struct {
ResetRow bool `protobuf:"varint,2,opt,name=reset_row,oneof"`
}
type ReadRowsResponse_Chunk_RowContents ¶
type ReadRowsResponse_Chunk_RowContents struct {
RowContents *google_bigtable_v11.Family `protobuf:"bytes,1,opt,name=row_contents,oneof"`
}
type SampleRowKeysRequest ¶
type SampleRowKeysRequest struct {
// The unique name of the table from which to sample row keys.
TableName string `protobuf:"bytes,1,opt,name=table_name" json:"table_name,omitempty"`
}
Request message for BigtableService.SampleRowKeys.
func (*SampleRowKeysRequest) Descriptor ¶
func (*SampleRowKeysRequest) Descriptor() ([]byte, []int)
func (*SampleRowKeysRequest) ProtoMessage ¶
func (*SampleRowKeysRequest) ProtoMessage()
func (*SampleRowKeysRequest) Reset ¶
func (m *SampleRowKeysRequest) Reset()
func (*SampleRowKeysRequest) String ¶
func (m *SampleRowKeysRequest) String() string
type SampleRowKeysResponse ¶
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,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:"offset_bytes,omitempty"`
}
Response message for BigtableService.SampleRowKeys.
func (*SampleRowKeysResponse) Descriptor ¶
func (*SampleRowKeysResponse) Descriptor() ([]byte, []int)
func (*SampleRowKeysResponse) ProtoMessage ¶
func (*SampleRowKeysResponse) ProtoMessage()
func (*SampleRowKeysResponse) Reset ¶
func (m *SampleRowKeysResponse) Reset()
func (*SampleRowKeysResponse) String ¶
func (m *SampleRowKeysResponse) String() string