Reference documentation and code samples for the Cloud Bigtable V2 Client class Type.
Type represents the type of data that is written to, read from, or stored
in Bigtable. It is heavily based on the GoogleSQL standard to help maintain
familiarity and consistency across products and features.
For compatibility with Bigtable's existing untyped APIs, each Type includes
an Encoding which describes how to convert to or from the underlying data.
Each encoding can operate in one of two modes:
- Sorted: In this mode, Bigtable guarantees that
Encode(X) <= Encode(Y)if and only ifX <= Y. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if
X != YthenEncode(X) != Encode(Y). However, the converse is not guaranteed. For example, both{'foo': '1', 'bar': '2'}and{'bar': '2', 'foo': '1'}are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is becauseINT64(1) > INT64(-1), butSTRING("-00001") > STRING("00001").
Generated from protobuf message google.bigtable.v2.Type
Namespace
Google \ Cloud \ Bigtable \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ bytes_type |
Type\Bytes
Bytes |
↳ string_type |
Type\PBString
String |
↳ int64_type |
Type\Int64
Int64 |
↳ float32_type |
Type\Float32
Float32 |
↳ float64_type |
Type\Float64
Float64 |
↳ bool_type |
Type\PBBool
Bool |
↳ timestamp_type |
Type\Timestamp
Timestamp |
↳ date_type |
Type\Date
Date |
↳ aggregate_type |
Type\Aggregate
Aggregate |
↳ struct_type |
Type\Struct
Struct |
↳ array_type |
Type\PBArray
Array |
↳ map_type |
Type\Map
Map |
↳ proto_type |
Type\Proto
Proto |
↳ enum_type |
Type\Enum
Enum |
getBytesType
Bytes
| Returns | |
|---|---|
| Type | Description |
Type\Bytes|null |
|
hasBytesType
setBytesType
Bytes
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Bytes
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStringType
String
| Returns | |
|---|---|
| Type | Description |
Type\PBString|null |
|
hasStringType
setStringType
String
| Parameter | |
|---|---|
| Name | Description |
var |
Type\PBString
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInt64Type
Int64
| Returns | |
|---|---|
| Type | Description |
Type\Int64|null |
|
hasInt64Type
setInt64Type
Int64
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Int64
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFloat32Type
Float32
| Returns | |
|---|---|
| Type | Description |
Type\Float32|null |
|
hasFloat32Type
setFloat32Type
Float32
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Float32
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFloat64Type
Float64
| Returns | |
|---|---|
| Type | Description |
Type\Float64|null |
|
hasFloat64Type
setFloat64Type
Float64
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Float64
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBoolType
Bool
| Returns | |
|---|---|
| Type | Description |
Type\PBBool|null |
|
hasBoolType
setBoolType
Bool
| Parameter | |
|---|---|
| Name | Description |
var |
Type\PBBool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimestampType
Timestamp
| Returns | |
|---|---|
| Type | Description |
Type\Timestamp|null |
|
hasTimestampType
setTimestampType
Timestamp
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDateType
Date
| Returns | |
|---|---|
| Type | Description |
Type\Date|null |
|
hasDateType
setDateType
Date
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAggregateType
Aggregate
| Returns | |
|---|---|
| Type | Description |
Type\Aggregate|null |
|
hasAggregateType
setAggregateType
Aggregate
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Aggregate
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStructType
Struct
| Returns | |
|---|---|
| Type | Description |
Type\Struct|null |
|
hasStructType
setStructType
Struct
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getArrayType
Array
| Returns | |
|---|---|
| Type | Description |
Type\PBArray|null |
|
hasArrayType
setArrayType
Array
| Parameter | |
|---|---|
| Name | Description |
var |
Type\PBArray
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMapType
Map
| Returns | |
|---|---|
| Type | Description |
Type\Map|null |
|
hasMapType
setMapType
Map
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Map
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProtoType
Proto
| Returns | |
|---|---|
| Type | Description |
Type\Proto|null |
|
hasProtoType
setProtoType
Proto
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Proto
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnumType
Enum
| Returns | |
|---|---|
| Type | Description |
Type\Enum|null |
|
hasEnumType
setEnumType
Enum
| Parameter | |
|---|---|
| Name | Description |
var |
Type\Enum
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
| Returns | |
|---|---|
| Type | Description |
string |
|