Class protos.google.spanner.v1.PartitionReadRequest

Represents a PartitionReadRequest.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new PartitionReadRequest.

Parameter
Type Name Description
IPartitionReadRequest properties

Properties to set

Properties

columns

public columns: string[];

PartitionReadRequest columns.

Property Value
Type Description
string[]

index

public index: string;

PartitionReadRequest index.

Property Value
Type Description
string

keySet

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

PartitionReadRequest keySet.

Property Value
Type Description
(google.spanner.v1.IKeySet|null)

partitionOptions

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

PartitionReadRequest partitionOptions.

Property Value
Type Description
(google.spanner.v1.IPartitionOptions|null)

session

public session: string;

PartitionReadRequest session.

Property Value
Type Description
string

table

public table: string;

PartitionReadRequest table.

Property Value
Type Description
string

transaction

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

PartitionReadRequest transaction.

Property Value
Type Description
(google.spanner.v1.ITransactionSelector|null)

Methods

create(properties)

public static create(properties?: google.spanner.v1.IPartitionReadRequest): google.spanner.v1.PartitionReadRequest;

Creates a new PartitionReadRequest instance using the specified properties.

Parameter
Type Name Description
IPartitionReadRequest properties

Properties to set
Returns
Type Description
google.spanner.v1.PartitionReadRequest

PartitionReadRequest instance

decode(reader, length)

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

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

PartitionReadRequest

decodeDelimited(reader)

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

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

PartitionReadRequest

encode(message, writer)

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

Encodes the specified PartitionReadRequest message. Does not implicitly messages.

Parameters
Type Name Description
IPartitionReadRequest message

PartitionReadRequest 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.IPartitionReadRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Type Name Description
IPartitionReadRequest message

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

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

PartitionReadRequest

toJSON()

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

Converts this PartitionReadRequest to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.spanner.v1.PartitionReadRequest message

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