Cloud Bigtable V2 Client - Class Value (2.8.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class 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.

Generated from protobuf message google.bigtable.v2.Value

Namespace

Google \ Cloud \ Bigtable \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ type
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, Array elements, or Map key/value pairs. If a nested Value provides a type` on write, the request will be rejected with INVALID_ARGUMENT.

↳ raw_value
string

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

↳ raw_timestamp_micros
int|string

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

↳ bytes_value
string

Represents a typed value transported as a byte sequence.

↳ string_value
string

Represents a typed value transported as a string.

↳ int_value
int|string

Represents a typed value transported as an integer.

↳ bool_value
bool

Represents a typed value transported as a boolean.

↳ float_value
float

Represents a typed value transported as a floating point number.

↳ timestamp_value
Google\Protobuf\Timestamp

Represents a typed value transported as a timestamp.

↳ date_value
Google\Type\Date

Represents a typed value transported as a date.

↳ array_value
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 .

getType

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, Array elements, or Map key/value pairs. If a nested Value provides a type` on write, the request will be rejected with INVALID_ARGUMENT.

Returns
Type
Description
Type |null

hasType

clearType

setType

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, Array elements, or Map key/value pairs. If a nested Value provides a type` on write, the request will be rejected with INVALID_ARGUMENT.

Parameter
Name
Description
var
Returns
Type
Description
$this

getRawValue

Represents a raw byte sequence with no type information.

The type field must be omitted.

Returns
Type
Description
string

hasRawValue

setRawValue

Represents a raw byte sequence with no type information.

The type field must be omitted.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getRawTimestampMicros

Represents a raw cell timestamp with no type information.

The type field must be omitted.

Returns
Type
Description
int|string

hasRawTimestampMicros

setRawTimestampMicros

Represents a raw cell timestamp with no type information.

The type field must be omitted.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getBytesValue

Represents a typed value transported as a byte sequence.

Returns
Type
Description
string

hasBytesValue

setBytesValue

Represents a typed value transported as a byte sequence.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getStringValue

Represents a typed value transported as a string.

Returns
Type
Description
string

hasStringValue

setStringValue

Represents a typed value transported as a string.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getIntValue

Represents a typed value transported as an integer.

Returns
Type
Description
int|string

hasIntValue

setIntValue

Represents a typed value transported as an integer.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getBoolValue

Represents a typed value transported as a boolean.

Returns
Type
Description
bool

hasBoolValue

setBoolValue

Represents a typed value transported as a boolean.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getFloatValue

Represents a typed value transported as a floating point number.

Returns
Type
Description
float

hasFloatValue

setFloatValue

Represents a typed value transported as a floating point number.

Parameter
Name
Description
var
float
Returns
Type
Description
$this

getTimestampValue

Represents a typed value transported as a timestamp.

Returns
Type
Description

hasTimestampValue

setTimestampValue

Represents a typed value transported as a timestamp.

Parameter
Name
Description
Returns
Type
Description
$this

getDateValue

Represents a typed value transported as a date.

Returns
Type
Description

hasDateValue

setDateValue

Represents a typed value transported as a date.

Parameter
Name
Description
Returns
Type
Description
$this

getArrayValue

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
Type
Description
ArrayValue |null

hasArrayValue

setArrayValue

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 .

Parameter
Name
Description
Returns
Type
Description
$this

getKind

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: