Google Bigtable v2 API - Class ColumnRange (3.12.0)

Version latest

• 3.12.0 (latest)
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

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 <column_family>:<start_qualifier> to <column_family>:<end_qualifier>, where both bounds can be either inclusive or exclusive.

Inheritance

object > ColumnRange

Implements

IMessageColumnRange, IEquatableColumnRange, IDeepCloneableColumnRange, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

ColumnRange()

public ColumnRange()

ColumnRange(ColumnRange)

public ColumnRange(ColumnRange other)

Parameter
Name	Description
other	ColumnRange

Properties

EndQualifierCase

public ColumnRange.EndQualifierOneofCase EndQualifierCase { get; }

Property Value
Type	Description
ColumnRangeEndQualifierOneofCase

EndQualifierClosed

public ByteString EndQualifierClosed { get; set; }

Used when giving an inclusive upper bound for the range.

Property Value
Type	Description
ByteString

EndQualifierOpen

public ByteString EndQualifierOpen { get; set; }

Used when giving an exclusive upper bound for the range.

Property Value
Type	Description
ByteString

FamilyName

public string FamilyName { get; set; }

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

Property Value
Type	Description
string

HasEndQualifierClosed

public bool HasEndQualifierClosed { get; }

Gets whether the "end_qualifier_closed" field is set

Property Value
Type	Description
bool

HasEndQualifierOpen

public bool HasEndQualifierOpen { get; }

Gets whether the "end_qualifier_open" field is set

Property Value
Type	Description
bool

HasStartQualifierClosed

public bool HasStartQualifierClosed { get; }

Gets whether the "start_qualifier_closed" field is set

Property Value
Type	Description
bool

HasStartQualifierOpen

public bool HasStartQualifierOpen { get; }

Gets whether the "start_qualifier_open" field is set

Property Value
Type	Description
bool

StartQualifierCase

public ColumnRange.StartQualifierOneofCase StartQualifierCase { get; }

Property Value
Type	Description
ColumnRangeStartQualifierOneofCase

StartQualifierClosed

public ByteString StartQualifierClosed { get; set; }

Used when giving an inclusive lower bound for the range.

Property Value
Type	Description
ByteString

StartQualifierOpen

public ByteString StartQualifierOpen { get; set; }

Used when giving an exclusive lower bound for the range.

Property Value
Type	Description
ByteString

Methods

Closed(string, BigtableByteString?, BigtableByteString?)

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

Creates a ColumnRange instance with inclusive bounds.

Parameters
Name	Description
familyName	string The name of the column family within which this range falls. Must match [-_.a-zA-Z0-9]+
startQualifierClosed	BigtableByteString The inclusive lower bound for the range. If null or empty, it is interpreted as the empty string.
endQualifierClosed	BigtableByteString The inclusive upper bound for the range. If null or empty, it is interpreted as the infinite qualifier.

Returns
Type	Description
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, BigtableByteString?, 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
Name	Description
familyName	string The name of the column family within which this range falls. Must match [-_.a-zA-Z0-9]+
startQualifierClosed	BigtableByteString The inclusive lower bound for the range. If null or empty, it is interpreted as the empty string.
endQualifierOpen	BigtableByteString The exclusive upper bound for the range. If null or empty, it is interpreted as the infinite qualifier.

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

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

Creates a ColumnRange instance with exclusive bounds.

Parameters
Name	Description
familyName	string The name of the column family within which this range falls. Must match [-_.a-zA-Z0-9]+
startQualifierOpen	BigtableByteString The exclusive lower bound for the range. If null or empty, it is interpreted as the empty string.
endQualifierOpen	BigtableByteString The exclusive upper bound for the range. If null or empty, it is interpreted as the infinite qualifier.

Returns
Type	Description
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, BigtableByteString?, 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
Name	Description
familyName	string The name of the column family within which this range falls. Must match [-_.a-zA-Z0-9]+
startQualifierOpen	BigtableByteString The exclusive lower bound for the range. If null or empty, it is interpreted as the empty string.
endQualifierClosed	BigtableByteString The inclusive upper bound for the range. If null or empty, it is interpreted as the infinite qualifier.

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