Google Bigtable v2 API - Class RowRange (3.3.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class RowRange : IMessage<RowRange>, IEquatable<RowRange>, IDeepCloneable<RowRange>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Bigtable v2 API class RowRange.

Specifies a contiguous range of rows.

Inheritance

Object > RowRange

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

RowRange()

public RowRange()

RowRange(RowRange)

public RowRange(RowRange other)
Parameter
NameDescription
otherRowRange

Properties

EndKeyCase

public RowRange.EndKeyOneofCase EndKeyCase { get; }
Property Value
TypeDescription
RowRange.EndKeyOneofCase

EndKeyClosed

public ByteString EndKeyClosed { get; set; }

Used when giving an inclusive upper bound for the range.

Property Value
TypeDescription
ByteString

EndKeyOpen

public ByteString EndKeyOpen { get; set; }

Used when giving an exclusive upper bound for the range.

Property Value
TypeDescription
ByteString

StartKeyCase

public RowRange.StartKeyOneofCase StartKeyCase { get; }
Property Value
TypeDescription
RowRange.StartKeyOneofCase

StartKeyClosed

public ByteString StartKeyClosed { get; set; }

Used when giving an inclusive lower bound for the range.

Property Value
TypeDescription
ByteString

StartKeyOpen

public ByteString StartKeyOpen { get; set; }

Used when giving an exclusive lower bound for the range.

Property Value
TypeDescription
ByteString

Methods

Closed(Nullable<BigtableByteString>, Nullable<BigtableByteString>)

public static RowRange Closed(BigtableByteString? startKeyClosed, BigtableByteString? endKeyClosed)

Creates a RowRange instance with inclusive bounds.

Parameters
NameDescription
startKeyClosedNullable<BigtableByteString>

The inclusive lower bound for the range. If null or empty, it is interpreted as the empty string.

endKeyClosedNullable<BigtableByteString>

The inclusive upper bound for the range. If null or empty, it is interpreted as the infinite row key.

Returns
TypeDescription
RowRange

The created range.

Remarks

Note that string is implicitly convertible to BigtableByteString, so the ranges can be specified using strings as well and their UTF-8 representations will be used for the key.

ClosedOpen(Nullable<BigtableByteString>, Nullable<BigtableByteString>)

public static RowRange ClosedOpen(BigtableByteString? startKeyClosed, BigtableByteString? endKeyOpen)

Creates a RowRange instance with an inclusive lower bound and an exclusive upper bound.

Parameters
NameDescription
startKeyClosedNullable<BigtableByteString>

The inclusive lower bound for the range. If null or empty, it is interpreted as the empty string.

endKeyOpenNullable<BigtableByteString>

The exclusive upper bound for the range. If null or empty, it is interpreted as the infinite row key.

Returns
TypeDescription
RowRange

The created range.

Remarks

Note that string is implicitly convertible to BigtableByteString, so the ranges can be specified using strings as well and their UTF-8 representations will be used for the key.

Open(Nullable<BigtableByteString>, Nullable<BigtableByteString>)

public static RowRange Open(BigtableByteString? startKeyOpen, BigtableByteString? endKeyOpen)

Creates a RowRange instance with exclusive bounds.

Parameters
NameDescription
startKeyOpenNullable<BigtableByteString>

The exclusive lower bound for the range. If null or empty, it is interpreted as the empty string.

endKeyOpenNullable<BigtableByteString>

The exclusive upper bound for the range. If null or empty, it is interpreted as the infinite row key.

Returns
TypeDescription
RowRange

The created range.

Remarks

Note that string is implicitly convertible to BigtableByteString, so the ranges can be specified using strings as well and their UTF-8 representations will be used for the key.

OpenClosed(Nullable<BigtableByteString>, Nullable<BigtableByteString>)

public static RowRange OpenClosed(BigtableByteString? startKeyOpen, BigtableByteString? endKeyClosed)

Creates a RowRange instance with an exclusive lower bound and an inclusive upper bound.

Parameters
NameDescription
startKeyOpenNullable<BigtableByteString>

The exclusive lower bound for the range. If null or empty, it is interpreted as the empty string.

endKeyClosedNullable<BigtableByteString>

The inclusive upper bound for the range. If null or empty, it is interpreted as the infinite row key.

Returns
TypeDescription
RowRange

The created range.

Remarks

Note that string is implicitly convertible to BigtableByteString, so the ranges can be specified using strings as well and their UTF-8 representations will be used for the key.