Firestore v1 API - Class Value (3.4.0)

public sealed class Value : IMessage<Value>, IEquatable<Value>, IDeepCloneable<Value>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class Value.

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

Inheritance

object > Value

Implements

IMessage Value, IEquatable Value, IDeepCloneable Value, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

Value()

public Value()

Value(Value)

public Value(Value other)

Parameter
Name	Description
`other`	`Value`

Properties

ArrayValue

public ArrayValue ArrayValue { get; set; }

An array value.

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

Property Value
Type	Description
`ArrayValue`

BooleanValue

public bool BooleanValue { get; set; }

A boolean value.

Property Value
Type	Description
`bool`

BytesValue

public ByteString BytesValue { get; set; }

A bytes value.

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

Property Value
Type	Description
`ByteString`

DoubleValue

public double DoubleValue { get; set; }

A double value.

Property Value
Type	Description
`double`

GeoPointValue

public LatLng GeoPointValue { get; set; }

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

Property Value
Type	Description
`LatLng`

HasBooleanValue

public bool HasBooleanValue { get; }

Gets whether the "boolean_value" field is set

Property Value
Type	Description
`bool`

HasBytesValue

public bool HasBytesValue { get; }

Gets whether the "bytes_value" field is set

Property Value
Type	Description
`bool`

HasDoubleValue

public bool HasDoubleValue { get; }

Gets whether the "double_value" field is set

Property Value
Type	Description
`bool`

HasIntegerValue

public bool HasIntegerValue { get; }

Gets whether the "integer_value" field is set

Property Value
Type	Description
`bool`

HasNullValue

public bool HasNullValue { get; }

Gets whether the "null_value" field is set

Property Value
Type	Description
`bool`

HasReferenceValue

public bool HasReferenceValue { get; }

Gets whether the "reference_value" field is set

Property Value
Type	Description
`bool`

HasStringValue

public bool HasStringValue { get; }

Gets whether the "string_value" field is set

Property Value
Type	Description
`bool`

IntegerValue

public long IntegerValue { get; set; }

An integer value.

Property Value
Type	Description
`long`

MapValue

public MapValue MapValue { get; set; }

A map value.

Property Value
Type	Description
`MapValue`

NullValue

public NullValue NullValue { get; set; }

A null value.

Property Value
Type	Description
`NullValue`

ReferenceValue

public string ReferenceValue { get; set; }

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

Property Value
Type	Description
`string`

StringValue

public string StringValue { get; set; }

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.

Property Value
Type	Description
`string`

TimestampValue

public Timestamp TimestampValue { get; set; }

A timestamp value.

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

Property Value
Type	Description
`Timestamp`

ValueTypeCase

public Value.ValueTypeOneofCase ValueTypeCase { get; }

Property Value
Type	Description
`ValueValueTypeOneofCase`