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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/v2/types.rb

Overview

String Values of type String are stored in Value.string_value.

Defined Under Namespace

Classes: Encoding

Instance Attribute Summary collapse

Instance Attribute Details

#encoding ⇒ ::Google::Cloud::Bigtable::V2::Type::String::Encoding 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/bigtable/v2/types.rb', line 160

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