Cloud Firestore V1beta1 Client - Class Value (1.44.1)

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 \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
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\V1beta1\ArrayValue

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

↳ map_value Google\Cloud\Firestore\V1beta1\MapValue

A map value.

getNullValue

A null value.

Returns
Type Description
int

setNullValue

A null value.

Parameter
Name Description
var int
Returns
Type Description
$this

getBooleanValue

A boolean value.

Returns
Type Description
bool

setBooleanValue

A boolean value.

Parameter
Name Description
var bool
Returns
Type Description
$this

getIntegerValue

An integer value.

Returns
Type Description
int|string

setIntegerValue

An integer value.

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

getDoubleValue

A double value.

Returns
Type Description
float

setDoubleValue

A double value.

Parameter
Name Description
var float
Returns
Type Description
$this

getTimestampValue

A timestamp value.

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

Returns
Type Description
Google\Protobuf\Timestamp

setTimestampValue

A timestamp value.

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getBytesValue

A bytes value.

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

Returns
Type Description
string

setBytesValue

A bytes value.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getReferenceValue

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

Returns
Type Description
string

setReferenceValue

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

Parameter
Name Description
var string
Returns
Type Description
$this

getGeoPointValue

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

Returns
Type Description
Google\Type\LatLng

setGeoPointValue

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

Parameter
Name Description
var Google\Type\LatLng
Returns
Type Description
$this

getArrayValue

An array value.

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

Returns
Type Description
Google\Cloud\Firestore\V1beta1\ArrayValue

setArrayValue

An array value.

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

Parameter
Name Description
var Google\Cloud\Firestore\V1beta1\ArrayValue
Returns
Type Description
$this

getMapValue

A map value.

Returns
Type Description
Google\Cloud\Firestore\V1beta1\MapValue

setMapValue

A map value.

Parameter
Name Description
var Google\Cloud\Firestore\V1beta1\MapValue
Returns
Type Description
$this

getValueType

Returns
Type Description
string