Google Bigtable v2 API - Class ColumnRange (3.2.0)

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

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

Specifies a contiguous range of columns within a single column family. The range spans from &lt;column_family&gt;:&lt;start_qualifier&gt; to &lt;column_family&gt;:&lt;end_qualifier&gt;, where both bounds can be either inclusive or exclusive.

Inheritance

Object > ColumnRange

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

ColumnRange()

public ColumnRange()

ColumnRange(ColumnRange)

public ColumnRange(ColumnRange other)
Parameter
NameDescription
otherColumnRange

Properties

EndQualifierCase

public ColumnRange.EndQualifierOneofCase EndQualifierCase { get; }
Property Value
TypeDescription
ColumnRange.EndQualifierOneofCase

EndQualifierClosed

public ByteString EndQualifierClosed { get; set; }

Used when giving an inclusive upper bound for the range.

Property Value
TypeDescription
ByteString

EndQualifierOpen

public ByteString EndQualifierOpen { get; set; }

Used when giving an exclusive upper bound for the range.

Property Value
TypeDescription
ByteString

FamilyName

public string FamilyName { get; set; }

The name of the column family within which this range falls.

Property Value
TypeDescription
String

StartQualifierCase

public ColumnRange.StartQualifierOneofCase StartQualifierCase { get; }
Property Value
TypeDescription
ColumnRange.StartQualifierOneofCase

StartQualifierClosed

public ByteString StartQualifierClosed { get; set; }

Used when giving an inclusive lower bound for the range.

Property Value
TypeDescription
ByteString

StartQualifierOpen

public ByteString StartQualifierOpen { get; set; }

Used when giving an exclusive lower bound for the range.

Property Value
TypeDescription
ByteString

Methods

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

public static ColumnRange Closed(string familyName, BigtableByteString? startQualifierClosed, BigtableByteString? endQualifierClosed)

Creates a ColumnRange instance with inclusive bounds.

Parameters
NameDescription
familyNameString

The name of the column family within which this range falls. Must match [-_.a-zA-Z0-9]+

startQualifierClosedNullable<BigtableByteString>

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

endQualifierClosedNullable<BigtableByteString>

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

Returns
TypeDescription
ColumnRange

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 qualifier.

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

public static ColumnRange ClosedOpen(string familyName, BigtableByteString? startQualifierClosed, BigtableByteString? endQualifierOpen)

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

Parameters
NameDescription
familyNameString

The name of the column family within which this range falls. Must match [-_.a-zA-Z0-9]+

startQualifierClosedNullable<BigtableByteString>

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

endQualifierOpenNullable<BigtableByteString>

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

Returns
TypeDescription
ColumnRange

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 qualifier.

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

public static ColumnRange Open(string familyName, BigtableByteString? startQualifierOpen, BigtableByteString? endQualifierOpen)

Creates a ColumnRange instance with exclusive bounds.

Parameters
NameDescription
familyNameString

The name of the column family within which this range falls. Must match [-_.a-zA-Z0-9]+

startQualifierOpenNullable<BigtableByteString>

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

endQualifierOpenNullable<BigtableByteString>

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

Returns
TypeDescription
ColumnRange

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 qualifier.

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

public static ColumnRange OpenClosed(string familyName, BigtableByteString? startQualifierOpen, BigtableByteString? endQualifierClosed)

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

Parameters
NameDescription
familyNameString

The name of the column family within which this range falls. Must match [-_.a-zA-Z0-9]+

startQualifierOpenNullable<BigtableByteString>

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

endQualifierClosedNullable<BigtableByteString>

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

Returns
TypeDescription
ColumnRange

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 qualifier.