Class: Google::Cloud::Bigtable::V2::Type

Inherits:

Object

Object
Google::Cloud::Bigtable::V2::Type

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/bigtable/v2/types.rb

Overview

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").

Defined Under Namespace

Classes: Aggregate, Array, Bool, Bytes, Date, Enum, Float32, Float64, Int64, Map, Proto, String, Struct, Timestamp

Instance Attribute Summary collapse

Instance Attribute Details

#aggregate_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Aggregate`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#array_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Array`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#bool_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Bool`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#bytes_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Bytes`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#date_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Date`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#enum_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Enum`

Returns Enum

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

Returns:

(::Google::Cloud::Bigtable::V2::Type::Enum) —
Enum

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

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#float32_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Float32`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#float64_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Float64`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#int64_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Int64`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#map_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Map`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#proto_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Proto`

Returns Proto

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

Returns:

(::Google::Cloud::Bigtable::V2::Type::Proto) —
Proto

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

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#string_type ⇒ `::Google::Cloud::Bigtable::V2::Type::String`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#struct_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Struct`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#timestamp_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Timestamp`

Returns 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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::Bigtable::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, proto_type, enum_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/bigtable/v2/types.rb', line 116

class Type
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Bytes
  # Values of type `Bytes` are stored in `Value.bytes_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Bytes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] raw
    #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes::Encoding::Raw]
    #     Use `Raw` encoding.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Leaves the value as-is.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      # @!attribute [rw] escape_nulls
      #   @return [::Boolean]
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value which only contains the
      #     null byte `0x00`, has one more null byte appended.
      class Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # String
  # Values of type `String` are stored in `Value.string_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class String
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] utf8_raw
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Raw]
    #     Deprecated: if set, converts to an empty `utf8_bytes`.
    #
    #     Note: The following fields are mutually exclusive: `utf8_raw`, `utf8_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] utf8_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::String::Encoding::Utf8Bytes]
    #     Use `Utf8Bytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `utf8_bytes`, `utf8_raw`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Deprecated: prefer the equivalent `Utf8Bytes`.
      # @deprecated This message is deprecated and may be removed in the next major version update.
      class Utf8Raw
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # UTF-8 encoding.
      #
      # Sorted mode:
      #  - All values are supported.
      #  - Code point order is preserved.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `TEXT` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `String#getBytes(StandardCharsets.UTF_8)`
      # @!attribute [rw] null_escape_char
      #   @return [::String]
      #     Single-character escape sequence used to support NULL values.
      #
      #     If set, allows NULL values to be encoded as the empty string "".
      #
      #     The actual empty string, or any value where every character equals
      #     `null_escape_char`, has one more `null_escape_char` appended.
      #
      #     If `null_escape_char` is set and does not equal the ASCII null
      #     character `0x00`, then the encoding will not support sorted mode.
      #
      #     .
      class Utf8Bytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Int64
  # Values of type `Int64` are stored in `Value.int_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Int64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] big_endian_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::BigEndianBytes]
    #     Use `BigEndianBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `big_endian_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding::OrderedCodeBytes]
    #     Use `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `big_endian_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encodes the value as an 8-byte big-endian two's complement value.
      #
      # Sorted mode: non-negative values are supported.
      #
      # Distinct mode: all values are supported.
      #
      # Compatible with:
      #
      #  - BigQuery `BINARY` encoding
      #  - HBase `Bytes.toBytes`
      #  - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
      # @!attribute [rw] bytes_type
      #   @deprecated This field is deprecated and may be removed in the next major version update.
      #   @return [::Google::Cloud::Bigtable::V2::Type::Bytes]
      #     Deprecated: ignored if set.
      class BigEndianBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Encodes the value in a variable length binary format of up to 10 bytes.
      # Values that are closer to zero use fewer bytes.
      #
      # Sorted mode: all values are supported.
      #
      # Distinct mode: all values are supported.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # bool
  # Values of type `Bool` are stored in `Value.bool_value`.
  class Bool
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float32
  # Values of type `Float32` are stored in `Value.float_value`.
  class Float32
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Float64
  # Values of type `Float64` are stored in `Value.float_value`.
  class Float64
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Timestamp
  # Values of type `Timestamp` are stored in `Value.timestamp_value`.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Timestamp::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Timestamp
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] unix_micros_int64
    #   @return [::Google::Cloud::Bigtable::V2::Type::Int64::Encoding]
    #     Encodes the number of microseconds since the Unix epoch using the
    #     given `Int64` encoding. Values must be microsecond-aligned.
    #
    #     Compatible with:
    #
    #      - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Date
  # Values of type `Date` are stored in `Value.date_value`.
  class Date
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A structured data value, consisting of fields which map to dynamically
  # typed values.
  # Values of type `Struct` are stored in `Value.array_value` where entries are
  # in the same order and number as `field_types`.
  # @!attribute [rw] fields
  #   @return [::Array<::Google::Cloud::Bigtable::V2::Type::Struct::Field>]
  #     The names and types of the fields in this struct.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding]
  #     The encoding to use when converting to or from lower level types.
  class Struct
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A struct field and its type.
    # @!attribute [rw] field_name
    #   @return [::String]
    #     The field name (optional). Fields without a `field_name` are considered
    #     anonymous and cannot be referenced by name.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Bigtable::V2::Type]
    #     The type of values in this field.
    class Field
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Rules used to convert to or from lower level types.
    # @!attribute [rw] singleton
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::Singleton]
    #     Use `Singleton` encoding.
    #
    #     Note: The following fields are mutually exclusive: `singleton`, `delimited_bytes`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] delimited_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::DelimitedBytes]
    #     Use `DelimitedBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `delimited_bytes`, `singleton`, `ordered_code_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] ordered_code_bytes
    #   @return [::Google::Cloud::Bigtable::V2::Type::Struct::Encoding::OrderedCodeBytes]
    #     User `OrderedCodeBytes` encoding.
    #
    #     Note: The following fields are mutually exclusive: `ordered_code_bytes`, `singleton`, `delimited_bytes`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class Encoding
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Uses the encoding of `fields[0].type` as-is.
      # Only valid if `fields.size == 1`.
      class Singleton
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with a configurable
      # `delimiter` in between.
      #
      # A struct with no fields defined is encoded as a single `delimiter`.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - Encoded field values must not contain any bytes <= `delimiter[0]`
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - Encoded field values must not contain `delimiter[0]`.
      # @!attribute [rw] delimiter
      #   @return [::String]
      #     Byte sequence used to delimit concatenated fields. The delimiter must
      #     contain at least 1 character and at most 50 characters.
      class DelimitedBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Fields are encoded independently and concatenated with the fixed byte
      # pair `{0x00, 0x01}` in between.
      #
      # Any null `(0x00)` byte in an encoded field is replaced by the fixed
      # byte pair `{0x00, 0xFF}`.
      #
      # Fields that encode to the empty string "" have special handling:
      #
      #  - If *every* field encodes to "", or if the STRUCT has no fields
      #    defined, then the STRUCT is encoded as the fixed byte pair
      #    `{0x00, 0x00}`.
      #  - Otherwise, the STRUCT only encodes until the last non-empty field,
      #    omitting any trailing empty fields. Any empty fields that aren't
      #    omitted are replaced with the fixed byte pair `{0x00, 0x00}`.
      #
      # Examples:
      #
      # ```
      #  - STRUCT()             -> "\00\00"
      #  - STRUCT("")           -> "\00\00"
      #  - STRUCT("", "")       -> "\00\00"
      #  - STRUCT("", "B")      -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "")      -> "A"
      #  - STRUCT("", "B", "")  -> "\00\00" + "\00\01" + "B"
      #  - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"
      # ```
      #
      #
      # Since null bytes are always escaped, this encoding can cause size
      # blowup for encodings like `Int64.BigEndianBytes` that are likely to
      # produce many such bytes.
      #
      # Sorted mode:
      #
      #  - Fields are encoded in sorted mode.
      #  - All values supported by the field encodings are allowed
      #  - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if
      #    `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first.
      #
      # Distinct mode:
      #
      #  - Fields are encoded in distinct mode.
      #  - All values supported by the field encodings are allowed.
      class OrderedCodeBytes
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # A protobuf message type.
  # Values of type `Proto` are stored in `Value.bytes_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this proto is defined in.
  # @!attribute [rw] message_name
  #   @return [::String]
  #     The fully qualified name of the protobuf message, including package. In
  #     the format of "foo.bar.Message".
  class Proto
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A protobuf enum type.
  # Values of type `Enum` are stored in `Value.int_value`.
  # @!attribute [rw] schema_bundle_id
  #   @return [::String]
  #     The ID of the schema bundle that this enum is defined in.
  # @!attribute [rw] enum_name
  #   @return [::String]
  #     The fully qualified name of the protobuf enum message, including package.
  #     In the format of "foo.bar.EnumMessage".
  class Enum
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An ordered list of elements of a given type.
  # Values of type `Array` are stored in `Value.array_value`.
  # @!attribute [rw] element_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the elements in the array. This must not be `Array`.
  class Array
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A mapping of keys to values of a given type.
  # Values of type `Map` are stored in a `Value.array_value` where each entry
  # is another `Value.array_value` with two elements (the key and the value,
  # in that order).
  # Normally encoded Map values won't have repeated keys, however, clients are
  # expected to handle the case in which they do. If the same key appears
  # multiple times, the _last_ value takes precedence.
  # @!attribute [rw] key_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of a map key.
  #     Only `Bytes`, `String`, and `Int64` are allowed as key types.
  # @!attribute [rw] value_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     The type of the values in a map.
  class Map
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A value that combines incremental updates into a summarized value.
  #
  # Data is never directly written or read using type `Aggregate`. Writes
  # provide either the `input_type` or `state_type`, and reads always return
  # the `state_type` .
  # @!attribute [rw] input_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Type of the inputs that are accumulated by this `Aggregate`.
  #     Use `AddInput` mutations to accumulate new inputs.
  # @!attribute [r] state_type
  #   @return [::Google::Cloud::Bigtable::V2::Type]
  #     Output only. Type that holds the internal accumulator state for the
  #     `Aggregate`. This is a function of the `input_type` and `aggregator`
  #     chosen.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Sum]
  #     Sum aggregator.
  #
  #     Note: The following fields are mutually exclusive: `sum`, `hllpp_unique_count`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] hllpp_unique_count
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::HyperLogLogPlusPlusUniqueCount]
  #     HyperLogLogPlusPlusUniqueCount aggregator.
  #
  #     Note: The following fields are mutually exclusive: `hllpp_unique_count`, `sum`, `max`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] max
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Max]
  #     Max aggregator.
  #
  #     Note: The following fields are mutually exclusive: `max`, `sum`, `hllpp_unique_count`, `min`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] min
  #   @return [::Google::Cloud::Bigtable::V2::Type::Aggregate::Min]
  #     Min aggregator.
  #
  #     Note: The following fields are mutually exclusive: `min`, `sum`, `hllpp_unique_count`, `max`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class Aggregate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Computes the sum of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the max of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Max
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes the min of the input values.
    # Allowed input: `Int64`
    # State: same as input
    class Min
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Computes an approximate unique count over the input values. When using
    # raw data as input, be careful to use a consistent encoding. Otherwise
    # the same value encoded differently could count more than once, or two
    # distinct values could count as identical.
    # Input: Any, or omit for Raw
    # State: TBD
    # Special state conversions: `Int64` (the unique count estimate)
    class HyperLogLogPlusPlusUniqueCount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

Class: Google::Cloud::Bigtable::V2::Type

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#aggregate_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Aggregate

#array_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Array

#bool_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Bool

#bytes_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Bytes

#date_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Date

#enum_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Enum

#float32_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Float32

#float64_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Float64

#int64_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Int64

#map_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Map

#proto_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Proto

#string_type ⇒ ::Google::Cloud::Bigtable::V2::Type::String

#struct_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Struct

#timestamp_type ⇒ ::Google::Cloud::Bigtable::V2::Type::Timestamp

#aggregate_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Aggregate`

#array_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Array`

#bool_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Bool`

#bytes_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Bytes`

#date_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Date`

#enum_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Enum`

#float32_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Float32`

#float64_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Float64`

#int64_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Int64`

#map_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Map`

#proto_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Proto`

#string_type ⇒ `::Google::Cloud::Bigtable::V2::Type::String`

#struct_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Struct`

#timestamp_type ⇒ `::Google::Cloud::Bigtable::V2::Type::Timestamp`