Documentation
¶
Overview ¶
Package google_bigtable_admin_table_v1 is a generated protocol buffer package.
It is generated from these files:
google.golang.org/cloud/bigtable/internal/table_service_proto/bigtable_table_service_messages.proto google.golang.org/cloud/bigtable/internal/table_service_proto/bigtable_table_service.proto
It has these top-level messages:
CreateTableRequest ListTablesRequest ListTablesResponse GetTableRequest DeleteTableRequest RenameTableRequest CreateColumnFamilyRequest DeleteColumnFamilyRequest
Index ¶
- func RegisterBigtableTableServiceServer(s *grpc.Server, srv BigtableTableServiceServer)
- type BigtableTableServiceClient
- type BigtableTableServiceServer
- type CreateColumnFamilyRequest
- func (*CreateColumnFamilyRequest) Descriptor() ([]byte, []int)
- func (m *CreateColumnFamilyRequest) GetColumnFamily() *google_bigtable_admin_table_v11.ColumnFamily
- func (*CreateColumnFamilyRequest) ProtoMessage()
- func (m *CreateColumnFamilyRequest) Reset()
- func (m *CreateColumnFamilyRequest) String() string
- type CreateTableRequest
- type DeleteColumnFamilyRequest
- type DeleteTableRequest
- type GetTableRequest
- type ListTablesRequest
- type ListTablesResponse
- type RenameTableRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterBigtableTableServiceServer ¶
func RegisterBigtableTableServiceServer(s *grpc.Server, srv BigtableTableServiceServer)
Types ¶
type BigtableTableServiceClient ¶
type BigtableTableServiceClient interface {
// Creates a new table, to be served from a specified cluster.
// The table can be created with a full set of initial column families,
// specified in the request.
CreateTable(ctx context.Context, in *CreateTableRequest, opts ...grpc.CallOption) (*google_bigtable_admin_table_v11.Table, error)
// Lists the names of all tables served from a specified cluster.
ListTables(ctx context.Context, in *ListTablesRequest, opts ...grpc.CallOption) (*ListTablesResponse, error)
// Gets the schema of the specified table, including its column families.
GetTable(ctx context.Context, in *GetTableRequest, opts ...grpc.CallOption) (*google_bigtable_admin_table_v11.Table, error)
// Permanently deletes a specified table and all of its data.
DeleteTable(ctx context.Context, in *DeleteTableRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error)
// Changes the name of a specified table.
// Cannot be used to move tables between clusters, zones, or projects.
RenameTable(ctx context.Context, in *RenameTableRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error)
// Creates a new column family within a specified table.
CreateColumnFamily(ctx context.Context, in *CreateColumnFamilyRequest, opts ...grpc.CallOption) (*google_bigtable_admin_table_v11.ColumnFamily, error)
// Changes the configuration of a specified column family.
UpdateColumnFamily(ctx context.Context, in *google_bigtable_admin_table_v11.ColumnFamily, opts ...grpc.CallOption) (*google_bigtable_admin_table_v11.ColumnFamily, error)
// Permanently deletes a specified column family and all of its data.
DeleteColumnFamily(ctx context.Context, in *DeleteColumnFamilyRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error)
}
func NewBigtableTableServiceClient ¶
func NewBigtableTableServiceClient(cc *grpc.ClientConn) BigtableTableServiceClient
type BigtableTableServiceServer ¶
type BigtableTableServiceServer interface {
// Creates a new table, to be served from a specified cluster.
// The table can be created with a full set of initial column families,
// specified in the request.
CreateTable(context.Context, *CreateTableRequest) (*google_bigtable_admin_table_v11.Table, error)
// Lists the names of all tables served from a specified cluster.
ListTables(context.Context, *ListTablesRequest) (*ListTablesResponse, error)
// Gets the schema of the specified table, including its column families.
GetTable(context.Context, *GetTableRequest) (*google_bigtable_admin_table_v11.Table, error)
// Permanently deletes a specified table and all of its data.
DeleteTable(context.Context, *DeleteTableRequest) (*google_protobuf1.Empty, error)
// Changes the name of a specified table.
// Cannot be used to move tables between clusters, zones, or projects.
RenameTable(context.Context, *RenameTableRequest) (*google_protobuf1.Empty, error)
// Creates a new column family within a specified table.
CreateColumnFamily(context.Context, *CreateColumnFamilyRequest) (*google_bigtable_admin_table_v11.ColumnFamily, error)
// Changes the configuration of a specified column family.
UpdateColumnFamily(context.Context, *google_bigtable_admin_table_v11.ColumnFamily) (*google_bigtable_admin_table_v11.ColumnFamily, error)
// Permanently deletes a specified column family and all of its data.
DeleteColumnFamily(context.Context, *DeleteColumnFamilyRequest) (*google_protobuf1.Empty, error)
}
type CreateColumnFamilyRequest ¶
type CreateColumnFamilyRequest struct {
// The unique name of the table in which to create the new column family.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// The name by which the new column family should be referred to within the
// table, e.g. "foobar" rather than "<table_name>/columnFamilies/foobar".
ColumnFamilyId string `protobuf:"bytes,2,opt,name=column_family_id" json:"column_family_id,omitempty"`
// The column family to create. The `name` field must be left blank.
ColumnFamily *google_bigtable_admin_table_v11.ColumnFamily `protobuf:"bytes,3,opt,name=column_family" json:"column_family,omitempty"`
}
func (*CreateColumnFamilyRequest) Descriptor ¶
func (*CreateColumnFamilyRequest) Descriptor() ([]byte, []int)
func (*CreateColumnFamilyRequest) GetColumnFamily ¶
func (m *CreateColumnFamilyRequest) GetColumnFamily() *google_bigtable_admin_table_v11.ColumnFamily
func (*CreateColumnFamilyRequest) ProtoMessage ¶
func (*CreateColumnFamilyRequest) ProtoMessage()
func (*CreateColumnFamilyRequest) Reset ¶
func (m *CreateColumnFamilyRequest) Reset()
func (*CreateColumnFamilyRequest) String ¶
func (m *CreateColumnFamilyRequest) String() string
type CreateTableRequest ¶
type CreateTableRequest struct {
// The unique name of the cluster in which to create the new table.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// The name by which the new table should be referred to within the cluster,
// e.g. "foobar" rather than "<cluster_name>/tables/foobar".
TableId string `protobuf:"bytes,2,opt,name=table_id" json:"table_id,omitempty"`
// The Table to create. The `name` field of the Table and all of its
// ColumnFamilies must be left blank, and will be populated in the response.
Table *google_bigtable_admin_table_v11.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"}.
InitialSplitKeys []string `protobuf:"bytes,4,rep,name=initial_split_keys" json:"initial_split_keys,omitempty"`
}
func (*CreateTableRequest) Descriptor ¶
func (*CreateTableRequest) Descriptor() ([]byte, []int)
func (*CreateTableRequest) GetTable ¶
func (m *CreateTableRequest) GetTable() *google_bigtable_admin_table_v11.Table
func (*CreateTableRequest) ProtoMessage ¶
func (*CreateTableRequest) ProtoMessage()
func (*CreateTableRequest) Reset ¶
func (m *CreateTableRequest) Reset()
func (*CreateTableRequest) String ¶
func (m *CreateTableRequest) String() string
type DeleteColumnFamilyRequest ¶
type DeleteColumnFamilyRequest struct {
// The unique name of the column family to be deleted.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*DeleteColumnFamilyRequest) Descriptor ¶
func (*DeleteColumnFamilyRequest) Descriptor() ([]byte, []int)
func (*DeleteColumnFamilyRequest) ProtoMessage ¶
func (*DeleteColumnFamilyRequest) ProtoMessage()
func (*DeleteColumnFamilyRequest) Reset ¶
func (m *DeleteColumnFamilyRequest) Reset()
func (*DeleteColumnFamilyRequest) String ¶
func (m *DeleteColumnFamilyRequest) String() string
type DeleteTableRequest ¶
type DeleteTableRequest struct {
// The unique name of the table to be deleted.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
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 GetTableRequest ¶
type GetTableRequest struct {
// The unique name of the requested table.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
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 cluster for which tables should be listed.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
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.
// At present, only the names of the tables are populated.
Tables []*google_bigtable_admin_table_v11.Table `protobuf:"bytes,1,rep,name=tables" json:"tables,omitempty"`
}
func (*ListTablesResponse) Descriptor ¶
func (*ListTablesResponse) Descriptor() ([]byte, []int)
func (*ListTablesResponse) GetTables ¶
func (m *ListTablesResponse) GetTables() []*google_bigtable_admin_table_v11.Table
func (*ListTablesResponse) ProtoMessage ¶
func (*ListTablesResponse) ProtoMessage()
func (*ListTablesResponse) Reset ¶
func (m *ListTablesResponse) Reset()
func (*ListTablesResponse) String ¶
func (m *ListTablesResponse) String() string
type RenameTableRequest ¶
type RenameTableRequest struct {
// The current unique name of the table.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// The new name by which the table should be referred to within its containing
// cluster, e.g. "foobar" rather than "<cluster_name>/tables/foobar".
NewId string `protobuf:"bytes,2,opt,name=new_id" json:"new_id,omitempty"`
}
func (*RenameTableRequest) Descriptor ¶
func (*RenameTableRequest) Descriptor() ([]byte, []int)
func (*RenameTableRequest) ProtoMessage ¶
func (*RenameTableRequest) ProtoMessage()
func (*RenameTableRequest) Reset ¶
func (m *RenameTableRequest) Reset()
func (*RenameTableRequest) String ¶
func (m *RenameTableRequest) String() string
Click to show internal directories.
Click to hide internal directories.