Class protos.google.spanner.v1.TransactionOptions.ReadOnly

Represents a ReadOnly.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

constructor(properties?: google.spanner.v1.TransactionOptions.IReadOnly);

Constructs a new ReadOnly.

Parameter
Type Name Description
spannerClient.spanner.v1.TransactionOptions.IReadOnly properties

Properties to set

Properties

exactStaleness

public exactStaleness?: (google.protobuf.IDuration|null);

ReadOnly exactStaleness.

Property Value
Type Description
(google.protobuf.IDuration|null)

maxStaleness

public maxStaleness?: (google.protobuf.IDuration|null);

ReadOnly maxStaleness.

Property Value
Type Description
(google.protobuf.IDuration|null)

minReadTimestamp

public minReadTimestamp?: (google.protobuf.ITimestamp|null);

ReadOnly minReadTimestamp.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

readTimestamp

public readTimestamp?: (google.protobuf.ITimestamp|null);

ReadOnly readTimestamp.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

returnReadTimestamp

public returnReadTimestamp: boolean;

ReadOnly returnReadTimestamp.

Property Value
Type Description
boolean

strong

public strong?: (boolean|null);

ReadOnly strong.

Property Value
Type Description
(boolean|null)

timestampBound

public timestampBound?: ("strong"|"minReadTimestamp"|"maxStaleness"|"readTimestamp"|"exactStaleness");

ReadOnly timestampBound.

Property Value
Type Description
("strong"|"minReadTimestamp"|"maxStaleness"|"readTimestamp"|"exactStaleness")

Methods

create(properties)

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

Creates a new ReadOnly instance using the specified properties.

Parameter
Type Name Description
spannerClient.spanner.v1.TransactionOptions.IReadOnly properties

Properties to set
Returns
Type Description
google.spanner.v1.TransactionOptions.ReadOnly

ReadOnly instance

decode(reader, length)

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

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

ReadOnly

decodeDelimited(reader)

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

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

ReadOnly

encode(message, writer)

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

Encodes the specified ReadOnly message. Does not implicitly messages.

Parameters
Type Name Description
spannerClient.spanner.v1.TransactionOptions.IReadOnly message

ReadOnly 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.TransactionOptions.IReadOnly, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Type Name Description
spannerClient.spanner.v1.TransactionOptions.IReadOnly message

ReadOnly 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.ReadOnly;

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

ReadOnly

toJSON()

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

Converts this ReadOnly to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.spanner.v1.TransactionOptions.ReadOnly message

ReadOnly
$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 ReadOnly 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