Cloud Datastore V1 Client - Class Value (1.23.0)

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

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

Generated from protobuf message google.datastore.v1.Value

Namespace

Google \ Cloud \ Datastore \ V1

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. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

↳ key_value Google\Cloud\Datastore\V1\Key

A key value.

↳ string_value string

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

↳ blob_value string

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

↳ geo_point_value Google\Type\LatLng

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

↳ entity_value Google\Cloud\Datastore\V1\Entity

An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.

↳ array_value Google\Cloud\Datastore\V1\ArrayValue

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.

↳ meaning int

The meaning field should only be populated for backwards compatibility.

↳ exclude_from_indexes bool

If the value should be excluded from all indexes including those defined explicitly.

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.

When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasTimestampValue

setTimestampValue

A timestamp value.

When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

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

getKeyValue

A key value.

Returns
TypeDescription
Google\Cloud\Datastore\V1\Key|null

hasKeyValue

setKeyValue

A key value.

Parameter
NameDescription
var Google\Cloud\Datastore\V1\Key
Returns
TypeDescription
$this

getStringValue

A UTF-8 encoded string value.

When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

Returns
TypeDescription
string

hasStringValue

setStringValue

A UTF-8 encoded string value.

When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBlobValue

A blob value.

May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

Returns
TypeDescription
string

hasBlobValue

setBlobValue

A blob value.

May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

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

getEntityValue

An entity value.

  • May have no key.
  • May have a key with an incomplete key path.
  • May have a reserved/read-only key.
Returns
TypeDescription
Google\Cloud\Datastore\V1\Entity|null

hasEntityValue

setEntityValue

An entity value.

  • May have no key.
  • May have a key with an incomplete key path.
  • May have a reserved/read-only key.
Parameter
NameDescription
var Google\Cloud\Datastore\V1\Entity
Returns
TypeDescription
$this

getArrayValue

An array value.

Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.

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

hasArrayValue

setArrayValue

An array value.

Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.

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

getMeaning

The meaning field should only be populated for backwards compatibility.

Returns
TypeDescription
int

setMeaning

The meaning field should only be populated for backwards compatibility.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getExcludeFromIndexes

If the value should be excluded from all indexes including those defined explicitly.

Returns
TypeDescription
bool

setExcludeFromIndexes

If the value should be excluded from all indexes including those defined explicitly.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getValueType

Returns
TypeDescription
string