Class protos.google.bigtable.v2.Mutation (3.6.0)

Represents a Mutation.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

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

Constructs a new Mutation.

Parameter

Name	Description
properties	`IMutation` Properties to set

Properties

deleteFromColumn

public deleteFromColumn?: (google.bigtable.v2.Mutation.IDeleteFromColumn|null);

Mutation deleteFromColumn.

Property Value

Type	Description
(google.bigtable.v2.Mutation.IDeleteFromColumn\|null)

deleteFromFamily

public deleteFromFamily?: (google.bigtable.v2.Mutation.IDeleteFromFamily|null);

Mutation deleteFromFamily.

Property Value

Type	Description
(google.bigtable.v2.Mutation.IDeleteFromFamily\|null)

deleteFromRow

public deleteFromRow?: (google.bigtable.v2.Mutation.IDeleteFromRow|null);

Mutation deleteFromRow.

Property Value

Type	Description
(google.bigtable.v2.Mutation.IDeleteFromRow\|null)

mutation

public mutation?: ("setCell"|"deleteFromColumn"|"deleteFromFamily"|"deleteFromRow");

Mutation mutation.

Property Value

Type	Description
("setCell"\|"deleteFromColumn"\|"deleteFromFamily"\|"deleteFromRow")

setCell

public setCell?: (google.bigtable.v2.Mutation.ISetCell|null);

Mutation setCell.

Property Value

Type	Description
(google.bigtable.v2.Mutation.ISetCell\|null)

Methods

create(properties)

public static create(properties?: google.bigtable.v2.IMutation): google.bigtable.v2.Mutation;

Creates a new Mutation instance using the specified properties.

Parameter

Name	Description
properties	`IMutation` Properties to set

Returns

Type	Description
google.bigtable.v2.Mutation	Mutation instance

decode(reader, length)

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

Decodes a Mutation 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.Mutation	Mutation

decodeDelimited(reader)

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

Decodes a Mutation 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.Mutation	Mutation

encode(message, writer)

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

Encodes the specified Mutation message. Does not implicitly messages.

Parameters

Name	Description
message	`IMutation` Mutation 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.IMutation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IMutation` Mutation 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.Mutation;

Creates a Mutation 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.Mutation	Mutation

toJSON()

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

Converts this Mutation to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.bigtable.v2.Mutation` Mutation
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 Mutation 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