Class Value (2.22.0)

Version latest

• 2.22.0 (latest)
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
null_value	google.protobuf.struct_pb2.NullValue A null value. This field is a member of oneof_ value_type.
boolean_value	bool A boolean value. This field is a member of oneof_ value_type.
integer_value	int An integer value. This field is a member of oneof_ value_type.
double_value	float A double value. This field is a member of oneof_ value_type.
timestamp_value	google.protobuf.timestamp_pb2.Timestamp A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. This field is a member of oneof_ value_type.
string_value	str 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. This field is a member of oneof_ value_type.
bytes_value	bytes A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. This field is a member of oneof_ value_type.
reference_value	str A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}. This field is a member of oneof_ value_type.
geo_point_value	google.type.latlng_pb2.LatLng A geo point value representing a point on the surface of Earth. This field is a member of oneof_ value_type.
array_value	google.cloud.firestore_v1.types.ArrayValue An array value. Cannot directly contain another array value, though can contain a map which contains another array. This field is a member of oneof_ value_type.
map_value	google.cloud.firestore_v1.types.MapValue A map value. This field is a member of oneof_ value_type.
field_reference_value	str Value which references a field. This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document. **Requires:** - Must follow field reference][FieldReference.field_path] limitations. - Not allowed to be used when writing documents. This field is a member of oneof_ value_type.
function_value	google.cloud.firestore_v1.types.Function A value that represents an unevaluated expression. **Requires:** - Not allowed to be used when writing documents. This field is a member of oneof_ value_type.
pipeline_value	google.cloud.firestore_v1.types.Pipeline A value that represents an unevaluated pipeline. **Requires:** - Not allowed to be used when writing documents. This field is a member of oneof_ value_type.