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

Version 1.6.0

• 1.7.0 (latest)
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.3
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.3
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.1

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/from the underlying data.

Each encoding also defines the following properties:

• Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, not the decoded type.
  • Example: BYTES values sort in the same order as their raw encodings.
  • Counterexample: Encoding INT64 as a fixed-width decimal string does not preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001).
• Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins?
  • Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign.
  • Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends.
• Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?

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.