bigtable

package
v0.0.0-...-8c6c420 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2024 License: Apache-2.0 Imports: 13 Imported by: 112

Documentation

Index

Constants

This section is empty.

Variables

View Source
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.

View Source
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.

View Source
var File_google_bigtable_v2_bigtable_proto protoreflect.FileDescriptor
View Source
var File_google_bigtable_v2_data_proto protoreflect.FileDescriptor
View Source
var File_google_bigtable_v2_feature_flags_proto protoreflect.FileDescriptor
View Source
var File_google_bigtable_v2_request_stats_proto protoreflect.FileDescriptor
View Source
var File_google_bigtable_v2_response_params_proto protoreflect.FileDescriptor

Functions

func RegisterBigtableServer

func RegisterBigtableServer(s *grpc.Server, srv BigtableServer)

Types

type BigtableClient

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)
}

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) BigtableClient

type BigtableServer

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
}

BigtableServer is the server API for Bigtable service.

type Bigtable_GenerateInitialChangeStreamPartitionsClient

type Bigtable_GenerateInitialChangeStreamPartitionsClient interface {
	Recv() (*GenerateInitialChangeStreamPartitionsResponse, error)
	grpc.ClientStream
}

type Bigtable_GenerateInitialChangeStreamPartitionsServer

type Bigtable_GenerateInitialChangeStreamPartitionsServer interface {
	Send(*GenerateInitialChangeStreamPartitionsResponse) error
	grpc.ServerStream
}

type Bigtable_MutateRowsClient

type Bigtable_MutateRowsClient interface {
	Recv() (*MutateRowsResponse, error)
	grpc.ClientStream
}

type Bigtable_MutateRowsServer

type Bigtable_MutateRowsServer interface {
	Send(*MutateRowsResponse) error
	grpc.ServerStream
}

type Bigtable_ReadChangeStreamClient

type Bigtable_ReadChangeStreamClient interface {
	Recv() (*ReadChangeStreamResponse, error)
	grpc.ClientStream
}

type Bigtable_ReadChangeStreamServer

type Bigtable_ReadChangeStreamServer interface {
	Send(*ReadChangeStreamResponse) error
	grpc.ServerStream
}

type Bigtable_ReadRowsClient

type Bigtable_ReadRowsClient interface {
	Recv() (*ReadRowsResponse, error)
	grpc.ClientStream
}

type Bigtable_ReadRowsServer

type Bigtable_ReadRowsServer interface {
	Send(*ReadRowsResponse) error
	grpc.ServerStream
}

type Bigtable_SampleRowKeysClient

type Bigtable_SampleRowKeysClient interface {
	Recv() (*SampleRowKeysResponse, error)
	grpc.ClientStream
}

type Bigtable_SampleRowKeysServer

type Bigtable_SampleRowKeysServer interface {
	Send(*SampleRowKeysResponse) error
	grpc.ServerStream
}

type 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

func (*Cell) Descriptor() ([]byte, []int)

Deprecated: Use Cell.ProtoReflect.Descriptor instead.

func (*Cell) GetLabels

func (x *Cell) GetLabels() []string

func (*Cell) GetTimestampMicros

func (x *Cell) GetTimestampMicros() int64

func (*Cell) GetValue

func (x *Cell) GetValue() []byte

func (*Cell) ProtoMessage

func (*Cell) ProtoMessage()

func (*Cell) ProtoReflect

func (x *Cell) ProtoReflect() protoreflect.Message

func (*Cell) Reset

func (x *Cell) Reset()

func (*Cell) String

func (x *Cell) String() string

type 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/<project>/instances/<instance>/tables/<table>`.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// Optional. The unique name of the AuthorizedView to which the conditional
	// mutation should be applied.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
	AuthorizedViewName string `protobuf:"bytes,9,opt,name=authorized_view_name,json=authorizedViewName,proto3" json:"authorized_view_name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	AppProfileId string `protobuf:"bytes,7,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// Required. The key of the row to which the conditional mutation should be
	// applied.
	RowKey []byte `protobuf:"bytes,2,opt,name=row_key,json=rowKey,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 *RowFilter `protobuf:"bytes,6,opt,name=predicate_filter,json=predicateFilter,proto3" 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 []*Mutation `protobuf:"bytes,4,rep,name=true_mutations,json=trueMutations,proto3" 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 []*Mutation `protobuf:"bytes,5,rep,name=false_mutations,json=falseMutations,proto3" json:"false_mutations,omitempty"`
	// contains filtered or unexported fields
}

Request message for Bigtable.CheckAndMutateRow.

func (*CheckAndMutateRowRequest) Descriptor deprecated

func (*CheckAndMutateRowRequest) Descriptor() ([]byte, []int)

Deprecated: Use CheckAndMutateRowRequest.ProtoReflect.Descriptor instead.

func (*CheckAndMutateRowRequest) GetAppProfileId

func (x *CheckAndMutateRowRequest) GetAppProfileId() string

func (*CheckAndMutateRowRequest) GetAuthorizedViewName

func (x *CheckAndMutateRowRequest) GetAuthorizedViewName() string

func (*CheckAndMutateRowRequest) GetFalseMutations

func (x *CheckAndMutateRowRequest) GetFalseMutations() []*Mutation

func (*CheckAndMutateRowRequest) GetPredicateFilter

func (x *CheckAndMutateRowRequest) GetPredicateFilter() *RowFilter

func (*CheckAndMutateRowRequest) GetRowKey

func (x *CheckAndMutateRowRequest) GetRowKey() []byte

func (*CheckAndMutateRowRequest) GetTableName

func (x *CheckAndMutateRowRequest) GetTableName() string

func (*CheckAndMutateRowRequest) GetTrueMutations

func (x *CheckAndMutateRowRequest) GetTrueMutations() []*Mutation

func (*CheckAndMutateRowRequest) ProtoMessage

func (*CheckAndMutateRowRequest) ProtoMessage()

func (*CheckAndMutateRowRequest) ProtoReflect

func (x *CheckAndMutateRowRequest) ProtoReflect() protoreflect.Message

func (*CheckAndMutateRowRequest) Reset

func (x *CheckAndMutateRowRequest) Reset()

func (*CheckAndMutateRowRequest) String

func (x *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=predicateMatched,proto3" json:"predicate_matched,omitempty"`
	// contains filtered or unexported fields
}

Response message for Bigtable.CheckAndMutateRow.

func (*CheckAndMutateRowResponse) Descriptor deprecated

func (*CheckAndMutateRowResponse) Descriptor() ([]byte, []int)

Deprecated: Use CheckAndMutateRowResponse.ProtoReflect.Descriptor instead.

func (*CheckAndMutateRowResponse) GetPredicateMatched

func (x *CheckAndMutateRowResponse) GetPredicateMatched() bool

func (*CheckAndMutateRowResponse) ProtoMessage

func (*CheckAndMutateRowResponse) ProtoMessage()

func (*CheckAndMutateRowResponse) ProtoReflect

func (*CheckAndMutateRowResponse) Reset

func (x *CheckAndMutateRowResponse) Reset()

func (*CheckAndMutateRowResponse) String

func (x *CheckAndMutateRowResponse) String() string

type Column

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

func (*Column) Descriptor() ([]byte, []int)

Deprecated: Use Column.ProtoReflect.Descriptor instead.

func (*Column) GetCells

func (x *Column) GetCells() []*Cell

func (*Column) GetQualifier

func (x *Column) GetQualifier() []byte

func (*Column) ProtoMessage

func (*Column) ProtoMessage()

func (*Column) ProtoReflect

func (x *Column) ProtoReflect() protoreflect.Message

func (*Column) Reset

func (x *Column) Reset()

func (*Column) String

func (x *Column) String() string

type ColumnRange

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 &lt;column_family&gt;:&lt;start_qualifier&gt; to &lt;column_family&gt;:&lt;end_qualifier&gt;, where both bounds can be either inclusive or exclusive.

func (*ColumnRange) Descriptor deprecated

func (*ColumnRange) Descriptor() ([]byte, []int)

Deprecated: Use ColumnRange.ProtoReflect.Descriptor instead.

func (*ColumnRange) GetEndQualifier

func (m *ColumnRange) GetEndQualifier() isColumnRange_EndQualifier

func (*ColumnRange) GetEndQualifierClosed

func (x *ColumnRange) GetEndQualifierClosed() []byte

func (*ColumnRange) GetEndQualifierOpen

func (x *ColumnRange) GetEndQualifierOpen() []byte

func (*ColumnRange) GetFamilyName

func (x *ColumnRange) GetFamilyName() string

func (*ColumnRange) GetStartQualifier

func (m *ColumnRange) GetStartQualifier() isColumnRange_StartQualifier

func (*ColumnRange) GetStartQualifierClosed

func (x *ColumnRange) GetStartQualifierClosed() []byte

func (*ColumnRange) GetStartQualifierOpen

func (x *ColumnRange) GetStartQualifierOpen() []byte

func (*ColumnRange) ProtoMessage

func (*ColumnRange) ProtoMessage()

func (*ColumnRange) ProtoReflect

func (x *ColumnRange) ProtoReflect() protoreflect.Message

func (*ColumnRange) Reset

func (x *ColumnRange) Reset()

func (*ColumnRange) String

func (x *ColumnRange) String() string

type ColumnRange_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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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

func (*Family) Descriptor() ([]byte, []int)

Deprecated: Use Family.ProtoReflect.Descriptor instead.

func (*Family) GetColumns

func (x *Family) GetColumns() []*Column

func (*Family) GetName

func (x *Family) GetName() string

func (*Family) ProtoMessage

func (*Family) ProtoMessage()

func (*Family) ProtoReflect

func (x *Family) ProtoReflect() protoreflect.Message

func (*Family) Reset

func (x *Family) Reset()

func (*Family) String

func (x *Family) String() string

type FeatureFlags

type FeatureFlags struct {

	// Notify the server that the client supports reverse scans. The server will
	// reject ReadRowsRequests with the reverse bit set when this is absent.
	ReverseScans bool `protobuf:"varint,1,opt,name=reverse_scans,json=reverseScans,proto3" json:"reverse_scans,omitempty"`
	// Notify the server that the client enables batch write flow control by
	// requesting RateLimitInfo from MutateRowsResponse. Due to technical reasons,
	// this disables partial retries.
	MutateRowsRateLimit bool `protobuf:"varint,3,opt,name=mutate_rows_rate_limit,json=mutateRowsRateLimit,proto3" json:"mutate_rows_rate_limit,omitempty"`
	// Notify the server that the client enables batch write flow control by
	// requesting RateLimitInfo from MutateRowsResponse. With partial retries
	// enabled.
	MutateRowsRateLimit2 bool `` /* 126-byte string literal not displayed */
	// Notify the server that the client supports the last_scanned_row field
	// in ReadRowsResponse for long-running scans.
	LastScannedRowResponses bool `` /* 135-byte string literal not displayed */
	// Notify the server that the client supports using encoded routing cookie
	// strings to retry requests with.
	RoutingCookie bool `protobuf:"varint,6,opt,name=routing_cookie,json=routingCookie,proto3" json:"routing_cookie,omitempty"`
	// Notify the server that the client supports using retry info back off
	// durations to retry requests with.
	RetryInfo bool `protobuf:"varint,7,opt,name=retry_info,json=retryInfo,proto3" json:"retry_info,omitempty"`
	// Notify the server that the client has client side metrics enabled.
	ClientSideMetricsEnabled bool `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

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 deprecated

func (*FeatureFlags) Descriptor() ([]byte, []int)

Deprecated: Use FeatureFlags.ProtoReflect.Descriptor instead.

func (*FeatureFlags) GetClientSideMetricsEnabled

func (x *FeatureFlags) GetClientSideMetricsEnabled() bool

func (*FeatureFlags) GetLastScannedRowResponses

func (x *FeatureFlags) GetLastScannedRowResponses() bool

func (*FeatureFlags) GetMutateRowsRateLimit

func (x *FeatureFlags) GetMutateRowsRateLimit() bool

func (*FeatureFlags) GetMutateRowsRateLimit2

func (x *FeatureFlags) GetMutateRowsRateLimit2() bool

func (*FeatureFlags) GetRetryInfo

func (x *FeatureFlags) GetRetryInfo() bool

func (*FeatureFlags) GetReverseScans

func (x *FeatureFlags) GetReverseScans() bool

func (*FeatureFlags) GetRoutingCookie

func (x *FeatureFlags) GetRoutingCookie() bool

func (*FeatureFlags) ProtoMessage

func (*FeatureFlags) ProtoMessage()

func (*FeatureFlags) ProtoReflect

func (x *FeatureFlags) ProtoReflect() protoreflect.Message

func (*FeatureFlags) Reset

func (x *FeatureFlags) Reset()

func (*FeatureFlags) String

func (x *FeatureFlags) String() string

type FullReadStatsView

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 deprecated

func (*FullReadStatsView) Descriptor() ([]byte, []int)

Deprecated: Use FullReadStatsView.ProtoReflect.Descriptor instead.

func (*FullReadStatsView) GetReadIterationStats

func (x *FullReadStatsView) GetReadIterationStats() *ReadIterationStats

func (*FullReadStatsView) GetRequestLatencyStats

func (x *FullReadStatsView) GetRequestLatencyStats() *RequestLatencyStats

func (*FullReadStatsView) ProtoMessage

func (*FullReadStatsView) ProtoMessage()

func (*FullReadStatsView) ProtoReflect

func (x *FullReadStatsView) ProtoReflect() protoreflect.Message

func (*FullReadStatsView) Reset

func (x *FullReadStatsView) Reset()

func (*FullReadStatsView) String

func (x *FullReadStatsView) String() string

type GenerateInitialChangeStreamPartitionsRequest

type GenerateInitialChangeStreamPartitionsRequest struct {

	// Required. The unique name of the table from which to get change stream
	// partitions. Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>`.
	// Change streaming must be enabled on the table.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	// Single cluster routing must be configured on the profile.
	AppProfileId string `protobuf:"bytes,2,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// contains filtered or unexported fields
}

NOTE: This API is intended to be used by Apache Beam BigtableIO. Request message for Bigtable.GenerateInitialChangeStreamPartitions.

func (*GenerateInitialChangeStreamPartitionsRequest) Descriptor deprecated

Deprecated: Use GenerateInitialChangeStreamPartitionsRequest.ProtoReflect.Descriptor instead.

func (*GenerateInitialChangeStreamPartitionsRequest) GetAppProfileId

func (*GenerateInitialChangeStreamPartitionsRequest) GetTableName

func (*GenerateInitialChangeStreamPartitionsRequest) ProtoMessage

func (*GenerateInitialChangeStreamPartitionsRequest) ProtoReflect

func (*GenerateInitialChangeStreamPartitionsRequest) Reset

func (*GenerateInitialChangeStreamPartitionsRequest) String

type GenerateInitialChangeStreamPartitionsResponse

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 deprecated

Deprecated: Use GenerateInitialChangeStreamPartitionsResponse.ProtoReflect.Descriptor instead.

func (*GenerateInitialChangeStreamPartitionsResponse) GetPartition

func (*GenerateInitialChangeStreamPartitionsResponse) ProtoMessage

func (*GenerateInitialChangeStreamPartitionsResponse) ProtoReflect

func (*GenerateInitialChangeStreamPartitionsResponse) Reset

func (*GenerateInitialChangeStreamPartitionsResponse) String

type MutateRowRequest

type MutateRowRequest struct {

	// Optional. The unique name of the table to which the mutation should be
	// applied.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>`.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// Optional. The unique name of the AuthorizedView to which the mutation
	// should be applied.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
	AuthorizedViewName string `protobuf:"bytes,6,opt,name=authorized_view_name,json=authorizedViewName,proto3" json:"authorized_view_name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	AppProfileId string `protobuf:"bytes,4,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// Required. The key of the row to which the mutation should be applied.
	RowKey []byte `protobuf:"bytes,2,opt,name=row_key,json=rowKey,proto3" json:"row_key,omitempty"`
	// Required. 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 []*Mutation `protobuf:"bytes,3,rep,name=mutations,proto3" json:"mutations,omitempty"`
	// contains filtered or unexported fields
}

Request message for Bigtable.MutateRow.

func (*MutateRowRequest) Descriptor deprecated

func (*MutateRowRequest) Descriptor() ([]byte, []int)

Deprecated: Use MutateRowRequest.ProtoReflect.Descriptor instead.

func (*MutateRowRequest) GetAppProfileId

func (x *MutateRowRequest) GetAppProfileId() string

func (*MutateRowRequest) GetAuthorizedViewName

func (x *MutateRowRequest) GetAuthorizedViewName() string

func (*MutateRowRequest) GetMutations

func (x *MutateRowRequest) GetMutations() []*Mutation

func (*MutateRowRequest) GetRowKey

func (x *MutateRowRequest) GetRowKey() []byte

func (*MutateRowRequest) GetTableName

func (x *MutateRowRequest) GetTableName() string

func (*MutateRowRequest) ProtoMessage

func (*MutateRowRequest) ProtoMessage()

func (*MutateRowRequest) ProtoReflect

func (x *MutateRowRequest) ProtoReflect() protoreflect.Message

func (*MutateRowRequest) Reset

func (x *MutateRowRequest) Reset()

func (*MutateRowRequest) String

func (x *MutateRowRequest) String() string

type MutateRowResponse

type MutateRowResponse struct {
	// contains filtered or unexported fields
}

Response message for Bigtable.MutateRow.

func (*MutateRowResponse) Descriptor deprecated

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

func (*MutateRowResponse) Reset

func (x *MutateRowResponse) Reset()

func (*MutateRowResponse) String

func (x *MutateRowResponse) String() string

type MutateRowsRequest

type MutateRowsRequest struct {

	// Optional. The unique name of the table to which the mutations should be
	// applied.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>`.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// Optional. The unique name of the AuthorizedView to which the mutations
	// should be applied.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
	AuthorizedViewName string `protobuf:"bytes,5,opt,name=authorized_view_name,json=authorizedViewName,proto3" json:"authorized_view_name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	AppProfileId string `protobuf:"bytes,3,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// Required. The row keys and corresponding mutations to be applied in bulk.
	// Each entry is applied as an atomic mutation, but the entries may be
	// applied in arbitrary order (even between entries for the same row).
	// At least one entry must be specified, and in total the entries can
	// contain at most 100000 mutations.
	Entries []*MutateRowsRequest_Entry `protobuf:"bytes,2,rep,name=entries,proto3" json:"entries,omitempty"`
	// contains filtered or unexported fields
}

Request message for BigtableService.MutateRows.

func (*MutateRowsRequest) Descriptor deprecated

func (*MutateRowsRequest) Descriptor() ([]byte, []int)

Deprecated: Use MutateRowsRequest.ProtoReflect.Descriptor instead.

func (*MutateRowsRequest) GetAppProfileId

func (x *MutateRowsRequest) GetAppProfileId() string

func (*MutateRowsRequest) GetAuthorizedViewName

func (x *MutateRowsRequest) GetAuthorizedViewName() string

func (*MutateRowsRequest) GetEntries

func (x *MutateRowsRequest) GetEntries() []*MutateRowsRequest_Entry

func (*MutateRowsRequest) GetTableName

func (x *MutateRowsRequest) GetTableName() string

func (*MutateRowsRequest) ProtoMessage

func (*MutateRowsRequest) ProtoMessage()

func (*MutateRowsRequest) ProtoReflect

func (x *MutateRowsRequest) ProtoReflect() protoreflect.Message

func (*MutateRowsRequest) Reset

func (x *MutateRowsRequest) Reset()

func (*MutateRowsRequest) String

func (x *MutateRowsRequest) String() string

type MutateRowsRequest_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 deprecated

func (*MutateRowsRequest_Entry) Descriptor() ([]byte, []int)

Deprecated: Use MutateRowsRequest_Entry.ProtoReflect.Descriptor instead.

func (*MutateRowsRequest_Entry) GetMutations

func (x *MutateRowsRequest_Entry) GetMutations() []*Mutation

func (*MutateRowsRequest_Entry) GetRowKey

func (x *MutateRowsRequest_Entry) GetRowKey() []byte

func (*MutateRowsRequest_Entry) ProtoMessage

func (*MutateRowsRequest_Entry) ProtoMessage()

func (*MutateRowsRequest_Entry) ProtoReflect

func (x *MutateRowsRequest_Entry) ProtoReflect() protoreflect.Message

func (*MutateRowsRequest_Entry) Reset

func (x *MutateRowsRequest_Entry) Reset()

func (*MutateRowsRequest_Entry) String

func (x *MutateRowsRequest_Entry) String() string

type MutateRowsResponse

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 deprecated

func (*MutateRowsResponse) Descriptor() ([]byte, []int)

Deprecated: Use MutateRowsResponse.ProtoReflect.Descriptor instead.

func (*MutateRowsResponse) GetEntries

func (x *MutateRowsResponse) GetEntries() []*MutateRowsResponse_Entry

func (*MutateRowsResponse) GetRateLimitInfo

func (x *MutateRowsResponse) GetRateLimitInfo() *RateLimitInfo

func (*MutateRowsResponse) ProtoMessage

func (*MutateRowsResponse) ProtoMessage()

func (*MutateRowsResponse) ProtoReflect

func (x *MutateRowsResponse) ProtoReflect() protoreflect.Message

func (*MutateRowsResponse) Reset

func (x *MutateRowsResponse) Reset()

func (*MutateRowsResponse) String

func (x *MutateRowsResponse) String() string

type MutateRowsResponse_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 deprecated

func (*MutateRowsResponse_Entry) Descriptor() ([]byte, []int)

Deprecated: Use MutateRowsResponse_Entry.ProtoReflect.Descriptor instead.

func (*MutateRowsResponse_Entry) GetIndex

func (x *MutateRowsResponse_Entry) GetIndex() int64

func (*MutateRowsResponse_Entry) GetStatus

func (x *MutateRowsResponse_Entry) GetStatus() *status.Status

func (*MutateRowsResponse_Entry) ProtoMessage

func (*MutateRowsResponse_Entry) ProtoMessage()

func (*MutateRowsResponse_Entry) ProtoReflect

func (x *MutateRowsResponse_Entry) ProtoReflect() protoreflect.Message

func (*MutateRowsResponse_Entry) Reset

func (x *MutateRowsResponse_Entry) Reset()

func (*MutateRowsResponse_Entry) String

func (x *MutateRowsResponse_Entry) String() string

type Mutation

type Mutation struct {

	// Which of the possible Mutation types to apply.
	//
	// Types that are assignable to Mutation:
	//
	//	*Mutation_SetCell_
	//	*Mutation_AddToCell_
	//	*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

func (*Mutation) Descriptor() ([]byte, []int)

Deprecated: Use Mutation.ProtoReflect.Descriptor instead.

func (*Mutation) GetAddToCell

func (x *Mutation) GetAddToCell() *Mutation_AddToCell

func (*Mutation) GetDeleteFromColumn

func (x *Mutation) GetDeleteFromColumn() *Mutation_DeleteFromColumn

func (*Mutation) GetDeleteFromFamily

func (x *Mutation) GetDeleteFromFamily() *Mutation_DeleteFromFamily

func (*Mutation) GetDeleteFromRow

func (x *Mutation) GetDeleteFromRow() *Mutation_DeleteFromRow

func (*Mutation) GetMutation

func (m *Mutation) GetMutation() isMutation_Mutation

func (*Mutation) GetSetCell

func (x *Mutation) GetSetCell() *Mutation_SetCell

func (*Mutation) ProtoMessage

func (*Mutation) ProtoMessage()

func (*Mutation) ProtoReflect

func (x *Mutation) ProtoReflect() protoreflect.Message

func (*Mutation) Reset

func (x *Mutation) Reset()

func (*Mutation) String

func (x *Mutation) String() string

type 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 deprecated

func (*Mutation_AddToCell) Descriptor() ([]byte, []int)

Deprecated: Use Mutation_AddToCell.ProtoReflect.Descriptor instead.

func (*Mutation_AddToCell) GetColumnQualifier

func (x *Mutation_AddToCell) GetColumnQualifier() *Value

func (*Mutation_AddToCell) GetFamilyName

func (x *Mutation_AddToCell) GetFamilyName() string

func (*Mutation_AddToCell) GetInput

func (x *Mutation_AddToCell) GetInput() *Value

func (*Mutation_AddToCell) GetTimestamp

func (x *Mutation_AddToCell) GetTimestamp() *Value

func (*Mutation_AddToCell) ProtoMessage

func (*Mutation_AddToCell) ProtoMessage()

func (*Mutation_AddToCell) ProtoReflect

func (x *Mutation_AddToCell) ProtoReflect() protoreflect.Message

func (*Mutation_AddToCell) Reset

func (x *Mutation_AddToCell) Reset()

func (*Mutation_AddToCell) String

func (x *Mutation_AddToCell) String() string

type Mutation_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"`
}

type 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 deprecated

func (*Mutation_DeleteFromColumn) Descriptor() ([]byte, []int)

Deprecated: Use Mutation_DeleteFromColumn.ProtoReflect.Descriptor instead.

func (*Mutation_DeleteFromColumn) GetColumnQualifier

func (x *Mutation_DeleteFromColumn) GetColumnQualifier() []byte

func (*Mutation_DeleteFromColumn) GetFamilyName

func (x *Mutation_DeleteFromColumn) GetFamilyName() string

func (*Mutation_DeleteFromColumn) GetTimeRange

func (x *Mutation_DeleteFromColumn) GetTimeRange() *TimestampRange

func (*Mutation_DeleteFromColumn) ProtoMessage

func (*Mutation_DeleteFromColumn) ProtoMessage()

func (*Mutation_DeleteFromColumn) ProtoReflect

func (*Mutation_DeleteFromColumn) Reset

func (x *Mutation_DeleteFromColumn) Reset()

func (*Mutation_DeleteFromColumn) String

func (x *Mutation_DeleteFromColumn) String() string

type Mutation_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"`
}

type 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 deprecated

func (*Mutation_DeleteFromFamily) Descriptor() ([]byte, []int)

Deprecated: Use Mutation_DeleteFromFamily.ProtoReflect.Descriptor instead.

func (*Mutation_DeleteFromFamily) GetFamilyName

func (x *Mutation_DeleteFromFamily) GetFamilyName() string

func (*Mutation_DeleteFromFamily) ProtoMessage

func (*Mutation_DeleteFromFamily) ProtoMessage()

func (*Mutation_DeleteFromFamily) ProtoReflect

func (*Mutation_DeleteFromFamily) Reset

func (x *Mutation_DeleteFromFamily) Reset()

func (*Mutation_DeleteFromFamily) String

func (x *Mutation_DeleteFromFamily) String() string

type Mutation_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"`
}

type 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 deprecated

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

func (*Mutation_DeleteFromRow) Reset

func (x *Mutation_DeleteFromRow) Reset()

func (*Mutation_DeleteFromRow) String

func (x *Mutation_DeleteFromRow) String() string

type Mutation_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"`
}

type 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 deprecated

func (*Mutation_SetCell) Descriptor() ([]byte, []int)

Deprecated: Use Mutation_SetCell.ProtoReflect.Descriptor instead.

func (*Mutation_SetCell) GetColumnQualifier

func (x *Mutation_SetCell) GetColumnQualifier() []byte

func (*Mutation_SetCell) GetFamilyName

func (x *Mutation_SetCell) GetFamilyName() string

func (*Mutation_SetCell) GetTimestampMicros

func (x *Mutation_SetCell) GetTimestampMicros() int64

func (*Mutation_SetCell) GetValue

func (x *Mutation_SetCell) GetValue() []byte

func (*Mutation_SetCell) ProtoMessage

func (*Mutation_SetCell) ProtoMessage()

func (*Mutation_SetCell) ProtoReflect

func (x *Mutation_SetCell) ProtoReflect() protoreflect.Message

func (*Mutation_SetCell) Reset

func (x *Mutation_SetCell) Reset()

func (*Mutation_SetCell) String

func (x *Mutation_SetCell) String() string

type Mutation_SetCell_

type Mutation_SetCell_ struct {
	// Set a cell's value.
	SetCell *Mutation_SetCell `protobuf:"bytes,1,opt,name=set_cell,json=setCell,proto3,oneof"`
}

type 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/<project>/instances/<instance>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	AppProfileId string `protobuf:"bytes,2,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for client connection keep-alive and warming.

func (*PingAndWarmRequest) Descriptor deprecated

func (*PingAndWarmRequest) Descriptor() ([]byte, []int)

Deprecated: Use PingAndWarmRequest.ProtoReflect.Descriptor instead.

func (*PingAndWarmRequest) GetAppProfileId

func (x *PingAndWarmRequest) GetAppProfileId() string

func (*PingAndWarmRequest) GetName

func (x *PingAndWarmRequest) GetName() string

func (*PingAndWarmRequest) ProtoMessage

func (*PingAndWarmRequest) ProtoMessage()

func (*PingAndWarmRequest) ProtoReflect

func (x *PingAndWarmRequest) ProtoReflect() protoreflect.Message

func (*PingAndWarmRequest) Reset

func (x *PingAndWarmRequest) Reset()

func (*PingAndWarmRequest) String

func (x *PingAndWarmRequest) String() string

type PingAndWarmResponse

type PingAndWarmResponse struct {
	// contains filtered or unexported fields
}

Response message for Bigtable.PingAndWarm connection keepalive and warming.

func (*PingAndWarmResponse) Descriptor deprecated

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

func (*PingAndWarmResponse) Reset

func (x *PingAndWarmResponse) Reset()

func (*PingAndWarmResponse) String

func (x *PingAndWarmResponse) String() string

type RateLimitInfo

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 deprecated

func (*RateLimitInfo) Descriptor() ([]byte, []int)

Deprecated: Use RateLimitInfo.ProtoReflect.Descriptor instead.

func (*RateLimitInfo) GetFactor

func (x *RateLimitInfo) GetFactor() float64

func (*RateLimitInfo) GetPeriod

func (x *RateLimitInfo) GetPeriod() *durationpb.Duration

func (*RateLimitInfo) ProtoMessage

func (*RateLimitInfo) ProtoMessage()

func (*RateLimitInfo) ProtoReflect

func (x *RateLimitInfo) ProtoReflect() protoreflect.Message

func (*RateLimitInfo) Reset

func (x *RateLimitInfo) Reset()

func (*RateLimitInfo) String

func (x *RateLimitInfo) String() string

type ReadChangeStreamRequest

type ReadChangeStreamRequest struct {

	// Required. The unique name of the table from which to read a change stream.
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>`.
	// Change streaming must be enabled on the table.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	// Single cluster routing must be configured on the profile.
	AppProfileId string `protobuf:"bytes,2,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// The partition to read changes from.
	Partition *StreamPartition `protobuf:"bytes,3,opt,name=partition,proto3" json:"partition,omitempty"`
	// Options for describing where we want to start reading from the stream.
	//
	// Types that are assignable to StartFrom:
	//
	//	*ReadChangeStreamRequest_StartTime
	//	*ReadChangeStreamRequest_ContinuationTokens
	StartFrom isReadChangeStreamRequest_StartFrom `protobuf_oneof:"start_from"`
	// If specified, OK will be returned when the stream advances beyond
	// this time. Otherwise, changes will be continuously delivered on the stream.
	// This value is inclusive and will be truncated to microsecond granularity.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// If specified, the duration between `Heartbeat` messages on the stream.
	// Otherwise, defaults to 5 seconds.
	HeartbeatDuration *durationpb.Duration `protobuf:"bytes,7,opt,name=heartbeat_duration,json=heartbeatDuration,proto3" json:"heartbeat_duration,omitempty"`
	// contains filtered or unexported fields
}

NOTE: This API is intended to be used by Apache Beam BigtableIO. Request message for Bigtable.ReadChangeStream.

func (*ReadChangeStreamRequest) Descriptor deprecated

func (*ReadChangeStreamRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadChangeStreamRequest.ProtoReflect.Descriptor instead.

func (*ReadChangeStreamRequest) GetAppProfileId

func (x *ReadChangeStreamRequest) GetAppProfileId() string

func (*ReadChangeStreamRequest) GetContinuationTokens

func (x *ReadChangeStreamRequest) GetContinuationTokens() *StreamContinuationTokens

func (*ReadChangeStreamRequest) GetEndTime

func (*ReadChangeStreamRequest) GetHeartbeatDuration

func (x *ReadChangeStreamRequest) GetHeartbeatDuration() *durationpb.Duration

func (*ReadChangeStreamRequest) GetPartition

func (x *ReadChangeStreamRequest) GetPartition() *StreamPartition

func (*ReadChangeStreamRequest) GetStartFrom

func (m *ReadChangeStreamRequest) GetStartFrom() isReadChangeStreamRequest_StartFrom

func (*ReadChangeStreamRequest) GetStartTime

func (x *ReadChangeStreamRequest) GetStartTime() *timestamppb.Timestamp

func (*ReadChangeStreamRequest) GetTableName

func (x *ReadChangeStreamRequest) GetTableName() string

func (*ReadChangeStreamRequest) ProtoMessage

func (*ReadChangeStreamRequest) ProtoMessage()

func (*ReadChangeStreamRequest) ProtoReflect

func (x *ReadChangeStreamRequest) ProtoReflect() protoreflect.Message

func (*ReadChangeStreamRequest) Reset

func (x *ReadChangeStreamRequest) Reset()

func (*ReadChangeStreamRequest) String

func (x *ReadChangeStreamRequest) String() string

type ReadChangeStreamRequest_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"`
}

type 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"`
}

type 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 deprecated

func (*ReadChangeStreamResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadChangeStreamResponse.ProtoReflect.Descriptor instead.

func (*ReadChangeStreamResponse) GetCloseStream

func (*ReadChangeStreamResponse) GetDataChange

func (*ReadChangeStreamResponse) GetHeartbeat

func (*ReadChangeStreamResponse) GetStreamRecord

func (m *ReadChangeStreamResponse) GetStreamRecord() isReadChangeStreamResponse_StreamRecord

func (*ReadChangeStreamResponse) ProtoMessage

func (*ReadChangeStreamResponse) ProtoMessage()

func (*ReadChangeStreamResponse) ProtoReflect

func (x *ReadChangeStreamResponse) ProtoReflect() protoreflect.Message

func (*ReadChangeStreamResponse) Reset

func (x *ReadChangeStreamResponse) Reset()

func (*ReadChangeStreamResponse) String

func (x *ReadChangeStreamResponse) String() string

type ReadChangeStreamResponse_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 deprecated

func (*ReadChangeStreamResponse_CloseStream) Descriptor() ([]byte, []int)

Deprecated: Use ReadChangeStreamResponse_CloseStream.ProtoReflect.Descriptor instead.

func (*ReadChangeStreamResponse_CloseStream) GetContinuationTokens

func (x *ReadChangeStreamResponse_CloseStream) GetContinuationTokens() []*StreamContinuationToken

func (*ReadChangeStreamResponse_CloseStream) GetNewPartitions

func (x *ReadChangeStreamResponse_CloseStream) GetNewPartitions() []*StreamPartition

func (*ReadChangeStreamResponse_CloseStream) GetStatus

func (*ReadChangeStreamResponse_CloseStream) ProtoMessage

func (*ReadChangeStreamResponse_CloseStream) ProtoMessage()

func (*ReadChangeStreamResponse_CloseStream) ProtoReflect

func (*ReadChangeStreamResponse_CloseStream) Reset

func (*ReadChangeStreamResponse_CloseStream) String

type ReadChangeStreamResponse_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"`
}

type ReadChangeStreamResponse_DataChange

type ReadChangeStreamResponse_DataChange struct {

	// The type of the mutation.
	Type ReadChangeStreamResponse_DataChange_Type `` /* 127-byte string literal not displayed */
	// The cluster where the mutation was applied.
	// Not set when `type` is `GARBAGE_COLLECTION`.
	SourceClusterId string `protobuf:"bytes,2,opt,name=source_cluster_id,json=sourceClusterId,proto3" json:"source_cluster_id,omitempty"`
	// The row key for all mutations that are part of this `DataChange`.
	// If the `DataChange` is chunked across multiple messages, then this field
	// will only be set for the first message.
	RowKey []byte `protobuf:"bytes,3,opt,name=row_key,json=rowKey,proto3" json:"row_key,omitempty"`
	// The timestamp at which the mutation was applied on the Bigtable server.
	CommitTimestamp *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=commit_timestamp,json=commitTimestamp,proto3" json:"commit_timestamp,omitempty"`
	// A value that lets stream consumers reconstruct Bigtable's
	// conflict resolution semantics.
	// https://cloud.google.com/bigtable/docs/writes#conflict-resolution
	// In the event that the same row key, column family, column qualifier,
	// timestamp are modified on different clusters at the same
	// `commit_timestamp`, the mutation with the larger `tiebreaker` will be the
	// one chosen for the eventually consistent state of the system.
	Tiebreaker int32 `protobuf:"varint,5,opt,name=tiebreaker,proto3" json:"tiebreaker,omitempty"`
	// The mutations associated with this change to the partition.
	// May contain complete mutations or chunks of a multi-message chunked
	// `DataChange` record.
	Chunks []*ReadChangeStreamResponse_MutationChunk `protobuf:"bytes,6,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// When true, indicates that the entire `DataChange` has been read
	// and the client can safely process the message.
	Done bool `protobuf:"varint,8,opt,name=done,proto3" json:"done,omitempty"`
	// An encoded position for this stream's partition to restart reading from.
	// This token is for the StreamPartition from the request.
	Token string `protobuf:"bytes,9,opt,name=token,proto3" json:"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 `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

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 deprecated

func (*ReadChangeStreamResponse_DataChange) Descriptor() ([]byte, []int)

Deprecated: Use ReadChangeStreamResponse_DataChange.ProtoReflect.Descriptor instead.

func (*ReadChangeStreamResponse_DataChange) GetChunks

func (*ReadChangeStreamResponse_DataChange) GetCommitTimestamp

func (*ReadChangeStreamResponse_DataChange) GetDone

func (*ReadChangeStreamResponse_DataChange) GetEstimatedLowWatermark

func (x *ReadChangeStreamResponse_DataChange) GetEstimatedLowWatermark() *timestamppb.Timestamp

func (*ReadChangeStreamResponse_DataChange) GetRowKey

func (x *ReadChangeStreamResponse_DataChange) GetRowKey() []byte

func (*ReadChangeStreamResponse_DataChange) GetSourceClusterId

func (x *ReadChangeStreamResponse_DataChange) GetSourceClusterId() string

func (*ReadChangeStreamResponse_DataChange) GetTiebreaker

func (x *ReadChangeStreamResponse_DataChange) GetTiebreaker() int32

func (*ReadChangeStreamResponse_DataChange) GetToken

func (*ReadChangeStreamResponse_DataChange) GetType

func (*ReadChangeStreamResponse_DataChange) ProtoMessage

func (*ReadChangeStreamResponse_DataChange) ProtoMessage()

func (*ReadChangeStreamResponse_DataChange) ProtoReflect

func (*ReadChangeStreamResponse_DataChange) Reset

func (*ReadChangeStreamResponse_DataChange) String

type ReadChangeStreamResponse_DataChange_

type ReadChangeStreamResponse_DataChange_ struct {
	// A mutation to the partition.
	DataChange *ReadChangeStreamResponse_DataChange `protobuf:"bytes,1,opt,name=data_change,json=dataChange,proto3,oneof"`
}

type ReadChangeStreamResponse_DataChange_Type

type ReadChangeStreamResponse_DataChange_Type int32

The type of mutation.

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) Enum

func (ReadChangeStreamResponse_DataChange_Type) EnumDescriptor deprecated

func (ReadChangeStreamResponse_DataChange_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use ReadChangeStreamResponse_DataChange_Type.Descriptor instead.

func (ReadChangeStreamResponse_DataChange_Type) Number

func (ReadChangeStreamResponse_DataChange_Type) String

func (ReadChangeStreamResponse_DataChange_Type) Type

type ReadChangeStreamResponse_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 `` /* 126-byte string literal not displayed */
	// 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 deprecated

func (*ReadChangeStreamResponse_Heartbeat) Descriptor() ([]byte, []int)

Deprecated: Use ReadChangeStreamResponse_Heartbeat.ProtoReflect.Descriptor instead.

func (*ReadChangeStreamResponse_Heartbeat) GetContinuationToken

func (*ReadChangeStreamResponse_Heartbeat) GetEstimatedLowWatermark

func (x *ReadChangeStreamResponse_Heartbeat) GetEstimatedLowWatermark() *timestamppb.Timestamp

func (*ReadChangeStreamResponse_Heartbeat) ProtoMessage

func (*ReadChangeStreamResponse_Heartbeat) ProtoMessage()

func (*ReadChangeStreamResponse_Heartbeat) ProtoReflect

func (*ReadChangeStreamResponse_Heartbeat) Reset

func (*ReadChangeStreamResponse_Heartbeat) String

type ReadChangeStreamResponse_Heartbeat_

type ReadChangeStreamResponse_Heartbeat_ struct {
	// A periodic heartbeat message.
	Heartbeat *ReadChangeStreamResponse_Heartbeat `protobuf:"bytes,2,opt,name=heartbeat,proto3,oneof"`
}

type 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 deprecated

func (*ReadChangeStreamResponse_MutationChunk) Descriptor() ([]byte, []int)

Deprecated: Use ReadChangeStreamResponse_MutationChunk.ProtoReflect.Descriptor instead.

func (*ReadChangeStreamResponse_MutationChunk) GetChunkInfo

func (*ReadChangeStreamResponse_MutationChunk) GetMutation

func (*ReadChangeStreamResponse_MutationChunk) ProtoMessage

func (*ReadChangeStreamResponse_MutationChunk) ProtoReflect

func (*ReadChangeStreamResponse_MutationChunk) Reset

func (*ReadChangeStreamResponse_MutationChunk) String

type ReadChangeStreamResponse_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 deprecated

Deprecated: Use ReadChangeStreamResponse_MutationChunk_ChunkInfo.ProtoReflect.Descriptor instead.

func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetChunkedValueOffset

func (x *ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetChunkedValueOffset() int32

func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetChunkedValueSize

func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) GetLastChunk

func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) ProtoMessage

func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) ProtoReflect

func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) Reset

func (*ReadChangeStreamResponse_MutationChunk_ChunkInfo) String

type ReadIterationStats

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 deprecated

func (*ReadIterationStats) Descriptor() ([]byte, []int)

Deprecated: Use ReadIterationStats.ProtoReflect.Descriptor instead.

func (*ReadIterationStats) GetCellsReturnedCount

func (x *ReadIterationStats) GetCellsReturnedCount() int64

func (*ReadIterationStats) GetCellsSeenCount

func (x *ReadIterationStats) GetCellsSeenCount() int64

func (*ReadIterationStats) GetRowsReturnedCount

func (x *ReadIterationStats) GetRowsReturnedCount() int64

func (*ReadIterationStats) GetRowsSeenCount

func (x *ReadIterationStats) GetRowsSeenCount() int64

func (*ReadIterationStats) ProtoMessage

func (*ReadIterationStats) ProtoMessage()

func (*ReadIterationStats) ProtoReflect

func (x *ReadIterationStats) ProtoReflect() protoreflect.Message

func (*ReadIterationStats) Reset

func (x *ReadIterationStats) Reset()

func (*ReadIterationStats) String

func (x *ReadIterationStats) String() string

type ReadModifyWriteRowRequest

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/<project>/instances/<instance>/tables/<table>`.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// Optional. The unique name of the AuthorizedView to which the
	// read/modify/write rules should be applied.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
	AuthorizedViewName string `protobuf:"bytes,6,opt,name=authorized_view_name,json=authorizedViewName,proto3" json:"authorized_view_name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	AppProfileId string `protobuf:"bytes,4,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// Required. The key of the row to which the read/modify/write rules should be
	// applied.
	RowKey []byte `protobuf:"bytes,2,opt,name=row_key,json=rowKey,proto3" json:"row_key,omitempty"`
	// Required. 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 []*ReadModifyWriteRule `protobuf:"bytes,3,rep,name=rules,proto3" json:"rules,omitempty"`
	// contains filtered or unexported fields
}

Request message for Bigtable.ReadModifyWriteRow.

func (*ReadModifyWriteRowRequest) Descriptor deprecated

func (*ReadModifyWriteRowRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadModifyWriteRowRequest.ProtoReflect.Descriptor instead.

func (*ReadModifyWriteRowRequest) GetAppProfileId

func (x *ReadModifyWriteRowRequest) GetAppProfileId() string

func (*ReadModifyWriteRowRequest) GetAuthorizedViewName

func (x *ReadModifyWriteRowRequest) GetAuthorizedViewName() string

func (*ReadModifyWriteRowRequest) GetRowKey

func (x *ReadModifyWriteRowRequest) GetRowKey() []byte

func (*ReadModifyWriteRowRequest) GetRules

func (*ReadModifyWriteRowRequest) GetTableName

func (x *ReadModifyWriteRowRequest) GetTableName() string

func (*ReadModifyWriteRowRequest) ProtoMessage

func (*ReadModifyWriteRowRequest) ProtoMessage()

func (*ReadModifyWriteRowRequest) ProtoReflect

func (*ReadModifyWriteRowRequest) Reset

func (x *ReadModifyWriteRowRequest) Reset()

func (*ReadModifyWriteRowRequest) String

func (x *ReadModifyWriteRowRequest) String() string

type ReadModifyWriteRowResponse

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 deprecated

func (*ReadModifyWriteRowResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadModifyWriteRowResponse.ProtoReflect.Descriptor instead.

func (*ReadModifyWriteRowResponse) GetRow

func (x *ReadModifyWriteRowResponse) GetRow() *Row

func (*ReadModifyWriteRowResponse) ProtoMessage

func (*ReadModifyWriteRowResponse) ProtoMessage()

func (*ReadModifyWriteRowResponse) ProtoReflect

func (*ReadModifyWriteRowResponse) Reset

func (x *ReadModifyWriteRowResponse) Reset()

func (*ReadModifyWriteRowResponse) String

func (x *ReadModifyWriteRowResponse) String() string

type ReadModifyWriteRule

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 deprecated

func (*ReadModifyWriteRule) Descriptor() ([]byte, []int)

Deprecated: Use ReadModifyWriteRule.ProtoReflect.Descriptor instead.

func (*ReadModifyWriteRule) GetAppendValue

func (x *ReadModifyWriteRule) GetAppendValue() []byte

func (*ReadModifyWriteRule) GetColumnQualifier

func (x *ReadModifyWriteRule) GetColumnQualifier() []byte

func (*ReadModifyWriteRule) GetFamilyName

func (x *ReadModifyWriteRule) GetFamilyName() string

func (*ReadModifyWriteRule) GetIncrementAmount

func (x *ReadModifyWriteRule) GetIncrementAmount() int64

func (*ReadModifyWriteRule) GetRule

func (m *ReadModifyWriteRule) GetRule() isReadModifyWriteRule_Rule

func (*ReadModifyWriteRule) ProtoMessage

func (*ReadModifyWriteRule) ProtoMessage()

func (*ReadModifyWriteRule) ProtoReflect

func (x *ReadModifyWriteRule) ProtoReflect() protoreflect.Message

func (*ReadModifyWriteRule) Reset

func (x *ReadModifyWriteRule) Reset()

func (*ReadModifyWriteRule) String

func (x *ReadModifyWriteRule) String() string

type ReadModifyWriteRule_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"`
}

type 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"`
}

type ReadRowsRequest

type ReadRowsRequest struct {

	// Optional. The unique name of the table from which to read.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>`.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// Optional. The unique name of the AuthorizedView from which to read.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
	AuthorizedViewName string `protobuf:"bytes,9,opt,name=authorized_view_name,json=authorizedViewName,proto3" json:"authorized_view_name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	AppProfileId string `protobuf:"bytes,5,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// The row keys and/or ranges to read sequentially. If not specified, reads
	// from all rows.
	Rows *RowSet `protobuf:"bytes,2,opt,name=rows,proto3" json:"rows,omitempty"`
	// The filter to apply to the contents of the specified row(s). If unset,
	// reads the entirety of each row.
	Filter *RowFilter `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// The read will stop after committing to N rows' worth of results. The
	// default (zero) is to return all results.
	RowsLimit int64 `protobuf:"varint,4,opt,name=rows_limit,json=rowsLimit,proto3" json:"rows_limit,omitempty"`
	// The view into RequestStats, as described above.
	RequestStatsView ReadRowsRequest_RequestStatsView `` /* 169-byte string literal not displayed */
	// Experimental API - Please note that this API is currently experimental
	// and can change in the future.
	//
	// Return rows in lexiographical descending order of the row keys. The row
	// contents will not be affected by this flag.
	//
	// Example result set:
	//
	//	[
	//	  {key: "k2", "f:col1": "v1", "f:col2": "v1"},
	//	  {key: "k1", "f:col1": "v2", "f:col2": "v2"}
	//	]
	Reversed bool `protobuf:"varint,7,opt,name=reversed,proto3" json:"reversed,omitempty"`
	// contains filtered or unexported fields
}

Request message for Bigtable.ReadRows.

func (*ReadRowsRequest) Descriptor deprecated

func (*ReadRowsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadRowsRequest.ProtoReflect.Descriptor instead.

func (*ReadRowsRequest) GetAppProfileId

func (x *ReadRowsRequest) GetAppProfileId() string

func (*ReadRowsRequest) GetAuthorizedViewName

func (x *ReadRowsRequest) GetAuthorizedViewName() string

func (*ReadRowsRequest) GetFilter

func (x *ReadRowsRequest) GetFilter() *RowFilter

func (*ReadRowsRequest) GetRequestStatsView

func (x *ReadRowsRequest) GetRequestStatsView() ReadRowsRequest_RequestStatsView

func (*ReadRowsRequest) GetReversed

func (x *ReadRowsRequest) GetReversed() bool

func (*ReadRowsRequest) GetRows

func (x *ReadRowsRequest) GetRows() *RowSet

func (*ReadRowsRequest) GetRowsLimit

func (x *ReadRowsRequest) GetRowsLimit() int64

func (*ReadRowsRequest) GetTableName

func (x *ReadRowsRequest) GetTableName() string

func (*ReadRowsRequest) ProtoMessage

func (*ReadRowsRequest) ProtoMessage()

func (*ReadRowsRequest) ProtoReflect

func (x *ReadRowsRequest) ProtoReflect() protoreflect.Message

func (*ReadRowsRequest) Reset

func (x *ReadRowsRequest) Reset()

func (*ReadRowsRequest) String

func (x *ReadRowsRequest) String() string

type ReadRowsRequest_RequestStatsView

type ReadRowsRequest_RequestStatsView int32

The desired view into RequestStats that should be returned in the response.

See also: RequestStats message.

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) Enum

func (ReadRowsRequest_RequestStatsView) EnumDescriptor deprecated

func (ReadRowsRequest_RequestStatsView) EnumDescriptor() ([]byte, []int)

Deprecated: Use ReadRowsRequest_RequestStatsView.Descriptor instead.

func (ReadRowsRequest_RequestStatsView) Number

func (ReadRowsRequest_RequestStatsView) String

func (ReadRowsRequest_RequestStatsView) Type

type ReadRowsResponse

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 deprecated

func (*ReadRowsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadRowsResponse.ProtoReflect.Descriptor instead.

func (*ReadRowsResponse) GetChunks

func (x *ReadRowsResponse) GetChunks() []*ReadRowsResponse_CellChunk

func (*ReadRowsResponse) GetLastScannedRowKey

func (x *ReadRowsResponse) GetLastScannedRowKey() []byte

func (*ReadRowsResponse) GetRequestStats

func (x *ReadRowsResponse) GetRequestStats() *RequestStats

func (*ReadRowsResponse) ProtoMessage

func (*ReadRowsResponse) ProtoMessage()

func (*ReadRowsResponse) ProtoReflect

func (x *ReadRowsResponse) ProtoReflect() protoreflect.Message

func (*ReadRowsResponse) Reset

func (x *ReadRowsResponse) Reset()

func (*ReadRowsResponse) String

func (x *ReadRowsResponse) String() string

type ReadRowsResponse_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 deprecated

func (*ReadRowsResponse_CellChunk) Descriptor() ([]byte, []int)

Deprecated: Use ReadRowsResponse_CellChunk.ProtoReflect.Descriptor instead.

func (*ReadRowsResponse_CellChunk) GetCommitRow

func (x *ReadRowsResponse_CellChunk) GetCommitRow() bool

func (*ReadRowsResponse_CellChunk) GetFamilyName

func (*ReadRowsResponse_CellChunk) GetLabels

func (x *ReadRowsResponse_CellChunk) GetLabels() []string

func (*ReadRowsResponse_CellChunk) GetQualifier

func (*ReadRowsResponse_CellChunk) GetResetRow

func (x *ReadRowsResponse_CellChunk) GetResetRow() bool

func (*ReadRowsResponse_CellChunk) GetRowKey

func (x *ReadRowsResponse_CellChunk) GetRowKey() []byte

func (*ReadRowsResponse_CellChunk) GetRowStatus

func (m *ReadRowsResponse_CellChunk) GetRowStatus() isReadRowsResponse_CellChunk_RowStatus

func (*ReadRowsResponse_CellChunk) GetTimestampMicros

func (x *ReadRowsResponse_CellChunk) GetTimestampMicros() int64

func (*ReadRowsResponse_CellChunk) GetValue

func (x *ReadRowsResponse_CellChunk) GetValue() []byte

func (*ReadRowsResponse_CellChunk) GetValueSize

func (x *ReadRowsResponse_CellChunk) GetValueSize() int32

func (*ReadRowsResponse_CellChunk) ProtoMessage

func (*ReadRowsResponse_CellChunk) ProtoMessage()

func (*ReadRowsResponse_CellChunk) ProtoReflect

func (*ReadRowsResponse_CellChunk) Reset

func (x *ReadRowsResponse_CellChunk) Reset()

func (*ReadRowsResponse_CellChunk) String

func (x *ReadRowsResponse_CellChunk) String() string

type ReadRowsResponse_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"`
}

type 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"`
}

type 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 `` /* 126-byte string literal not displayed */
	// 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 deprecated

func (*RequestLatencyStats) Descriptor() ([]byte, []int)

Deprecated: Use RequestLatencyStats.ProtoReflect.Descriptor instead.

func (*RequestLatencyStats) GetFrontendServerLatency

func (x *RequestLatencyStats) GetFrontendServerLatency() *durationpb.Duration

func (*RequestLatencyStats) ProtoMessage

func (*RequestLatencyStats) ProtoMessage()

func (*RequestLatencyStats) ProtoReflect

func (x *RequestLatencyStats) ProtoReflect() protoreflect.Message

func (*RequestLatencyStats) Reset

func (x *RequestLatencyStats) Reset()

func (*RequestLatencyStats) String

func (x *RequestLatencyStats) String() string

type RequestStats

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 deprecated

func (*RequestStats) Descriptor() ([]byte, []int)

Deprecated: Use RequestStats.ProtoReflect.Descriptor instead.

func (*RequestStats) GetFullReadStatsView

func (x *RequestStats) GetFullReadStatsView() *FullReadStatsView

func (*RequestStats) GetStatsView

func (m *RequestStats) GetStatsView() isRequestStats_StatsView

func (*RequestStats) ProtoMessage

func (*RequestStats) ProtoMessage()

func (*RequestStats) ProtoReflect

func (x *RequestStats) ProtoReflect() protoreflect.Message

func (*RequestStats) Reset

func (x *RequestStats) Reset()

func (*RequestStats) String

func (x *RequestStats) String() string

type RequestStats_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"`
}

type 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 deprecated

func (*ResponseParams) Descriptor() ([]byte, []int)

Deprecated: Use ResponseParams.ProtoReflect.Descriptor instead.

func (*ResponseParams) GetClusterId

func (x *ResponseParams) GetClusterId() string

func (*ResponseParams) GetZoneId

func (x *ResponseParams) GetZoneId() string

func (*ResponseParams) ProtoMessage

func (*ResponseParams) ProtoMessage()

func (*ResponseParams) ProtoReflect

func (x *ResponseParams) ProtoReflect() protoreflect.Message

func (*ResponseParams) Reset

func (x *ResponseParams) Reset()

func (*ResponseParams) String

func (x *ResponseParams) String() string

type 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

func (*Row) Descriptor() ([]byte, []int)

Deprecated: Use Row.ProtoReflect.Descriptor instead.

func (*Row) GetFamilies

func (x *Row) GetFamilies() []*Family

func (*Row) GetKey

func (x *Row) GetKey() []byte

func (*Row) ProtoMessage

func (*Row) ProtoMessage()

func (*Row) ProtoReflect

func (x *Row) ProtoReflect() protoreflect.Message

func (*Row) Reset

func (x *Row) Reset()

func (*Row) String

func (x *Row) String() string

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

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

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

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

func (*RowFilter) Descriptor deprecated

func (*RowFilter) Descriptor() ([]byte, []int)

Deprecated: Use RowFilter.ProtoReflect.Descriptor instead.

func (*RowFilter) GetApplyLabelTransformer

func (x *RowFilter) GetApplyLabelTransformer() string

func (*RowFilter) GetBlockAllFilter

func (x *RowFilter) GetBlockAllFilter() bool

func (*RowFilter) GetCellsPerColumnLimitFilter

func (x *RowFilter) GetCellsPerColumnLimitFilter() int32

func (*RowFilter) GetCellsPerRowLimitFilter

func (x *RowFilter) GetCellsPerRowLimitFilter() int32

func (*RowFilter) GetCellsPerRowOffsetFilter

func (x *RowFilter) GetCellsPerRowOffsetFilter() int32

func (*RowFilter) GetChain

func (x *RowFilter) GetChain() *RowFilter_Chain

func (*RowFilter) GetColumnQualifierRegexFilter

func (x *RowFilter) GetColumnQualifierRegexFilter() []byte

func (*RowFilter) GetColumnRangeFilter

func (x *RowFilter) GetColumnRangeFilter() *ColumnRange

func (*RowFilter) GetCondition

func (x *RowFilter) GetCondition() *RowFilter_Condition

func (*RowFilter) GetFamilyNameRegexFilter

func (x *RowFilter) GetFamilyNameRegexFilter() string

func (*RowFilter) GetFilter

func (m *RowFilter) GetFilter() isRowFilter_Filter

func (*RowFilter) GetInterleave

func (x *RowFilter) GetInterleave() *RowFilter_Interleave

func (*RowFilter) GetPassAllFilter

func (x *RowFilter) GetPassAllFilter() bool

func (*RowFilter) GetRowKeyRegexFilter

func (x *RowFilter) GetRowKeyRegexFilter() []byte

func (*RowFilter) GetRowSampleFilter

func (x *RowFilter) GetRowSampleFilter() float64

func (*RowFilter) GetSink

func (x *RowFilter) GetSink() bool

func (*RowFilter) GetStripValueTransformer

func (x *RowFilter) GetStripValueTransformer() bool

func (*RowFilter) GetTimestampRangeFilter

func (x *RowFilter) GetTimestampRangeFilter() *TimestampRange

func (*RowFilter) GetValueRangeFilter

func (x *RowFilter) GetValueRangeFilter() *ValueRange

func (*RowFilter) GetValueRegexFilter

func (x *RowFilter) GetValueRegexFilter() []byte

func (*RowFilter) ProtoMessage

func (*RowFilter) ProtoMessage()

func (*RowFilter) ProtoReflect

func (x *RowFilter) ProtoReflect() protoreflect.Message

func (*RowFilter) Reset

func (x *RowFilter) Reset()

func (*RowFilter) String

func (x *RowFilter) String() string

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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 deprecated

func (*RowFilter_Chain) Descriptor() ([]byte, []int)

Deprecated: Use RowFilter_Chain.ProtoReflect.Descriptor instead.

func (*RowFilter_Chain) GetFilters

func (x *RowFilter_Chain) GetFilters() []*RowFilter

func (*RowFilter_Chain) ProtoMessage

func (*RowFilter_Chain) ProtoMessage()

func (*RowFilter_Chain) ProtoReflect

func (x *RowFilter_Chain) ProtoReflect() protoreflect.Message

func (*RowFilter_Chain) Reset

func (x *RowFilter_Chain) Reset()

func (*RowFilter_Chain) String

func (x *RowFilter_Chain) String() string

type RowFilter_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"`
}

type 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"`
}

type 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"`
}

type 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 deprecated

func (*RowFilter_Condition) Descriptor() ([]byte, []int)

Deprecated: Use RowFilter_Condition.ProtoReflect.Descriptor instead.

func (*RowFilter_Condition) GetFalseFilter

func (x *RowFilter_Condition) GetFalseFilter() *RowFilter

func (*RowFilter_Condition) GetPredicateFilter

func (x *RowFilter_Condition) GetPredicateFilter() *RowFilter

func (*RowFilter_Condition) GetTrueFilter

func (x *RowFilter_Condition) GetTrueFilter() *RowFilter

func (*RowFilter_Condition) ProtoMessage

func (*RowFilter_Condition) ProtoMessage()

func (*RowFilter_Condition) ProtoReflect

func (x *RowFilter_Condition) ProtoReflect() protoreflect.Message

func (*RowFilter_Condition) Reset

func (x *RowFilter_Condition) Reset()

func (*RowFilter_Condition) String

func (x *RowFilter_Condition) String() string

type RowFilter_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"`
}

type 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"`
}

type 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 deprecated

func (*RowFilter_Interleave) Descriptor() ([]byte, []int)

Deprecated: Use RowFilter_Interleave.ProtoReflect.Descriptor instead.

func (*RowFilter_Interleave) GetFilters

func (x *RowFilter_Interleave) GetFilters() []*RowFilter

func (*RowFilter_Interleave) ProtoMessage

func (*RowFilter_Interleave) ProtoMessage()

func (*RowFilter_Interleave) ProtoReflect

func (x *RowFilter_Interleave) ProtoReflect() protoreflect.Message

func (*RowFilter_Interleave) Reset

func (x *RowFilter_Interleave) Reset()

func (*RowFilter_Interleave) String

func (x *RowFilter_Interleave) String() string

type RowFilter_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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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

func (*RowRange) Descriptor() ([]byte, []int)

Deprecated: Use RowRange.ProtoReflect.Descriptor instead.

func (*RowRange) GetEndKey

func (m *RowRange) GetEndKey() isRowRange_EndKey

func (*RowRange) GetEndKeyClosed

func (x *RowRange) GetEndKeyClosed() []byte

func (*RowRange) GetEndKeyOpen

func (x *RowRange) GetEndKeyOpen() []byte

func (*RowRange) GetStartKey

func (m *RowRange) GetStartKey() isRowRange_StartKey

func (*RowRange) GetStartKeyClosed

func (x *RowRange) GetStartKeyClosed() []byte

func (*RowRange) GetStartKeyOpen

func (x *RowRange) GetStartKeyOpen() []byte

func (*RowRange) ProtoMessage

func (*RowRange) ProtoMessage()

func (*RowRange) ProtoReflect

func (x *RowRange) ProtoReflect() protoreflect.Message

func (*RowRange) Reset

func (x *RowRange) Reset()

func (*RowRange) String

func (x *RowRange) String() string

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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

func (*RowSet) Descriptor() ([]byte, []int)

Deprecated: Use RowSet.ProtoReflect.Descriptor instead.

func (*RowSet) GetRowKeys

func (x *RowSet) GetRowKeys() [][]byte

func (*RowSet) GetRowRanges

func (x *RowSet) GetRowRanges() []*RowRange

func (*RowSet) ProtoMessage

func (*RowSet) ProtoMessage()

func (*RowSet) ProtoReflect

func (x *RowSet) ProtoReflect() protoreflect.Message

func (*RowSet) Reset

func (x *RowSet) Reset()

func (*RowSet) String

func (x *RowSet) String() string

type SampleRowKeysRequest

type SampleRowKeysRequest struct {

	// Optional. The unique name of the table from which to sample row keys.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>`.
	TableName string `protobuf:"bytes,1,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
	// Optional. The unique name of the AuthorizedView from which to sample row
	// keys.
	//
	// Values are of the form
	// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
	AuthorizedViewName string `protobuf:"bytes,4,opt,name=authorized_view_name,json=authorizedViewName,proto3" json:"authorized_view_name,omitempty"`
	// This value specifies routing for replication. If not specified, the
	// "default" application profile will be used.
	AppProfileId string `protobuf:"bytes,2,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for Bigtable.SampleRowKeys.

func (*SampleRowKeysRequest) Descriptor deprecated

func (*SampleRowKeysRequest) Descriptor() ([]byte, []int)

Deprecated: Use SampleRowKeysRequest.ProtoReflect.Descriptor instead.

func (*SampleRowKeysRequest) GetAppProfileId

func (x *SampleRowKeysRequest) GetAppProfileId() string

func (*SampleRowKeysRequest) GetAuthorizedViewName

func (x *SampleRowKeysRequest) GetAuthorizedViewName() string

func (*SampleRowKeysRequest) GetTableName

func (x *SampleRowKeysRequest) GetTableName() string

func (*SampleRowKeysRequest) ProtoMessage

func (*SampleRowKeysRequest) ProtoMessage()

func (*SampleRowKeysRequest) ProtoReflect

func (x *SampleRowKeysRequest) ProtoReflect() protoreflect.Message

func (*SampleRowKeysRequest) Reset

func (x *SampleRowKeysRequest) Reset()

func (*SampleRowKeysRequest) String

func (x *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,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 deprecated

func (*SampleRowKeysResponse) Descriptor() ([]byte, []int)

Deprecated: Use SampleRowKeysResponse.ProtoReflect.Descriptor instead.

func (*SampleRowKeysResponse) GetOffsetBytes

func (x *SampleRowKeysResponse) GetOffsetBytes() int64

func (*SampleRowKeysResponse) GetRowKey

func (x *SampleRowKeysResponse) GetRowKey() []byte

func (*SampleRowKeysResponse) ProtoMessage

func (*SampleRowKeysResponse) ProtoMessage()

func (*SampleRowKeysResponse) ProtoReflect

func (x *SampleRowKeysResponse) ProtoReflect() protoreflect.Message

func (*SampleRowKeysResponse) Reset

func (x *SampleRowKeysResponse) Reset()

func (*SampleRowKeysResponse) String

func (x *SampleRowKeysResponse) String() string

type StreamContinuationToken

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 deprecated

func (*StreamContinuationToken) Descriptor() ([]byte, []int)

Deprecated: Use StreamContinuationToken.ProtoReflect.Descriptor instead.

func (*StreamContinuationToken) GetPartition

func (x *StreamContinuationToken) GetPartition() *StreamPartition

func (*StreamContinuationToken) GetToken

func (x *StreamContinuationToken) GetToken() string

func (*StreamContinuationToken) ProtoMessage

func (*StreamContinuationToken) ProtoMessage()

func (*StreamContinuationToken) ProtoReflect

func (x *StreamContinuationToken) ProtoReflect() protoreflect.Message

func (*StreamContinuationToken) Reset

func (x *StreamContinuationToken) Reset()

func (*StreamContinuationToken) String

func (x *StreamContinuationToken) String() string

type StreamContinuationTokens

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 deprecated

func (*StreamContinuationTokens) Descriptor() ([]byte, []int)

Deprecated: Use StreamContinuationTokens.ProtoReflect.Descriptor instead.

func (*StreamContinuationTokens) GetTokens

func (*StreamContinuationTokens) ProtoMessage

func (*StreamContinuationTokens) ProtoMessage()

func (*StreamContinuationTokens) ProtoReflect

func (x *StreamContinuationTokens) ProtoReflect() protoreflect.Message

func (*StreamContinuationTokens) Reset

func (x *StreamContinuationTokens) Reset()

func (*StreamContinuationTokens) String

func (x *StreamContinuationTokens) String() string

type StreamPartition

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 deprecated

func (*StreamPartition) Descriptor() ([]byte, []int)

Deprecated: Use StreamPartition.ProtoReflect.Descriptor instead.

func (*StreamPartition) GetRowRange

func (x *StreamPartition) GetRowRange() *RowRange

func (*StreamPartition) ProtoMessage

func (*StreamPartition) ProtoMessage()

func (*StreamPartition) ProtoReflect

func (x *StreamPartition) ProtoReflect() protoreflect.Message

func (*StreamPartition) Reset

func (x *StreamPartition) Reset()

func (*StreamPartition) String

func (x *StreamPartition) String() string

type TimestampRange

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 deprecated

func (*TimestampRange) Descriptor() ([]byte, []int)

Deprecated: Use TimestampRange.ProtoReflect.Descriptor instead.

func (*TimestampRange) GetEndTimestampMicros

func (x *TimestampRange) GetEndTimestampMicros() int64

func (*TimestampRange) GetStartTimestampMicros

func (x *TimestampRange) GetStartTimestampMicros() int64

func (*TimestampRange) ProtoMessage

func (*TimestampRange) ProtoMessage()

func (*TimestampRange) ProtoReflect

func (x *TimestampRange) ProtoReflect() protoreflect.Message

func (*TimestampRange) Reset

func (x *TimestampRange) Reset()

func (*TimestampRange) String

func (x *TimestampRange) String() string

type UnimplementedBigtableServer

type UnimplementedBigtableServer struct {
}

UnimplementedBigtableServer can be embedded to have forward compatible implementations.

func (*UnimplementedBigtableServer) CheckAndMutateRow

func (*UnimplementedBigtableServer) MutateRow

func (*UnimplementedBigtableServer) MutateRows

func (*UnimplementedBigtableServer) PingAndWarm

func (*UnimplementedBigtableServer) ReadChangeStream

func (*UnimplementedBigtableServer) ReadModifyWriteRow

func (*UnimplementedBigtableServer) ReadRows

func (*UnimplementedBigtableServer) SampleRowKeys

type Value

type Value struct {

	// 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_IntValue
	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

func (*Value) Descriptor() ([]byte, []int)

Deprecated: Use Value.ProtoReflect.Descriptor instead.

func (*Value) GetIntValue

func (x *Value) GetIntValue() int64

func (*Value) GetKind

func (m *Value) GetKind() isValue_Kind

func (*Value) GetRawTimestampMicros

func (x *Value) GetRawTimestampMicros() int64

func (*Value) GetRawValue

func (x *Value) GetRawValue() []byte

func (*Value) ProtoMessage

func (*Value) ProtoMessage()

func (*Value) ProtoReflect

func (x *Value) ProtoReflect() protoreflect.Message

func (*Value) Reset

func (x *Value) Reset()

func (*Value) String

func (x *Value) String() string

type 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 deprecated

func (*ValueRange) Descriptor() ([]byte, []int)

Deprecated: Use ValueRange.ProtoReflect.Descriptor instead.

func (*ValueRange) GetEndValue

func (m *ValueRange) GetEndValue() isValueRange_EndValue

func (*ValueRange) GetEndValueClosed

func (x *ValueRange) GetEndValueClosed() []byte

func (*ValueRange) GetEndValueOpen

func (x *ValueRange) GetEndValueOpen() []byte

func (*ValueRange) GetStartValue

func (m *ValueRange) GetStartValue() isValueRange_StartValue

func (*ValueRange) GetStartValueClosed

func (x *ValueRange) GetStartValueClosed() []byte

func (*ValueRange) GetStartValueOpen

func (x *ValueRange) GetStartValueOpen() []byte

func (*ValueRange) ProtoMessage

func (*ValueRange) ProtoMessage()

func (*ValueRange) ProtoReflect

func (x *ValueRange) ProtoReflect() protoreflect.Message

func (*ValueRange) Reset

func (x *ValueRange) Reset()

func (*ValueRange) String

func (x *ValueRange) String() string

type ValueRange_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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type Value_IntValue

type Value_IntValue struct {
	// Represents a typed value transported as an integer.
	// Default type for writes: `Int64`
	IntValue int64 `protobuf:"varint,6,opt,name=int_value,json=intValue,proto3,oneof"`
}

type 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"`
}

type 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"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL