Class protos.google.spanner.v1.Mutation (7.1.0)

Represents a Mutation.

Package

@google-cloud/spanner

Constructors

(constructor)(properties)

constructor(properties?: google.spanner.v1.IMutation);

Constructs a new Mutation.

Parameter
NameDescription
properties IMutation

Properties to set

Properties

delete

public delete?: (google.spanner.v1.Mutation.IDelete|null);

Mutation delete.

insert

public insert?: (google.spanner.v1.Mutation.IWrite|null);

Mutation insert.

insertOrUpdate

public insertOrUpdate?: (google.spanner.v1.Mutation.IWrite|null);

Mutation insertOrUpdate.

operation

public operation?: ("insert"|"update"|"insertOrUpdate"|"replace"|"delete");

Mutation operation.

replace

public replace?: (google.spanner.v1.Mutation.IWrite|null);

Mutation replace.

update

public update?: (google.spanner.v1.Mutation.IWrite|null);

Mutation update.

Methods

create(properties)

public static create(properties?: google.spanner.v1.IMutation): google.spanner.v1.Mutation;

Creates a new Mutation instance using the specified properties.

Parameter
NameDescription
properties IMutation

Properties to set

Returns
TypeDescription
Mutation

Mutation instance

decode(reader, length)

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

Decodes a Mutation message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Mutation

Mutation

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Mutation

Mutation

encode(message, writer)

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

Encodes the specified Mutation message. Does not implicitly messages.

Parameters
NameDescription
message IMutation

Mutation message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.spanner.v1.IMutation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMutation

Mutation message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.spanner.v1.Mutation;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Mutation

Mutation

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Mutation

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Mutation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Mutation

Mutation

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Mutation message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not