Class protos.google.spanner.v1.PartialResultSet

Represents a PartialResultSet.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new PartialResultSet.

Parameter

Type	Name	Description
IPartialResultSet	properties	Properties to set

Properties

chunkedValue

public chunkedValue: boolean;

PartialResultSet chunkedValue.

Property Value

Type	Description
boolean

metadata

public metadata?: (google.spanner.v1.IResultSetMetadata|null);

PartialResultSet metadata.

Property Value

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

resumeToken

public resumeToken: (Uint8Array|string);

PartialResultSet resumeToken.

Property Value

Type	Description
(Uint8Array\|string)

stats

public stats?: (google.spanner.v1.IResultSetStats|null);

PartialResultSet stats.

Property Value

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

values

public values: google.protobuf.IValue[];

PartialResultSet values.

Property Value

Type	Description
google.protobuf.IValue[]

Methods

create(properties)

public static create(properties?: google.spanner.v1.IPartialResultSet): google.spanner.v1.PartialResultSet;

Creates a new PartialResultSet instance using the specified properties.

Parameter

Type	Name	Description
IPartialResultSet	properties	Properties to set

Returns

Type	Description
google.spanner.v1.PartialResultSet	PartialResultSet instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified PartialResultSet message. Does not implicitly messages.

Parameters

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

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

Parameters

Type	Name	Description
IPartialResultSet	message	PartialResultSet 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.PartialResultSet;

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

toJSON()

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

Converts this PartialResultSet to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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