Class protos.google.spanner.v1.PartitionQueryRequest

Represents a PartitionQueryRequest.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new PartitionQueryRequest.

Parameter

Type	Name	Description
IPartitionQueryRequest	properties	Properties to set

Properties

params

public params?: (google.protobuf.IStruct|null);

PartitionQueryRequest params.

Property Value

Type	Description
(google.protobuf.IStruct\|null)

paramTypes

public paramTypes: { [k: string]: google.spanner.v1.IType };

PartitionQueryRequest paramTypes.

Property Value

Type	Description
{ [k: string]: google.spanner.v1.IType }

partitionOptions

public partitionOptions?: (google.spanner.v1.IPartitionOptions|null);

PartitionQueryRequest partitionOptions.

Property Value

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

session

public session: string;

PartitionQueryRequest session.

Property Value

Type	Description
string

sql

public sql: string;

PartitionQueryRequest sql.

Property Value

Type	Description
string

transaction

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

PartitionQueryRequest transaction.

Property Value

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

Methods

create(properties)

public static create(properties?: google.spanner.v1.IPartitionQueryRequest): google.spanner.v1.PartitionQueryRequest;

Creates a new PartitionQueryRequest instance using the specified properties.

Parameter

Type	Name	Description
IPartitionQueryRequest	properties	Properties to set

Returns

Type	Description
google.spanner.v1.PartitionQueryRequest	PartitionQueryRequest instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified PartitionQueryRequest message. Does not implicitly messages.

Parameters

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

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

Parameters

Type	Name	Description
IPartitionQueryRequest	message	PartitionQueryRequest 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.PartitionQueryRequest;

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

toJSON()

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

Converts this PartitionQueryRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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