Google Bigtable v2 API - Class ReadModifyWriteRules (3.15.0)

Version latest

• 3.15.0 (latest)
• 3.14.0
• 3.13.0
• 3.12.0
• 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 static class ReadModifyWriteRules

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

Static class with convenience methods for creating various kinds of ReadModifyWriteRule instances.

Inheritance

object > ReadModifyWriteRules

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Methods

Append(string, BigtableByteString, BigtableByteString)

public static ReadModifyWriteRule Append(string familyName, BigtableByteString columnQualifier, BigtableByteString appendValue)

Rule specifying that appendValue be appended to the existing value. If the targeted cell is unset, it will be treated as containing the empty string.

Parameters
Name	Description
familyName	string The name of the family to which the read/modify/write should be applied. Must match [-_.a-zA-Z0-9]+
columnQualifier	BigtableByteString The qualifier of the column to which the read/modify/write should be applied. Can be any byte string, including the empty string.
appendValue	BigtableByteString The value to append to the existing cell value.

Returns
Type	Description
ReadModifyWriteRule	The append value rule.

Remarks

Note that string is implicitly convertible to BigtableByteString, so columnQualifier can be specified using a string as well and its UTF-8 representations will be used.

Increment(string, BigtableByteString, long)

public static ReadModifyWriteRule Increment(string familyName, BigtableByteString columnQualifier, long incrementAmount)

Rule specifying that incrementAmount be added to the existing value. If the targeted cell is unset, it will be treated as containing a zero. Otherwise, the targeted cell must contain an 8-byte value (interpreted as a 64-bit big-endian signed integer), or the entire request will fail.

Parameters
Name	Description
familyName	string The name of the family to which the read/modify/write should be applied. Must match [-_.a-zA-Z0-9]+
columnQualifier	BigtableByteString The qualifier of the column to which the read/modify/write should be applied. Can be any byte string, including the empty string.
incrementAmount	long The amount to increment the existing cell value.

Returns
Type	Description
ReadModifyWriteRule	The increment amount rule.

Remarks

Note that string is implicitly convertible to BigtableByteString, so columnQualifier can be specified using a string as well and its UTF-8 representations will be used.