Class protos.google.spanner.v1.TransactionOptions

Represents a TransactionOptions.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new TransactionOptions.

Parameter

Type	Name	Description
ITransactionOptions	properties	Properties to set

Properties

mode

public mode?: ("readWrite"|"partitionedDml"|"readOnly");

TransactionOptions mode.

Property Value

Type	Description
("readWrite"\|"partitionedDml"\|"readOnly")

partitionedDml

public partitionedDml?: (google.spanner.v1.TransactionOptions.IPartitionedDml|null);

TransactionOptions partitionedDml.

Property Value

Type	Description
(google.spanner.v1.TransactionOptions.IPartitionedDml\|null)

readOnly

public readOnly?: (google.spanner.v1.TransactionOptions.IReadOnly|null);

TransactionOptions readOnly.

Property Value

Type	Description
(google.spanner.v1.TransactionOptions.IReadOnly\|null)

readWrite

public readWrite?: (google.spanner.v1.TransactionOptions.IReadWrite|null);

TransactionOptions readWrite.

Property Value

Type	Description
(google.spanner.v1.TransactionOptions.IReadWrite\|null)

Methods

create(properties)

public static create(properties?: google.spanner.v1.ITransactionOptions): google.spanner.v1.TransactionOptions;

Creates a new TransactionOptions instance using the specified properties.

Parameter

Type	Name	Description
ITransactionOptions	properties	Properties to set

Returns

Type	Description
google.spanner.v1.TransactionOptions	TransactionOptions instance

decode(reader, length)

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

Decodes a TransactionOptions 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.TransactionOptions	TransactionOptions

decodeDelimited(reader)

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

Decodes a TransactionOptions 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.TransactionOptions	TransactionOptions

encode(message, writer)

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

Encodes the specified TransactionOptions message. Does not implicitly messages.

Parameters

Type	Name	Description
ITransactionOptions	message	TransactionOptions 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.ITransactionOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
ITransactionOptions	message	TransactionOptions 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.TransactionOptions;

Creates a TransactionOptions 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.TransactionOptions	TransactionOptions

toJSON()

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

Converts this TransactionOptions to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.spanner.v1.TransactionOptions	message	TransactionOptions
$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 TransactionOptions 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