Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.spanner.v1.CommitRequest (6.10.1)

Represents a CommitRequest.

Package

@google-cloud/spanner

Constructors

(constructor)(properties)

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

Constructs a new CommitRequest.

Parameter
Name	Description
`properties`	`ICommitRequest` Properties to set

Properties

mutations

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

CommitRequest mutations.

requestOptions

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

CommitRequest requestOptions.

returnCommitStats

public returnCommitStats: boolean;

CommitRequest returnCommitStats.

session

public session: string;

CommitRequest session.

singleUseTransaction

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

CommitRequest singleUseTransaction.

transaction

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

CommitRequest transaction.

transactionId

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

CommitRequest transactionId.

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
Name	Description
`properties`	`ICommitRequest` Properties to set

Returns
Type	Description
`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
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`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
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`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
Name	Description
`message`	`ICommitRequest` CommitRequest 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.spanner.v1.ICommitRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`ICommitRequest` CommitRequest 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.spanner.v1.CommitRequest;

Creates a CommitRequest 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
`CommitRequest`	CommitRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CommitRequest

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

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
Name	Description
`message`	`CommitRequest` CommitRequest
`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 CommitRequest 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