Class protos.google.bigtable.v2.ReadModifyWriteRule (3.5.4)

Represents a ReadModifyWriteRule.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

constructor(properties?: google.bigtable.v2.IReadModifyWriteRule);

Constructs a new ReadModifyWriteRule.

Parameter

Name	Description
properties	`IReadModifyWriteRule` Properties to set

Properties

appendValue

public appendValue?: (Uint8Array|string|null);

ReadModifyWriteRule appendValue.

Property Value

Type	Description
(Uint8Array\|string\|null)

columnQualifier

public columnQualifier: (Uint8Array|string);

ReadModifyWriteRule columnQualifier.

Property Value

Type	Description
(Uint8Array\|string)

familyName

public familyName: string;

ReadModifyWriteRule familyName.

Property Value

Type	Description
string

incrementAmount

public incrementAmount?: (number|Long|string|null);

ReadModifyWriteRule incrementAmount.

Property Value

Type	Description
(number\|Long\|string\|null)

rule

public rule?: ("appendValue"|"incrementAmount");

ReadModifyWriteRule rule.

Property Value

Type	Description
("appendValue"\|"incrementAmount")

Methods

create(properties)

public static create(properties?: google.bigtable.v2.IReadModifyWriteRule): google.bigtable.v2.ReadModifyWriteRule;

Creates a new ReadModifyWriteRule instance using the specified properties.

Parameter

Name	Description
properties	`IReadModifyWriteRule` Properties to set

Returns

Type	Description
google.bigtable.v2.ReadModifyWriteRule	ReadModifyWriteRule instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.bigtable.v2.ReadModifyWriteRule;

Decodes a ReadModifyWriteRule message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.bigtable.v2.ReadModifyWriteRule	ReadModifyWriteRule

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.bigtable.v2.ReadModifyWriteRule;

Decodes a ReadModifyWriteRule message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.bigtable.v2.ReadModifyWriteRule	ReadModifyWriteRule

encode(message, writer)

public static encode(message: google.bigtable.v2.IReadModifyWriteRule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ReadModifyWriteRule message. Does not implicitly messages.

Parameters

Name	Description
message	`IReadModifyWriteRule` ReadModifyWriteRule message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.bigtable.v2.IReadModifyWriteRule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ReadModifyWriteRule message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IReadModifyWriteRule` ReadModifyWriteRule message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.bigtable.v2.ReadModifyWriteRule;

Creates a ReadModifyWriteRule message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.bigtable.v2.ReadModifyWriteRule	ReadModifyWriteRule

toJSON()

public toJSON(): { [k: string]: any };

Converts this ReadModifyWriteRule to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.bigtable.v2.ReadModifyWriteRule, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ReadModifyWriteRule message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.bigtable.v2.ReadModifyWriteRule` ReadModifyWriteRule
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ReadModifyWriteRule message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not