Google Bigtable v2 API - Class ColumnRange (3.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

IMessage<ColumnRange>, IEquatable<ColumnRange>, IDeepCloneable<ColumnRange>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

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
`ColumnRange.EndQualifierOneofCase`

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`

StartQualifierCase

public ColumnRange.StartQualifierOneofCase StartQualifierCase { get; }

Property Value
Type	Description
`ColumnRange.StartQualifierOneofCase`

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