Firestore API - Struct Timestamp (3.5.0)

Version 3.5.0

• 3.9.0 (latest)
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.1

public struct Timestamp : IEquatable<Timestamp>, IComparable, IComparable<Timestamp>

Reference documentation and code samples for the Firestore API struct Timestamp.

A nanosecond-precision immutable timestamp. When this is stored as part of a document in Firestore, it is truncated to the microsecond, towards the start of time.

Implements

IEquatableTimestamp, IComparable, IComparableTimestamp

Inherited Members

object.GetType()

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Methods

CompareTo(Timestamp)

public int CompareTo(Timestamp other)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameter
Name	Description
other	Timestamp An object to compare with this instance.

Returns
Type	Description
int	A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order.

CompareTo(object)

public int CompareTo(object obj)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameter
Name	Description
obj	object An object to compare with this instance.

Returns
Type	Description
int	A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.

Exceptions
Type	Description
ArgumentException	obj is not the same type as this instance.

FromDateTime(DateTime)

public static Timestamp FromDateTime(DateTime dateTime)

Converts a DateTime to a Timestamp.

Parameter
Name	Description
dateTime	DateTime The value to convert; its kind must be Utc.

Returns
Type	Description
Timestamp	A Timestamp representation of dateTime.

FromDateTimeOffset(DateTimeOffset)

public static Timestamp FromDateTimeOffset(DateTimeOffset dateTimeOffset)

Converts the given DateTimeOffset to a Timestamp

Parameter
Name	Description
dateTimeOffset	DateTimeOffset The date and time (with UTC offset) to convert to a timestamp.

Returns
Type	Description
Timestamp	The converted timestamp.

Remarks

The offset is taken into consideration when converting the value (so the same instant in time is represented) but is not a separate part of the resulting value. In other words, there is no roundtrip operation to retrieve the original DateTimeOffset.

FromProto(Timestamp)

public static Timestamp FromProto(Timestamp proto)

Creates an instance from a Protobuf Timestamp representation. Later modifications to the Protobuf representation will not affect the returned oject.

Parameter
Name	Description
proto	Timestamp A Protobuf timestamp representation. Must not be null.

Returns
Type	Description
Timestamp	An immutable timestamp.

GetCurrentTimestamp()

public static Timestamp GetCurrentTimestamp()

Returns the current timestamp according to the system clock. The system time zone is irrelevant, as a timestamp represents an instant in time.

Returns
Type	Description
Timestamp	The current timestamp according to the system clock.

GetHashCode()

public override int GetHashCode()

Returns the hash code for this instance.

Returns
Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

ToDateTime()

public DateTime ToDateTime()

Converts this timestamp to a DateTime with a kind of Utc. This can lose information as DateTime has a precision of a tick (100 nanoseconds). If the timestamp is not a precise number of ticks, it will be truncated towards the start of time.

Returns
Type	Description
DateTime	A DateTime representation of this timestamp.

ToDateTimeOffset()

public DateTimeOffset ToDateTimeOffset()

Converts this timestamp into a DateTimeOffset.

Returns
Type	Description
DateTimeOffset	This timestamp as a DateTimeOffset.

Remarks

The resulting DateTimeOffset will always have an Offset of zero. If the timestamp is not a precise number of ticks, it will be truncated towards the start of time. DateTimeOffset value precisely on a second.

ToProto()

public Timestamp ToProto()

Creates a Protobuf Timestamp representation of this timestamp. Modifications to the returned message will not be reflected in this object.

Returns
Type	Description
Timestamp	A Protobuf timestamp representation.

ToString()

public override string ToString()

Returns the fully qualified type name of this instance.

Returns
Type	Description
string	The fully qualified type name.

Overrides

ValueType.ToString()

Operators

operator ==(Timestamp, Timestamp)

public static bool operator ==(Timestamp lhs, Timestamp rhs)

Operator overload to compare two Blob values for equality.

Parameters
Name	Description
lhs	Timestamp Left value to compare
rhs	Timestamp Right value to compare

Returns
Type	Description
bool	true if lhs is equal to rhs; otherwise false.

operator >(Timestamp, Timestamp)

public static bool operator >(Timestamp lhs, Timestamp rhs)

Compares two timestamps.

Parameters
Name	Description
lhs	Timestamp The left timestamp to compare.
rhs	Timestamp The right timestamp to compare.

Returns
Type	Description
bool	true is lhs is strictly later than rhs; otherwise false.

operator >=(Timestamp, Timestamp)

public static bool operator >=(Timestamp lhs, Timestamp rhs)

Compares two timestamps.

Parameters
Name	Description
lhs	Timestamp The left timestamp to compare.
rhs	Timestamp The right timestamp to compare.

Returns
Type	Description
bool	true is lhs is later than or equal to rhs; otherwise false.

operator !=(Timestamp, Timestamp)

public static bool operator !=(Timestamp lhs, Timestamp rhs)

Operator overload to compare two Blob values for inequality.

Parameters
Name	Description
lhs	Timestamp Left value to compare
rhs	Timestamp Right value to compare

Returns
Type	Description
bool	false if lhs is equal to rhs; otherwise true.

operator <(Timestamp, Timestamp)

public static bool operator <(Timestamp lhs, Timestamp rhs)

Compares two timestamps.

Parameters
Name	Description
lhs	Timestamp The left timestamp to compare.
rhs	Timestamp The right timestamp to compare.

Returns
Type	Description
bool	true is lhs is strictly earlier than rhs; otherwise false.

operator <=(Timestamp, Timestamp)

public static bool operator <=(Timestamp lhs, Timestamp rhs)

Compares two timestamps.

Parameters
Name	Description
lhs	Timestamp The left timestamp to compare.
rhs	Timestamp The right timestamp to compare.

Returns
Type	Description
bool	true is lhs is earlier than or equal to rhs; otherwise false.