Reference documentation and code samples for the Cloud Firestore V1beta1 Client class Value.
A message that can hold any of the supported value types.
Generated from protobuf message google.firestore.v1beta1.Value
Namespace
Google \ Cloud \ Firestore \ V1beta1Methods
__construct
Constructor.
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
↳ array_value
ArrayValue
An array value. Cannot directly contain another array value, though can contain an map which contains another array.
↳ map_value
getNullValue
A null value.
int
setNullValue
A null value.
var
int
$this
getBooleanValue
A boolean value.
bool
setBooleanValue
A boolean value.
var
bool
$this
getIntegerValue
An integer value.
int|string
setIntegerValue
An integer value.
var
int|string
$this
getDoubleValue
A double value.
float
setDoubleValue
A double value.
var
float
$this
getTimestampValue
A timestamp value.
Precise only to microseconds. When stored, any additional precision is rounded down.
setTimestampValue
A timestamp value.
Precise only to microseconds. When stored, any additional precision is rounded down.
$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.
string
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.
var
string
$this
getBytesValue
A bytes value.
Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
string
setBytesValue
A bytes value.
Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
var
string
$this
getReferenceValue
A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}
.
string
setReferenceValue
A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}
.
var
string
$this
getGeoPointValue
A geo point value representing a point on the surface of Earth.
setGeoPointValue
A geo point value representing a point on the surface of Earth.
$this
getArrayValue
An array value.
Cannot directly contain another array value, though can contain an map which contains another array.
setArrayValue
An array value.
Cannot directly contain another array value, though can contain an map which contains another array.
$this
getMapValue
A map value.
setMapValue
A map value.
$this
getValueType
string
