Class Value

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

Inheritance
object
Value
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1beta1.Data
Assembly: Google.Apis.Firestore.v1beta1.dll
Syntax
public class Value : IDirectResponseSchema

Properties

ArrayValue

An array value. In Standard edition databases, an array value cannot directly contain another array value, though it can contain a map which contains another array. In Enterprise edition databases, an array value can contain another array value.

Declaration
[JsonProperty("arrayValue")]
public virtual ArrayValue ArrayValue { get; set; }
Property Value
Type Description
ArrayValue

BooleanValue

A boolean value.

Declaration
[JsonProperty("booleanValue")]
public virtual bool? BooleanValue { get; set; }
Property Value
Type Description
bool?

BytesValue

A bytes value. In Standard edition databases: * The value must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits.

Declaration
[JsonProperty("bytesValue")]
public virtual string BytesValue { get; set; }
Property Value
Type Description
string

DoubleValue

A double value.

Declaration
[JsonProperty("doubleValue")]
public virtual double? DoubleValue { get; set; }
Property Value
Type Description
double?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FieldReferenceValue

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 limitations. * Not allowed to be used when writing documents.

Declaration
[JsonProperty("fieldReferenceValue")]
public virtual string FieldReferenceValue { get; set; }
Property Value
Type Description
string

FunctionValue

A value that represents an unevaluated expression. Requires: * Not allowed to be used when writing documents.

Declaration
[JsonProperty("functionValue")]
public virtual Function FunctionValue { get; set; }
Property Value
Type Description
Function

GeoPointValue

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

Declaration
[JsonProperty("geoPointValue")]
public virtual LatLng GeoPointValue { get; set; }
Property Value
Type Description
LatLng

IntegerValue

An integer value.

Declaration
[JsonProperty("integerValue")]
public virtual long? IntegerValue { get; set; }
Property Value
Type Description
long?

MapValue

A map value.

Declaration
[JsonProperty("mapValue")]
public virtual MapValue MapValue { get; set; }
Property Value
Type Description
MapValue

NullValue

A null value.

Declaration
[JsonProperty("nullValue")]
public virtual string NullValue { get; set; }
Property Value
Type Description
string

PipelineValue

A value that represents an unevaluated pipeline. Requires: * Not allowed to be used when writing documents.

Declaration
[JsonProperty("pipelineValue")]
public virtual Pipeline PipelineValue { get; set; }
Property Value
Type Description
Pipeline

ReferenceValue

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

Declaration
[JsonProperty("referenceValue")]
public virtual string ReferenceValue { get; set; }
Property Value
Type Description
string

StringValue

A string value. In Standard edition databases: * 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. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits.

Declaration
[JsonProperty("stringValue")]
public virtual string StringValue { get; set; }
Property Value
Type Description
string

TimestampValue

object representation of TimestampValueRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use TimestampValueDateTimeOffset instead.")]
public virtual object TimestampValue { get; set; }
Property Value
Type Description
object

TimestampValueDateTimeOffset

DateTimeOffset representation of TimestampValueRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? TimestampValueDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

TimestampValueRaw

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

Declaration
[JsonProperty("timestampValue")]
public virtual string TimestampValueRaw { get; set; }
Property Value
Type Description
string

VariableReferenceValue

Pointer to a variable defined elsewhere in a pipeline. Unlike field_reference_value which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document.

Declaration
[JsonProperty("variableReferenceValue")]
public virtual string VariableReferenceValue { get; set; }
Property Value
Type Description
string

Implements