google_bigtable_admin_table_v1

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_data_proto/bigtable_table_data.proto

It has these top-level messages:

Table
ColumnFamily
GcRule

Index

• Variables
• type ColumnFamily
  • func (m *ColumnFamily) GetGcRule() *GcRule
  • func (*ColumnFamily) ProtoMessage()
  • func (m *ColumnFamily) Reset()
  • func (m *ColumnFamily) String() string
• type GcRule
  • func (m *GcRule) GetIntersection() *GcRule_Intersection
  • func (m *GcRule) GetMaxAge() *google_protobuf.Duration
  • func (m *GcRule) GetMaxNumVersions() int32
  • func (m *GcRule) GetRule() isGcRule_Rule
  • func (m *GcRule) GetUnion() *GcRule_Union
  • func (*GcRule) ProtoMessage()
  • func (m *GcRule) Reset()
  • func (m *GcRule) String() string
  • func (*GcRule) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
• type GcRule_Intersection
  • func (m *GcRule_Intersection) GetRules() []*GcRule
  • func (*GcRule_Intersection) ProtoMessage()
  • func (m *GcRule_Intersection) Reset()
  • func (m *GcRule_Intersection) String() string
• type GcRule_Intersection_
• type GcRule_MaxAge
• type GcRule_MaxNumVersions
• type GcRule_Union
  • func (m *GcRule_Union) GetRules() []*GcRule
  • func (*GcRule_Union) ProtoMessage()
  • func (m *GcRule_Union) Reset()
  • func (m *GcRule_Union) String() string
• type GcRule_Union_
• type Table
  • func (m *Table) GetColumnFamilies() map[string]*ColumnFamily
  • func (*Table) ProtoMessage()
  • func (m *Table) Reset()
  • func (m *Table) String() string
• type Table_TimestampGranularity
  • func (x Table_TimestampGranularity) String() string

Variables

var Table_TimestampGranularity_name = map[int32]string{
	0: "MILLIS",
}

var Table_TimestampGranularity_value = map[string]int32{
	"MILLIS": 0,
}

Types

type ColumnFamily

type ColumnFamily struct {
	// A unique identifier of the form <table_name>/columnFamilies/[-_.a-zA-Z0-9]+
	// The last segment is the same as the "name" field in
	// google.bigtable.v1.Family.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Garbage collection expression specified by the following grammar:
	//   GC = EXPR
	//      | "" ;
	//   EXPR = EXPR, "||", EXPR              (* lowest precedence *)
	//        | EXPR, "&&", EXPR
	//        | "(", EXPR, ")"                (* highest precedence *)
	//        | PROP ;
	//   PROP = "version() >", NUM32
	//        | "age() >", NUM64, [ UNIT ] ;
	//   NUM32 = non-zero-digit { digit } ;    (* # NUM32 <= 2^32 - 1 *)
	//   NUM64 = non-zero-digit { digit } ;    (* # NUM64 <= 2^63 - 1 *)
	//   UNIT =  "d" | "h" | "m"  (* d=days, h=hours, m=minutes, else micros *)
	// GC expressions can be up to 500 characters in length
	//
	// The different types of PROP are defined as follows:
	//   version() - cell index, counting from most recent and starting at 1
	//   age() - age of the cell (current time minus cell timestamp)
	//
	// Example: "version() > 3 || (age() > 3d && version() > 1)"
	//   drop cells beyond the most recent three, and drop cells older than three
	//   days unless they're the most recent cell in the row/column
	//
	// Garbage collection executes opportunistically in the background, and so
	// it's possible for reads to return a cell even if it matches the active GC
	// expression for its family.
	GcExpression string `protobuf:"bytes,2,opt,name=gc_expression" json:"gc_expression,omitempty"`
	// Garbage collection rule specified as a protobuf.
	// Supersedes `gc_expression`.
	// Must serialize to at most 500 bytes.
	//
	// NOTE: Garbage collection executes opportunistically in the background, and
	// so it's possible for reads to return a cell even if it matches the active
	// GC expression for its family.
	GcRule *GcRule `protobuf:"bytes,3,opt,name=gc_rule" json:"gc_rule,omitempty"`
}

A set of columns within a table which share a common configuration.

func (*ColumnFamily) GetGcRule

func (m *ColumnFamily) GetGcRule() *GcRule

func (*ColumnFamily) ProtoMessage

func (*ColumnFamily) ProtoMessage()

func (*ColumnFamily) Reset

func (m *ColumnFamily) Reset()

func (*ColumnFamily) String

func (m *ColumnFamily) String() string

type GcRule

type GcRule struct {
	// Types that are valid to be assigned to Rule:
	//	*GcRule_MaxNumVersions
	//	*GcRule_MaxAge
	//	*GcRule_Intersection_
	//	*GcRule_Union_
	Rule isGcRule_Rule `protobuf_oneof:"rule"`
}

Rule for determining which cells to delete during garbage collection.

func (*GcRule) GetIntersection

func (m *GcRule) GetIntersection() *GcRule_Intersection

func (*GcRule) GetMaxAge

func (m *GcRule) GetMaxAge() *google_protobuf.Duration

func (*GcRule) GetMaxNumVersions

func (m *GcRule) GetMaxNumVersions() int32

func (*GcRule) GetRule

func (m *GcRule) GetRule() isGcRule_Rule

func (*GcRule) GetUnion

func (m *GcRule) GetUnion() *GcRule_Union

func (*GcRule) ProtoMessage

func (*GcRule) ProtoMessage()

func (*GcRule) Reset

func (m *GcRule) Reset()

func (*GcRule) String

func (m *GcRule) String() string

func (*GcRule) XXX_OneofFuncs

func (*GcRule) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type GcRule_Intersection

type GcRule_Intersection struct {
	// Only delete cells which would be deleted by every element of `rules`.
	Rules []*GcRule `protobuf:"bytes,1,rep,name=rules" json:"rules,omitempty"`
}

A GcRule which deletes cells matching all of the given rules.

func (*GcRule_Intersection) GetRules

func (m *GcRule_Intersection) GetRules() []*GcRule

func (*GcRule_Intersection) ProtoMessage

func (*GcRule_Intersection) ProtoMessage()

func (*GcRule_Intersection) Reset

func (m *GcRule_Intersection) Reset()

func (*GcRule_Intersection) String

func (m *GcRule_Intersection) String() string

type GcRule_Intersection_

type GcRule_Intersection_ struct {
	Intersection *GcRule_Intersection `protobuf:"bytes,3,opt,name=intersection,oneof"`
}

type GcRule_MaxAge

type GcRule_MaxAge struct {
	MaxAge *google_protobuf.Duration `protobuf:"bytes,2,opt,name=max_age,oneof"`
}

type GcRule_MaxNumVersions

type GcRule_MaxNumVersions struct {
	MaxNumVersions int32 `protobuf:"varint,1,opt,name=max_num_versions,oneof"`
}

type GcRule_Union

type GcRule_Union struct {
	// Delete cells which would be deleted by any element of `rules`.
	Rules []*GcRule `protobuf:"bytes,1,rep,name=rules" json:"rules,omitempty"`
}

A GcRule which deletes cells matching any of the given rules.

func (*GcRule_Union) GetRules

func (m *GcRule_Union) GetRules() []*GcRule

func (*GcRule_Union) ProtoMessage

func (*GcRule_Union) ProtoMessage()

func (*GcRule_Union) Reset

func (m *GcRule_Union) Reset()

func (*GcRule_Union) String

func (m *GcRule_Union) String() string

type GcRule_Union_

type GcRule_Union_ struct {
	Union *GcRule_Union `protobuf:"bytes,4,opt,name=union,oneof"`
}

type Table

type Table struct {
	// A unique identifier of the form
	// <cluster_name>/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The column families configured for this table, mapped by column family id.
	ColumnFamilies map[string]*ColumnFamily `` /* 150-byte string literal not displayed */
	// The granularity (e.g. MILLIS, MICROS) at which timestamps are stored in
	// this table. Timestamps not matching the granularity will be rejected.
	// Cannot be changed once the table is created.
	Granularity Table_TimestampGranularity `` /* 132-byte string literal not displayed */
}

A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.

func (*Table) GetColumnFamilies

func (m *Table) GetColumnFamilies() map[string]*ColumnFamily

func (*Table) ProtoMessage

func (*Table) ProtoMessage()

func (*Table) Reset

func (m *Table) Reset()

func (*Table) String

func (m *Table) String() string

type Table_TimestampGranularity

type Table_TimestampGranularity int32

const (
	Table_MILLIS Table_TimestampGranularity = 0
)

func (Table_TimestampGranularity) String

func (x Table_TimestampGranularity) String() string