Class protos.google.spanner.v1.CommitRequest

Represents a CommitRequest.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new CommitRequest.

Parameter
TypeNameDescription
ICommitRequestproperties

Properties to set

Properties

mutations

public mutations: google.spanner.v1.IMutation[];

CommitRequest mutations.

Property Value
TypeDescription
google.spanner.v1.IMutation[]

requestOptions

public requestOptions?: (google.spanner.v1.IRequestOptions|null);

CommitRequest requestOptions.

Property Value
TypeDescription
(google.spanner.v1.IRequestOptions|null)

returnCommitStats

public returnCommitStats: boolean;

CommitRequest returnCommitStats.

Property Value
TypeDescription
boolean

session

public session: string;

CommitRequest session.

Property Value
TypeDescription
string

singleUseTransaction

public singleUseTransaction?: (google.spanner.v1.ITransactionOptions|null);

CommitRequest singleUseTransaction.

Property Value
TypeDescription
(google.spanner.v1.ITransactionOptions|null)

transaction

public transaction?: ("transactionId"|"singleUseTransaction");

CommitRequest transaction.

Property Value
TypeDescription
("transactionId"|"singleUseTransaction")

transactionId

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

CommitRequest transactionId.

Property Value
TypeDescription
(Uint8Array|string|null)

Methods

create(properties)

public static create(properties?: google.spanner.v1.ICommitRequest): google.spanner.v1.CommitRequest;

Creates a new CommitRequest instance using the specified properties.

Parameter
TypeNameDescription
ICommitRequestproperties

Properties to set

Returns
TypeDescription
google.spanner.v1.CommitRequest

CommitRequest instance

decode(reader, length)

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

Decodes a CommitRequest message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.spanner.v1.CommitRequest

CommitRequest

decodeDelimited(reader)

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

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.spanner.v1.CommitRequest

CommitRequest

encode(message, writer)

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

Encodes the specified CommitRequest message. Does not implicitly messages.

Parameters
TypeNameDescription
ICommitRequestmessage

CommitRequest message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
ICommitRequestmessage

CommitRequest message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

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

Plain object

Returns
TypeDescription
google.spanner.v1.CommitRequest

CommitRequest

toJSON()

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

Converts this CommitRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.spanner.v1.CommitRequestmessage

CommitRequest

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a CommitRequest message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not