Cloud Firestore V1 Client - Class Value (1.33.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class Value.

A message that can hold any of the supported value types.

Generated from protobuf message google.firestore.v1.Value

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ null_value int

A null value.

↳ boolean_value bool

A boolean value.

↳ integer_value int|string

An integer value.

↳ double_value float

A double value.

↳ timestamp_value Google\Protobuf\Timestamp

A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.

↳ string_value string

A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

↳ bytes_value string

A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

↳ reference_value string

A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

↳ geo_point_value Google\Type\LatLng

A geo point value representing a point on the surface of Earth.

↳ array_value Google\Cloud\Firestore\V1\ArrayValue

An array value. Cannot directly contain another array value, though can contain an map which contains another array.

↳ map_value Google\Cloud\Firestore\V1\MapValue

A map value.

getNullValue

A null value.

Returns
TypeDescription
int

hasNullValue

setNullValue

A null value.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getBooleanValue

A boolean value.

Returns
TypeDescription
bool

hasBooleanValue

setBooleanValue

A boolean value.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getIntegerValue

An integer value.

Returns
TypeDescription
int|string

hasIntegerValue

setIntegerValue

An integer value.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getDoubleValue

A double value.

Returns
TypeDescription
float

hasDoubleValue

setDoubleValue

A double value.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getTimestampValue

A timestamp value.

Precise only to microseconds. When stored, any additional precision is rounded down.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasTimestampValue

setTimestampValue

A timestamp value.

Precise only to microseconds. When stored, any additional precision is rounded down.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getStringValue

A string value.

The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

Returns
TypeDescription
string

hasStringValue

setStringValue

A string value.

The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBytesValue

A bytes value.

Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

Returns
TypeDescription
string

hasBytesValue

setBytesValue

A bytes value.

Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReferenceValue

A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Returns
TypeDescription
string

hasReferenceValue

setReferenceValue

A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGeoPointValue

A geo point value representing a point on the surface of Earth.

Returns
TypeDescription
Google\Type\LatLng|null

hasGeoPointValue

setGeoPointValue

A geo point value representing a point on the surface of Earth.

Parameter
NameDescription
var Google\Type\LatLng
Returns
TypeDescription
$this

getArrayValue

An array value.

Cannot directly contain another array value, though can contain an map which contains another array.

Returns
TypeDescription
Google\Cloud\Firestore\V1\ArrayValue|null

hasArrayValue

setArrayValue

An array value.

Cannot directly contain another array value, though can contain an map which contains another array.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\ArrayValue
Returns
TypeDescription
$this

getMapValue

A map value.

Returns
TypeDescription
Google\Cloud\Firestore\V1\MapValue|null

hasMapValue

setMapValue

A map value.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\MapValue
Returns
TypeDescription
$this

getValueType

Returns
TypeDescription
string