Google Bigtable v2 API - Class RowRange (3.13.0)

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
Name Description
other RowRange

Properties

EndKeyCase

public RowRange.EndKeyOneofCase EndKeyCase { get; }
Property Value
Type Description
RowRangeEndKeyOneofCase

EndKeyClosed

public ByteString EndKeyClosed { get; set; }

Used when giving an inclusive upper bound for the range.

Property Value
Type Description
ByteString

EndKeyOpen

public ByteString EndKeyOpen { get; set; }

Used when giving an exclusive upper bound for the range.

Property Value
Type Description
ByteString

HasEndKeyClosed

public bool HasEndKeyClosed { get; }

Gets whether the "end_key_closed" field is set

Property Value
Type Description
bool

HasEndKeyOpen

public bool HasEndKeyOpen { get; }

Gets whether the "end_key_open" field is set

Property Value
Type Description
bool

HasStartKeyClosed

public bool HasStartKeyClosed { get; }

Gets whether the "start_key_closed" field is set

Property Value
Type Description
bool

HasStartKeyOpen

public bool HasStartKeyOpen { get; }

Gets whether the "start_key_open" field is set

Property Value
Type Description
bool

StartKeyCase

public RowRange.StartKeyOneofCase StartKeyCase { get; }
Property Value
Type Description
RowRangeStartKeyOneofCase

StartKeyClosed

public ByteString StartKeyClosed { get; set; }

Used when giving an inclusive lower bound for the range.

Property Value
Type Description
ByteString

StartKeyOpen

public ByteString StartKeyOpen { get; set; }

Used when giving an exclusive lower bound for the range.

Property Value
Type Description
ByteString

Methods

Closed(BigtableByteString?, BigtableByteString?)

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

Creates a RowRange instance with inclusive bounds.

Parameters
Name Description
startKeyClosed BigtableByteString

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

endKeyClosed BigtableByteString

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

Returns
Type Description
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(BigtableByteString?, BigtableByteString?)

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

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

Parameters
Name Description
startKeyClosed BigtableByteString

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

endKeyOpen BigtableByteString

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

Returns
Type Description
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(BigtableByteString?, BigtableByteString?)

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

Creates a RowRange instance with exclusive bounds.

Parameters
Name Description
startKeyOpen BigtableByteString

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

endKeyOpen BigtableByteString

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

Returns
Type Description
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(BigtableByteString?, BigtableByteString?)

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

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

Parameters
Name Description
startKeyOpen BigtableByteString

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

endKeyClosed BigtableByteString

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

Returns
Type Description
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.