Documentation ¶
Overview ¶
Package google_bigtable_admin_v2 is a generated protocol buffer package.
It is generated from these files:
google.golang.org/cloud/bigtable/internal/table_service_proto/bigtable_table_admin.proto
It has these top-level messages:
CreateTableRequest DropRowRangeRequest ListTablesRequest ListTablesResponse GetTableRequest DeleteTableRequest ModifyColumnFamiliesRequest
Index ¶
- func RegisterBigtableTableAdminServer(s *grpc.Server, srv BigtableTableAdminServer)
- type BigtableTableAdminClient
- type BigtableTableAdminServer
- type CreateTableRequest
- func (*CreateTableRequest) Descriptor() ([]byte, []int)
- func (m *CreateTableRequest) GetInitialSplits() []*CreateTableRequest_Split
- func (m *CreateTableRequest) GetTable() *google_bigtable_admin_v21.Table
- func (*CreateTableRequest) ProtoMessage()
- func (m *CreateTableRequest) Reset()
- func (m *CreateTableRequest) String() string
- type CreateTableRequest_Split
- type DeleteTableRequest
- type DropRowRangeRequest
- func (*DropRowRangeRequest) Descriptor() ([]byte, []int)
- func (m *DropRowRangeRequest) GetDeleteAllDataFromTable() bool
- func (m *DropRowRangeRequest) GetRowKeyPrefix() []byte
- func (m *DropRowRangeRequest) GetTarget() isDropRowRangeRequest_Target
- func (*DropRowRangeRequest) ProtoMessage()
- func (m *DropRowRangeRequest) Reset()
- func (m *DropRowRangeRequest) String() string
- func (*DropRowRangeRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type DropRowRangeRequest_DeleteAllDataFromTable
- type DropRowRangeRequest_RowKeyPrefix
- type GetTableRequest
- type ListTablesRequest
- type ListTablesResponse
- type ModifyColumnFamiliesRequest
- func (*ModifyColumnFamiliesRequest) Descriptor() ([]byte, []int)
- func (m *ModifyColumnFamiliesRequest) GetModifications() []*ModifyColumnFamiliesRequest_Modification
- func (*ModifyColumnFamiliesRequest) ProtoMessage()
- func (m *ModifyColumnFamiliesRequest) Reset()
- func (m *ModifyColumnFamiliesRequest) String() string
- type ModifyColumnFamiliesRequest_Modification
- func (*ModifyColumnFamiliesRequest_Modification) Descriptor() ([]byte, []int)
- func (m *ModifyColumnFamiliesRequest_Modification) GetCreate() *google_bigtable_admin_v21.ColumnFamily
- func (m *ModifyColumnFamiliesRequest_Modification) GetDrop() bool
- func (m *ModifyColumnFamiliesRequest_Modification) GetMod() isModifyColumnFamiliesRequest_Modification_Mod
- func (m *ModifyColumnFamiliesRequest_Modification) GetUpdate() *google_bigtable_admin_v21.ColumnFamily
- func (*ModifyColumnFamiliesRequest_Modification) ProtoMessage()
- func (m *ModifyColumnFamiliesRequest_Modification) Reset()
- func (m *ModifyColumnFamiliesRequest_Modification) String() string
- func (*ModifyColumnFamiliesRequest_Modification) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type ModifyColumnFamiliesRequest_Modification_Create
- type ModifyColumnFamiliesRequest_Modification_Drop
- type ModifyColumnFamiliesRequest_Modification_Update
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterBigtableTableAdminServer ¶
func RegisterBigtableTableAdminServer(s *grpc.Server, srv BigtableTableAdminServer)
Types ¶
type BigtableTableAdminClient ¶
type BigtableTableAdminClient interface { // Creates a new table in the specified instance. // The table can be created with a full set of initial column families, // specified in the request. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. CreateTable(ctx context.Context, in *CreateTableRequest, opts ...grpc.CallOption) (*google_bigtable_admin_v21.Table, error) // Lists all tables served from a specified instance. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. ListTables(ctx context.Context, in *ListTablesRequest, opts ...grpc.CallOption) (*ListTablesResponse, error) // Gets metadata information about the specified table. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. GetTable(ctx context.Context, in *GetTableRequest, opts ...grpc.CallOption) (*google_bigtable_admin_v21.Table, error) // Permanently deletes a specified table and all of its data. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. DeleteTable(ctx context.Context, in *DeleteTableRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error) // Atomically performs a series of column family modifications // on the specified table. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. ModifyColumnFamilies(ctx context.Context, in *ModifyColumnFamiliesRequest, opts ...grpc.CallOption) (*google_bigtable_admin_v21.Table, error) // Permanently drop/delete a row range from a specified table. The request can // specify whether to delete all rows in a table, or only those that match a // particular prefix. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. DropRowRange(ctx context.Context, in *DropRowRangeRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error) }
func NewBigtableTableAdminClient ¶
func NewBigtableTableAdminClient(cc *grpc.ClientConn) BigtableTableAdminClient
type BigtableTableAdminServer ¶
type BigtableTableAdminServer interface { // Creates a new table in the specified instance. // The table can be created with a full set of initial column families, // specified in the request. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. CreateTable(context.Context, *CreateTableRequest) (*google_bigtable_admin_v21.Table, error) // Lists all tables served from a specified instance. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. ListTables(context.Context, *ListTablesRequest) (*ListTablesResponse, error) // Gets metadata information about the specified table. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. GetTable(context.Context, *GetTableRequest) (*google_bigtable_admin_v21.Table, error) // Permanently deletes a specified table and all of its data. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. DeleteTable(context.Context, *DeleteTableRequest) (*google_protobuf1.Empty, error) // Atomically performs a series of column family modifications // on the specified table. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. ModifyColumnFamilies(context.Context, *ModifyColumnFamiliesRequest) (*google_bigtable_admin_v21.Table, error) // Permanently drop/delete a row range from a specified table. The request can // specify whether to delete all rows in a table, or only those that match a // particular prefix. // // Caution: This rpc is experimental. The details can change and the rpc // may or may not be active. DropRowRange(context.Context, *DropRowRangeRequest) (*google_protobuf1.Empty, error) }
type CreateTableRequest ¶
type CreateTableRequest struct { // The unique name of the instance in which to create the table. // Values are of the form projects/<project>/instances/<instance> Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The name by which the new table should be referred to within the parent // instance, e.g. "foobar" rather than "<parent>/tables/foobar". TableId string `protobuf:"bytes,2,opt,name=table_id,json=tableId" json:"table_id,omitempty"` // The Table to create. Table *google_bigtable_admin_v21.Table `protobuf:"bytes,3,opt,name=table" json:"table,omitempty"` // The optional list of row keys that will be used to initially split the // table into several tablets (Tablets are similar to HBase regions). // Given two split keys, "s1" and "s2", three tablets will be created, // spanning the key ranges: [, s1), [s1, s2), [s2, ). // // Example: // * Row keys := ["a", "apple", "custom", "customer_1", "customer_2", // "other", "zz"] // * initial_split_keys := ["apple", "customer_1", "customer_2", "other"] // * Key assignment: // - Tablet 1 [, apple) => {"a"}. // - Tablet 2 [apple, customer_1) => {"apple", "custom"}. // - Tablet 3 [customer_1, customer_2) => {"customer_1"}. // - Tablet 4 [customer_2, other) => {"customer_2"}. // - Tablet 5 [other, ) => {"other", "zz"}. InitialSplits []*CreateTableRequest_Split `protobuf:"bytes,4,rep,name=initial_splits,json=initialSplits" json:"initial_splits,omitempty"` }
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CreateTable][google.bigtable.admin.v2.BigtableTableAdmin.CreateTable]
func (*CreateTableRequest) Descriptor ¶
func (*CreateTableRequest) Descriptor() ([]byte, []int)
func (*CreateTableRequest) GetInitialSplits ¶
func (m *CreateTableRequest) GetInitialSplits() []*CreateTableRequest_Split
func (*CreateTableRequest) GetTable ¶
func (m *CreateTableRequest) GetTable() *google_bigtable_admin_v21.Table
func (*CreateTableRequest) ProtoMessage ¶
func (*CreateTableRequest) ProtoMessage()
func (*CreateTableRequest) Reset ¶
func (m *CreateTableRequest) Reset()
func (*CreateTableRequest) String ¶
func (m *CreateTableRequest) String() string
type CreateTableRequest_Split ¶
type CreateTableRequest_Split struct { // Row key to use as an initial tablet boundary. Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` }
An initial split point for a newly created table.
func (*CreateTableRequest_Split) Descriptor ¶
func (*CreateTableRequest_Split) Descriptor() ([]byte, []int)
func (*CreateTableRequest_Split) ProtoMessage ¶
func (*CreateTableRequest_Split) ProtoMessage()
func (*CreateTableRequest_Split) Reset ¶
func (m *CreateTableRequest_Split) Reset()
func (*CreateTableRequest_Split) String ¶
func (m *CreateTableRequest_Split) String() string
type DeleteTableRequest ¶
type DeleteTableRequest struct { // The unique name of the table to be deleted. // Values are of the form projects/<project>/instances/<instance>/tables/<table> Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` }
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]
func (*DeleteTableRequest) Descriptor ¶
func (*DeleteTableRequest) Descriptor() ([]byte, []int)
func (*DeleteTableRequest) ProtoMessage ¶
func (*DeleteTableRequest) ProtoMessage()
func (*DeleteTableRequest) Reset ¶
func (m *DeleteTableRequest) Reset()
func (*DeleteTableRequest) String ¶
func (m *DeleteTableRequest) String() string
type DropRowRangeRequest ¶
type DropRowRangeRequest struct { // The unique name of the table on which to drop a range of rows. // Values are of the form projects/<project>/instances/<instance>/tables/<table> Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // Types that are valid to be assigned to Target: // *DropRowRangeRequest_RowKeyPrefix // *DropRowRangeRequest_DeleteAllDataFromTable Target isDropRowRangeRequest_Target `protobuf_oneof:"target"` }
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange][google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange]
func (*DropRowRangeRequest) Descriptor ¶
func (*DropRowRangeRequest) Descriptor() ([]byte, []int)
func (*DropRowRangeRequest) GetDeleteAllDataFromTable ¶
func (m *DropRowRangeRequest) GetDeleteAllDataFromTable() bool
func (*DropRowRangeRequest) GetRowKeyPrefix ¶
func (m *DropRowRangeRequest) GetRowKeyPrefix() []byte
func (*DropRowRangeRequest) GetTarget ¶
func (m *DropRowRangeRequest) GetTarget() isDropRowRangeRequest_Target
func (*DropRowRangeRequest) ProtoMessage ¶
func (*DropRowRangeRequest) ProtoMessage()
func (*DropRowRangeRequest) Reset ¶
func (m *DropRowRangeRequest) Reset()
func (*DropRowRangeRequest) String ¶
func (m *DropRowRangeRequest) String() string
func (*DropRowRangeRequest) XXX_OneofFuncs ¶
func (*DropRowRangeRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type DropRowRangeRequest_DeleteAllDataFromTable ¶
type DropRowRangeRequest_DeleteAllDataFromTable struct {
DeleteAllDataFromTable bool `protobuf:"varint,3,opt,name=delete_all_data_from_table,json=deleteAllDataFromTable,oneof"`
}
type DropRowRangeRequest_RowKeyPrefix ¶
type DropRowRangeRequest_RowKeyPrefix struct {
RowKeyPrefix []byte `protobuf:"bytes,2,opt,name=row_key_prefix,json=rowKeyPrefix,proto3,oneof"`
}
type GetTableRequest ¶
type GetTableRequest struct { // The unique name of the requested table. // Values are of the form projects/<project>/instances/<instance>/tables/<table> Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The view to be applied to the returned table's fields. // Defaults to SCHEMA_ONLY if unspecified. View google_bigtable_admin_v21.Table_View `protobuf:"varint,2,opt,name=view,enum=google.bigtable.admin.v2.Table_View" json:"view,omitempty"` }
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetTable][google.bigtable.admin.v2.BigtableTableAdmin.GetTable]
func (*GetTableRequest) Descriptor ¶
func (*GetTableRequest) Descriptor() ([]byte, []int)
func (*GetTableRequest) ProtoMessage ¶
func (*GetTableRequest) ProtoMessage()
func (*GetTableRequest) Reset ¶
func (m *GetTableRequest) Reset()
func (*GetTableRequest) String ¶
func (m *GetTableRequest) String() string
type ListTablesRequest ¶
type ListTablesRequest struct { // The unique name of the instance for which tables should be listed. // Values are of the form projects/<project>/instances/<instance> Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The view to be applied to the returned tables' fields. // Defaults to NAME_ONLY if unspecified (no others are currently supported). View google_bigtable_admin_v21.Table_View `protobuf:"varint,2,opt,name=view,enum=google.bigtable.admin.v2.Table_View" json:"view,omitempty"` // Not yet supported. PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"` }
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
func (*ListTablesRequest) Descriptor ¶
func (*ListTablesRequest) Descriptor() ([]byte, []int)
func (*ListTablesRequest) ProtoMessage ¶
func (*ListTablesRequest) ProtoMessage()
func (*ListTablesRequest) Reset ¶
func (m *ListTablesRequest) Reset()
func (*ListTablesRequest) String ¶
func (m *ListTablesRequest) String() string
type ListTablesResponse ¶
type ListTablesResponse struct { // The tables present in the requested cluster. Tables []*google_bigtable_admin_v21.Table `protobuf:"bytes,1,rep,name=tables" json:"tables,omitempty"` NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"` }
Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
func (*ListTablesResponse) Descriptor ¶
func (*ListTablesResponse) Descriptor() ([]byte, []int)
func (*ListTablesResponse) GetTables ¶
func (m *ListTablesResponse) GetTables() []*google_bigtable_admin_v21.Table
func (*ListTablesResponse) ProtoMessage ¶
func (*ListTablesResponse) ProtoMessage()
func (*ListTablesResponse) Reset ¶
func (m *ListTablesResponse) Reset()
func (*ListTablesResponse) String ¶
func (m *ListTablesResponse) String() string
type ModifyColumnFamiliesRequest ¶
type ModifyColumnFamiliesRequest struct { // The unique name of the table whose families should be modified. // Values are of the form projects/<project>/instances/<instance>/tables/<table> Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // Modifications to be atomically applied to the specified table's families. // Entries are applied in order, meaning that earlier modifications can be // masked by later ones (in the case of repeated updates to the same family, // for example). Modifications []*ModifyColumnFamiliesRequest_Modification `protobuf:"bytes,2,rep,name=modifications" json:"modifications,omitempty"` }
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies][google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies]
func (*ModifyColumnFamiliesRequest) Descriptor ¶
func (*ModifyColumnFamiliesRequest) Descriptor() ([]byte, []int)
func (*ModifyColumnFamiliesRequest) GetModifications ¶
func (m *ModifyColumnFamiliesRequest) GetModifications() []*ModifyColumnFamiliesRequest_Modification
func (*ModifyColumnFamiliesRequest) ProtoMessage ¶
func (*ModifyColumnFamiliesRequest) ProtoMessage()
func (*ModifyColumnFamiliesRequest) Reset ¶
func (m *ModifyColumnFamiliesRequest) Reset()
func (*ModifyColumnFamiliesRequest) String ¶
func (m *ModifyColumnFamiliesRequest) String() string
type ModifyColumnFamiliesRequest_Modification ¶
type ModifyColumnFamiliesRequest_Modification struct { // The ID of the column family to be modified. Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Types that are valid to be assigned to Mod: // *ModifyColumnFamiliesRequest_Modification_Create // *ModifyColumnFamiliesRequest_Modification_Update // *ModifyColumnFamiliesRequest_Modification_Drop Mod isModifyColumnFamiliesRequest_Modification_Mod `protobuf_oneof:"mod"` }
A create, update, or delete of a particular column family.
func (*ModifyColumnFamiliesRequest_Modification) Descriptor ¶
func (*ModifyColumnFamiliesRequest_Modification) Descriptor() ([]byte, []int)
func (*ModifyColumnFamiliesRequest_Modification) GetCreate ¶
func (m *ModifyColumnFamiliesRequest_Modification) GetCreate() *google_bigtable_admin_v21.ColumnFamily
func (*ModifyColumnFamiliesRequest_Modification) GetDrop ¶
func (m *ModifyColumnFamiliesRequest_Modification) GetDrop() bool
func (*ModifyColumnFamiliesRequest_Modification) GetMod ¶
func (m *ModifyColumnFamiliesRequest_Modification) GetMod() isModifyColumnFamiliesRequest_Modification_Mod
func (*ModifyColumnFamiliesRequest_Modification) GetUpdate ¶
func (m *ModifyColumnFamiliesRequest_Modification) GetUpdate() *google_bigtable_admin_v21.ColumnFamily
func (*ModifyColumnFamiliesRequest_Modification) ProtoMessage ¶
func (*ModifyColumnFamiliesRequest_Modification) ProtoMessage()
func (*ModifyColumnFamiliesRequest_Modification) Reset ¶
func (m *ModifyColumnFamiliesRequest_Modification) Reset()
func (*ModifyColumnFamiliesRequest_Modification) String ¶
func (m *ModifyColumnFamiliesRequest_Modification) String() string
func (*ModifyColumnFamiliesRequest_Modification) XXX_OneofFuncs ¶
func (*ModifyColumnFamiliesRequest_Modification) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type ModifyColumnFamiliesRequest_Modification_Create ¶
type ModifyColumnFamiliesRequest_Modification_Create struct {
Create *google_bigtable_admin_v21.ColumnFamily `protobuf:"bytes,2,opt,name=create,oneof"`
}
type ModifyColumnFamiliesRequest_Modification_Drop ¶
type ModifyColumnFamiliesRequest_Modification_Drop struct {
Drop bool `protobuf:"varint,4,opt,name=drop,oneof"`
}
type ModifyColumnFamiliesRequest_Modification_Update ¶
type ModifyColumnFamiliesRequest_Modification_Update struct {
Update *google_bigtable_admin_v21.ColumnFamily `protobuf:"bytes,3,opt,name=update,oneof"`
}