Class BigtableVersionRange (3.1.0)

public class BigtableVersionRange : IEquatable<BigtableVersionRange>

A contiguous range of versions.

Inheritance

Object > BigtableVersionRange

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Remarks

Note: version values are stored on the server as if they are microseconds since the Unix epoch. However, the server only supports millisecond granularity, so the server only allows microseconds in multiples of 1,000. BigtableVersion attempts to hide this complexity by exposing its underlying Value in terms of milliseconds, so if desired, a custom versioning scheme of 1, 2, ... can be used rather than 1000, 2000, ... However, access to the underlying microsecond value is still provided via Micros.

Note: when using ReadModifyWriteRow, modified columns automatically use a server version, which is based on the current timestamp since the Unix epoch. For those columns, other reads and writes should use BigtableVersion values constructed from DateTime values, as opposed to using a custom versioning scheme with 64-bit values.

Constructors

BigtableVersionRange(Nullable<BigtableVersion>, Nullable<BigtableVersion>)

public BigtableVersionRange(BigtableVersion? start, BigtableVersion? end)

Creates a new BigtableVersionRange.

Parameters
NameDescription
startNullable<BigtableVersion>

Inclusive lower bound. If null, interpreted as 0.

endNullable<BigtableVersion>

Exclusive upper bound. If null, interpreted as infinity.

BigtableVersionRange(Nullable<DateTime>, Nullable<DateTime>)

public BigtableVersionRange(DateTime? startTimestamp, DateTime? endTimestamp)

Creates a new BigtableVersionRange.

Parameters
NameDescription
startTimestampNullable<DateTime>

Inclusive lower bound timestamp whose milliseconds since the Unix epoch should be used as the version value. If null, interpreted as 0. It must be specified in UTC.

endTimestampNullable<DateTime>

Exclusive upper bound timestamp whose milliseconds since the Unix epoch should be used as the version value. If null, interpreted as infinity. It must be specified in UTC.

Remarks

Note: version values are stored on the server as if they are microseconds since the Unix epoch. However, the server only supports millisecond granularity, so the server only allows microseconds in multiples of 1,000. BigtableVersion attempts to hide this complexity by exposing its underlying Value in terms of milliseconds, so if desired, a custom versioning scheme of 1, 2, ... can be used rather than 1000, 2000, ... However, access to the underlying microsecond value is still provided via Micros.

Note: when using ReadModifyWriteRow, modified columns automatically use a server version, which is based on the current timestamp since the Unix epoch. For those columns, other reads and writes should use BigtableVersion values constructed from DateTime values, as opposed to using a custom versioning scheme with 64-bit values.

BigtableVersionRange(Nullable<Int64>, Nullable<Int64>)

public BigtableVersionRange(long? start, long? end)

Creates a new BigtableVersionRange.

Parameters
NameDescription
startNullable<Int64>

Inclusive lower bound non-negative version value, or -1 to initialize from the milliseconds of DateTime.UtcNow. Must be less than or equal to 9223372036854775. If null, interpreted as 0.

endNullable<Int64>

Exclusive upper bound non-negative version value, or -1 to initialize from the milliseconds of DateTime.UtcNow. Must be less than or equal to 9223372036854775. If null, interpreted as infinity.

Remarks

Note: version values are stored on the server as if they are microseconds since the Unix epoch. However, the server only supports millisecond granularity, so the server only allows microseconds in multiples of 1,000. BigtableVersion attempts to hide this complexity by exposing its underlying Value in terms of milliseconds, so if desired, a custom versioning scheme of 1, 2, ... can be used rather than 1000, 2000, ... However, access to the underlying microsecond value is still provided via Micros.

Note: when using ReadModifyWriteRow, modified columns automatically use a server version, which is based on the current timestamp since the Unix epoch. For those columns, other reads and writes should use BigtableVersion values constructed from DateTime values, as opposed to using a custom versioning scheme with 64-bit values.

Properties

End

public BigtableVersion? End { get; }

Gets the exclusive upper bound. If null, interpreted as infinity.

Property Value
TypeDescription
Nullable<BigtableVersion>

Start

public BigtableVersion? Start { get; }

Gets the inclusive lower bound. If null, interpreted as 0.

Property Value
TypeDescription
Nullable<BigtableVersion>

Methods

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32
Overrides

ToString()

public override string ToString()
Returns
TypeDescription
String
Overrides