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
Type Name Description
ICommitRequest properties

Properties to set

Properties

mutations

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

CommitRequest mutations.

Property Value
Type Description
google.spanner.v1.IMutation[]

requestOptions

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

CommitRequest requestOptions.

Property Value
Type Description
(google.spanner.v1.IRequestOptions|null)

returnCommitStats

public returnCommitStats: boolean;

CommitRequest returnCommitStats.

Property Value
Type Description
boolean

session

public session: string;

CommitRequest session.

Property Value
Type Description
string

singleUseTransaction

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

CommitRequest singleUseTransaction.

Property Value
Type Description
(google.spanner.v1.ITransactionOptions|null)

transaction

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

CommitRequest transaction.

Property Value
Type Description
("transactionId"|"singleUseTransaction")

transactionId

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

CommitRequest transactionId.

Property Value
Type Description
(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
Type Name Description
ICommitRequest properties

Properties to set
Returns
Type Description
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
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
number length

Message length if known beforehand
Returns
Type Description
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
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
Returns
Type Description
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
Type Name Description
ICommitRequest message

CommitRequest message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$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
Type Name Description
ICommitRequest message

CommitRequest message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$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
Type Name Description
{ [k: string]: any } object

Plain object
Returns
Type Description
google.spanner.v1.CommitRequest

CommitRequest

toJSON()

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

Converts this CommitRequest to JSON.

Returns
Type Description
{ [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
Type Name Description
google.spanner.v1.CommitRequest message

CommitRequest
$protobuf.IConversionOptions options

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a CommitRequest message.

Parameter
Type Name Description
{ [k: string]: any } message

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not