Class protos.google.spanner.v1.TransactionOptions (7.3.0)

Represents a TransactionOptions.

Package

@google-cloud/spanner

Constructors

(constructor)(properties)

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

Constructs a new TransactionOptions.

Parameter
NameDescription
properties ITransactionOptions

Properties to set

Properties

mode

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

TransactionOptions mode.

partitionedDml

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

TransactionOptions partitionedDml.

readOnly

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

TransactionOptions readOnly.

readWrite

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

TransactionOptions readWrite.

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
NameDescription
properties ITransactionOptions

Properties to set

Returns
TypeDescription
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
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
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
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
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
NameDescription
message ITransactionOptions

TransactionOptions message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
message ITransactionOptions

TransactionOptions message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
TransactionOptions

TransactionOptions

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TransactionOptions

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this TransactionOptions to JSON.

Returns
TypeDescription
{ [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
NameDescription
message TransactionOptions

TransactionOptions

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a TransactionOptions message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not