Class protos.google.spanner.v1.ReadRequest (6.13.0)

Represents a ReadRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new ReadRequest.

Parameter
Name	Description
`properties`	`IReadRequest` Properties to set

Properties

columns

public columns: string[];

ReadRequest columns.

dataBoostEnabled

public dataBoostEnabled: boolean;

ReadRequest dataBoostEnabled.

index

public index: string;

ReadRequest index.

keySet

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

ReadRequest keySet.

limit

public limit: (number|Long|string);

ReadRequest limit.

partitionToken

public partitionToken: (Uint8Array|string);

ReadRequest partitionToken.

requestOptions

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

ReadRequest requestOptions.

resumeToken

public resumeToken: (Uint8Array|string);

ReadRequest resumeToken.

session

public session: string;

ReadRequest session.

table

public table: string;

ReadRequest table.

transaction

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

ReadRequest transaction.

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
Name	Description
`properties`	`IReadRequest` Properties to set

Returns
Type	Description
`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
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`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
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`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
Name	Description
`message`	`IReadRequest` ReadRequest message or plain object to encode
`writer`	`$protobuf.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
Name	Description
`message`	`IReadRequest` ReadRequest message or plain object to encode
`writer`	`$protobuf.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
Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns
Type	Description
`ReadRequest`	ReadRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ReadRequest

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

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
Name	Description
`message`	`ReadRequest` ReadRequest
`options`	`$protobuf.IConversionOptions` 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
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not