Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::Value (v1.3.0)

Reference documentation and code samples for the Cloud Bigtable V2 API class Google::Cloud::Bigtable::V2::Value.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#array_value

def array_value() -> ::Google::Cloud::Bigtable::V2::ArrayValue

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.

#array_value=

def array_value=(value) -> ::Google::Cloud::Bigtable::V2::ArrayValue

Parameter

value (::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.

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.

#bool_value

def bool_value() -> ::Boolean

Returns

(::Boolean) — Represents a typed value transported as a boolean.

#bool_value=

def bool_value=(value) -> ::Boolean

Parameter

value (::Boolean) — Represents a typed value transported as a boolean.

Returns

(::Boolean) — Represents a typed value transported as a boolean.

#bytes_value

def bytes_value() -> ::String

Returns

(::String) — Represents a typed value transported as a byte sequence.

#bytes_value=

def bytes_value=(value) -> ::String

Parameter

value (::String) — Represents a typed value transported as a byte sequence.

Returns

(::String) — Represents a typed value transported as a byte sequence.

#date_value

def date_value() -> ::Google::Type::Date

Returns

(::Google::Type::Date) — Represents a typed value transported as a date.

#date_value=

def date_value=(value) -> ::Google::Type::Date

Parameter

value (::Google::Type::Date) — Represents a typed value transported as a date.

Returns

(::Google::Type::Date) — Represents a typed value transported as a date.

#float_value

def float_value() -> ::Float

Returns

(::Float) — Represents a typed value transported as a floating point number.

#float_value=

def float_value=(value) -> ::Float

Parameter

value (::Float) — Represents a typed value transported as a floating point number.

Returns

(::Float) — Represents a typed value transported as a floating point number.

#int_value

def int_value() -> ::Integer

Returns

(::Integer) — Represents a typed value transported as an integer.

#int_value=

def int_value=(value) -> ::Integer

Parameter

value (::Integer) — Represents a typed value transported as an integer.

Returns

(::Integer) — Represents a typed value transported as an integer.

#raw_timestamp_micros

def raw_timestamp_micros() -> ::Integer

Returns

(::Integer) — Represents a raw cell timestamp with no type information. The type field must be omitted.

#raw_timestamp_micros=

def raw_timestamp_micros=(value) -> ::Integer

Parameter

value (::Integer) — Represents a raw cell timestamp with no type information. The type field must be omitted.

Returns

(::Integer) — Represents a raw cell timestamp with no type information. The type field must be omitted.

#raw_value

def raw_value() -> ::String

Returns

(::String) — Represents a raw byte sequence with no type information. The type field must be omitted.

#raw_value=

def raw_value=(value) -> ::String

Parameter

value (::String) — Represents a raw byte sequence with no type information. The type field must be omitted.

Returns

(::String) — Represents a raw byte sequence with no type information. The type field must be omitted.

#string_value

def string_value() -> ::String

Returns

(::String) — Represents a typed value transported as a string.

#string_value=

def string_value=(value) -> ::String

Parameter

value (::String) — Represents a typed value transported as a string.

Returns

(::String) — Represents a typed value transported as a string.

#timestamp_value

def timestamp_value() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Represents a typed value transported as a timestamp.

#timestamp_value=

def timestamp_value=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Represents a typed value transported as a timestamp.

Returns

(::Google::Protobuf::Timestamp) — Represents a typed value transported as a timestamp.

#type

def type() -> ::Google::Cloud::Bigtable::V2::Type

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.

#type=

def type=(value) -> ::Google::Cloud::Bigtable::V2::Type

Parameter

value (::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.

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.