Represents a CommitRequest.
Package
@google-cloud/spanner!Constructors
(constructor)(properties)
constructor(properties?: google.spanner.v1.ICommitRequest);Constructs a new CommitRequest.
| Type | Name | Description |
|---|---|---|
| ICommitRequest | properties |
Properties to set |
Properties
mutations
public mutations: google.spanner.v1.IMutation[];CommitRequest mutations.
| Type | Description |
|---|---|
| google.spanner.v1.IMutation[] |
requestOptions
public requestOptions?: (google.spanner.v1.IRequestOptions|null);CommitRequest requestOptions.
| Type | Description |
|---|---|
| (google.spanner.v1.IRequestOptions|null) |
returnCommitStats
public returnCommitStats: boolean;CommitRequest returnCommitStats.
| Type | Description |
|---|---|
| boolean |
session
public session: string;CommitRequest session.
| Type | Description |
|---|---|
| string |
singleUseTransaction
public singleUseTransaction?: (google.spanner.v1.ITransactionOptions|null);CommitRequest singleUseTransaction.
| Type | Description |
|---|---|
| (google.spanner.v1.ITransactionOptions|null) |
transaction
public transaction?: ("transactionId"|"singleUseTransaction");CommitRequest transaction.
| Type | Description |
|---|---|
| ("transactionId"|"singleUseTransaction") |
transactionId
public transactionId?: (Uint8Array|string|null);CommitRequest transactionId.
| 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.
| Type | Name | Description |
|---|---|---|
| ICommitRequest | properties |
Properties to set |
| 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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| 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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| 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.
| Type | Name | Description |
|---|---|---|
| ICommitRequest | message |
CommitRequest message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| ICommitRequest | message |
CommitRequest message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.spanner.v1.CommitRequest | CommitRequest |
toJSON()
public toJSON(): { [k: string]: any };Converts this CommitRequest to JSON.
| 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.
| Type | Name | Description |
|---|---|---|
| google.spanner.v1.CommitRequest | message |
CommitRequest |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a CommitRequest message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|