Class protos.google.spanner.v1.ReadRequest

Represents a ReadRequest.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new ReadRequest.

Parameter

Type	Name	Description
IReadRequest	properties	Properties to set

Properties

columns

public columns: string[];

ReadRequest columns.

Property Value

Type	Description
string[]

index

public index: string;

ReadRequest index.

Property Value

Type	Description
string

keySet

public keySet?: (google.spanner.v1.IKeySet|null);

ReadRequest keySet.

Property Value

Type	Description
(google.spanner.v1.IKeySet\|null)

limit

public limit: (number|Long|string);

ReadRequest limit.

Property Value

Type	Description
(number\|Long\|string)

partitionToken

public partitionToken: (Uint8Array|string);

ReadRequest partitionToken.

Property Value

Type	Description
(Uint8Array\|string)

requestOptions

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

ReadRequest requestOptions.

Property Value

Type	Description
(google.spanner.v1.IRequestOptions\|null)

resumeToken

public resumeToken: (Uint8Array|string);

ReadRequest resumeToken.

Property Value

Type	Description
(Uint8Array\|string)

session

public session: string;

ReadRequest session.

Property Value

Type	Description
string

table

public table: string;

ReadRequest table.

Property Value

Type	Description
string

transaction

public transaction?: (google.spanner.v1.ITransactionSelector|null);

ReadRequest transaction.

Property Value

Type	Description
(google.spanner.v1.ITransactionSelector\|null)

Methods

create(properties)

public static create(properties?: google.spanner.v1.IReadRequest): google.spanner.v1.ReadRequest;

Creates a new ReadRequest instance using the specified properties.

Parameter

Type	Name	Description
IReadRequest	properties	Properties to set

Returns

Type	Description
google.spanner.v1.ReadRequest	ReadRequest instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified ReadRequest message. Does not implicitly messages.

Parameters

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

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

Parameters

Type	Name	Description
IReadRequest	message	ReadRequest 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.ReadRequest;

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

toJSON()

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

Converts this ReadRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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