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

Version latest

• 1.10.0 (latest)
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.2
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5

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.

  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.

#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.

  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.

#bool_value

def bool_value() -> ::Boolean

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.

#bool_value=

def bool_value=(value) -> ::Boolean

Parameter

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

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.

#bytes_value

def bytes_value() -> ::String

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.

#bytes_value=

def bytes_value=(value) -> ::String

Parameter

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

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.

#date_value

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

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.

#date_value=

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

Parameter

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

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.

#float_value

def float_value() -> ::Float

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.

#float_value=

def float_value=(value) -> ::Float

Parameter

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

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.

#int_value

def int_value() -> ::Integer

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.

#int_value=

def int_value=(value) -> ::Integer

Parameter

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

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.

#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.

  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.

#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.

  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.

#raw_value

def raw_value() -> ::String

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.

#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.

  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.

#string_value

def string_value() -> ::String

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.

#string_value=

def string_value=(value) -> ::String

Parameter

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

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.

#timestamp_value

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

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.

#timestamp_value=

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

Parameter

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

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.

#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.