Class: Google::Cloud::Bigtable::V2::Value

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

Overview

Value represents a dynamically typed value. The typed fields in Value are used as a transport encoding for the actual value (which may be of a more complex type). See the documentation of the Type message for more details.

Instance Attribute Summary collapse

Instance Attribute Details

#array_value ⇒ ::Google::Cloud::Bigtable::V2::ArrayValue

Returns Represents a typed value transported as a sequence of values. To differentiate between Struct, Array, and Map, the outermost Value must provide an explicit type on write. This type will apply recursively to the nested Struct fields, Array elements, or Map key/value pairs, which must not supply their own type.

Note: The following fields are mutually exclusive: array_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, float_value, timestamp_value, date_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Bigtable::V2::ArrayValue) —

    Represents a typed value transported as a sequence of values. To differentiate between Struct, Array, and Map, the outermost Value must provide an explicit type on write. This type will apply recursively to the nested Struct fields, Array elements, or Map key/value pairs, which must not supply their own type.

    Note: The following fields are mutually exclusive: array_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, float_value, timestamp_value, date_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#bool_value ⇒ ::Boolean

Returns Represents a typed value transported as a boolean.

Note: The following fields are mutually exclusive: bool_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Boolean) —

    Represents a typed value transported as a boolean.

    Note: The following fields are mutually exclusive: bool_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#bytes_value ⇒ ::String

Returns Represents a typed value transported as a byte sequence.

Note: The following fields are mutually exclusive: bytes_value, raw_value, raw_timestamp_micros, string_value, int_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Represents a typed value transported as a byte sequence.

    Note: The following fields are mutually exclusive: bytes_value, raw_value, raw_timestamp_micros, string_value, int_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#date_value ⇒ ::Google::Type::Date

Returns Represents a typed value transported as a date.

Note: The following fields are mutually exclusive: date_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, float_value, timestamp_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Type::Date) —

    Represents a typed value transported as a date.

    Note: The following fields are mutually exclusive: date_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, float_value, timestamp_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#float_value ⇒ ::Float

Returns Represents a typed value transported as a floating point number. Does not support NaN or infinities.

Note: The following fields are mutually exclusive: float_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Float) —

    Represents a typed value transported as a floating point number. Does not support NaN or infinities.

    Note: The following fields are mutually exclusive: float_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#int_value ⇒ ::Integer

Returns Represents a typed value transported as an integer.

Note: The following fields are mutually exclusive: int_value, raw_value, raw_timestamp_micros, bytes_value, string_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Integer) —

    Represents a typed value transported as an integer.

    Note: The following fields are mutually exclusive: int_value, raw_value, raw_timestamp_micros, bytes_value, string_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#raw_timestamp_micros ⇒ ::Integer

Returns Represents a raw cell timestamp with no type information. The type field must be omitted.

Note: The following fields are mutually exclusive: raw_timestamp_micros, raw_value, bytes_value, string_value, int_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Integer) —

    Represents a raw cell timestamp with no type information. The type field must be omitted.

    Note: The following fields are mutually exclusive: raw_timestamp_micros, raw_value, bytes_value, string_value, int_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#raw_value ⇒ ::String

Returns Represents a raw byte sequence with no type information. The type field must be omitted.

Note: The following fields are mutually exclusive: raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Represents a raw byte sequence with no type information. The type field must be omitted.

    Note: The following fields are mutually exclusive: raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#string_value ⇒ ::String

Returns Represents a typed value transported as a string.

Note: The following fields are mutually exclusive: string_value, raw_value, raw_timestamp_micros, bytes_value, int_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Represents a typed value transported as a string.

    Note: The following fields are mutually exclusive: string_value, raw_value, raw_timestamp_micros, bytes_value, int_value, bool_value, float_value, timestamp_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#timestamp_value ⇒ ::Google::Protobuf::Timestamp

Returns Represents a typed value transported as a timestamp.

Note: The following fields are mutually exclusive: timestamp_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, float_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Represents a typed value transported as a timestamp.

    Note: The following fields are mutually exclusive: timestamp_value, raw_value, raw_timestamp_micros, bytes_value, string_value, int_value, bool_value, float_value, date_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::Google::Cloud::Bigtable::V2::Type

Returns The verified Type of this Value, if it cannot be inferred.

Read results will never specify the encoding for type since the value will already have been decoded by the server. Furthermore, the type will be omitted entirely if it can be inferred from a previous response. The exact semantics for inferring type will vary, and are therefore documented separately for each read method.

When using composite types (Struct, Array, Map) only the outermost Value will specify the type. This top-level type will define the types for any nested Struct' fields,Arrayelements, orMapkey/value pairs. If a nestedValueprovides atype` on write, the request will be rejected with INVALID_ARGUMENT.

Returns:

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

    The verified Type of this Value, if it cannot be inferred.

    Read results will never specify the encoding for type since the value will already have been decoded by the server. Furthermore, the type will be omitted entirely if it can be inferred from a previous response. The exact semantics for inferring type will vary, and are therefore documented separately for each read method.

    When using composite types (Struct, Array, Map) only the outermost Value will specify the type. This top-level type will define the types for any nested Struct' fields,Arrayelements, orMapkey/value pairs. If a nestedValueprovides atype` on write, the request will be rejected with INVALID_ARGUMENT.



173
174
175
176
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 173

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end