Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Type (v1.8.0)

Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::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 if X <= Y. This is useful anywhere sort order is important, for example when encoding keys.
  • Distinct: In this mode, Bigtable guarantees that if X != Y then Encode(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 because INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001").

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aggregate_type

def aggregate_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Aggregate
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Aggregate) — Aggregate

    Note: The following fields are mutually exclusive: aggregate_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#aggregate_type=

def aggregate_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Aggregate
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Aggregate) — Aggregate

    Note: The following fields are mutually exclusive: aggregate_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Aggregate) — Aggregate

    Note: The following fields are mutually exclusive: aggregate_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#array_type

def array_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Array
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Array) — Array

    Note: The following fields are mutually exclusive: array_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#array_type=

def array_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Array
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Array) — Array

    Note: The following fields are mutually exclusive: array_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Array) — Array

    Note: The following fields are mutually exclusive: array_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bool_type

def bool_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Bool
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Bool) — Bool

    Note: The following fields are mutually exclusive: bool_type, bytes_type, string_type, int64_type, float32_type, float64_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bool_type=

def bool_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Bool
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Bool) — Bool

    Note: The following fields are mutually exclusive: bool_type, bytes_type, string_type, int64_type, float32_type, float64_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Bool) — Bool

    Note: The following fields are mutually exclusive: bool_type, bytes_type, string_type, int64_type, float32_type, float64_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bytes_type

def bytes_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Bytes
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Bytes) — Bytes

    Note: The following fields are mutually exclusive: bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bytes_type=

def bytes_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Bytes
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Bytes) — Bytes

    Note: The following fields are mutually exclusive: bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Bytes) — Bytes

    Note: The following fields are mutually exclusive: bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#date_type

def date_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Date
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Date) — Date

    Note: The following fields are mutually exclusive: date_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#date_type=

def date_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Date
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Date) — Date

    Note: The following fields are mutually exclusive: date_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Date) — Date

    Note: The following fields are mutually exclusive: date_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#float32_type

def float32_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Float32
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Float32) — Float32

    Note: The following fields are mutually exclusive: float32_type, bytes_type, string_type, int64_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#float32_type=

def float32_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Float32
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Float32) — Float32

    Note: The following fields are mutually exclusive: float32_type, bytes_type, string_type, int64_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Float32) — Float32

    Note: The following fields are mutually exclusive: float32_type, bytes_type, string_type, int64_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#float64_type

def float64_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Float64
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Float64) — Float64

    Note: The following fields are mutually exclusive: float64_type, bytes_type, string_type, int64_type, float32_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#float64_type=

def float64_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Float64
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Float64) — Float64

    Note: The following fields are mutually exclusive: float64_type, bytes_type, string_type, int64_type, float32_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Float64) — Float64

    Note: The following fields are mutually exclusive: float64_type, bytes_type, string_type, int64_type, float32_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#int64_type

def int64_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Int64
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Int64) — Int64

    Note: The following fields are mutually exclusive: int64_type, bytes_type, string_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#int64_type=

def int64_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Int64
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Int64) — Int64

    Note: The following fields are mutually exclusive: int64_type, bytes_type, string_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Int64) — Int64

    Note: The following fields are mutually exclusive: int64_type, bytes_type, string_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#map_type

def map_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Map
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Map) — Map

    Note: The following fields are mutually exclusive: map_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#map_type=

def map_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Map
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Map) — Map

    Note: The following fields are mutually exclusive: map_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Map) — Map

    Note: The following fields are mutually exclusive: map_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#string_type

def string_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::String
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::String) — String

    Note: The following fields are mutually exclusive: string_type, bytes_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#string_type=

def string_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::String
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::String) — String

    Note: The following fields are mutually exclusive: string_type, bytes_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::String) — String

    Note: The following fields are mutually exclusive: string_type, bytes_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#struct_type

def struct_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Struct
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Struct) — Struct

    Note: The following fields are mutually exclusive: struct_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#struct_type=

def struct_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Struct
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Struct) — Struct

    Note: The following fields are mutually exclusive: struct_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Struct) — Struct

    Note: The following fields are mutually exclusive: struct_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, timestamp_type, date_type, aggregate_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#timestamp_type

def timestamp_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type::Timestamp
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Timestamp) — Timestamp

    Note: The following fields are mutually exclusive: timestamp_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#timestamp_type=

def timestamp_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type::Timestamp
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type::Timestamp) — Timestamp

    Note: The following fields are mutually exclusive: timestamp_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type::Timestamp) — Timestamp

    Note: The following fields are mutually exclusive: timestamp_type, bytes_type, string_type, int64_type, float32_type, float64_type, bool_type, date_type, aggregate_type, struct_type, array_type, map_type. If a field in that set is populated, all other fields in the set will automatically be cleared.