Represents a PartitionReadRequest.
Package
@google-cloud/spannerConstructors
(constructor)(properties)
constructor(properties?: google.spanner.v1.IPartitionReadRequest);Constructs a new PartitionReadRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPartitionReadRequest
Properties to set |
Properties
columns
public columns: string[];PartitionReadRequest columns.
index
public index: string;PartitionReadRequest index.
keySet
public keySet?: (google.spanner.v1.IKeySet|null);PartitionReadRequest keySet.
partitionOptions
public partitionOptions?: (google.spanner.v1.IPartitionOptions|null);PartitionReadRequest partitionOptions.
session
public session: string;PartitionReadRequest session.
table
public table: string;PartitionReadRequest table.
transaction
public transaction?: (google.spanner.v1.ITransactionSelector|null);PartitionReadRequest transaction.
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 | |
|---|---|
| Name | Description |
properties |
IPartitionReadRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
IPartitionReadRequest
PartitionReadRequest 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.IPartitionReadRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PartitionReadRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPartitionReadRequest
PartitionReadRequest 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.PartitionReadRequest;Creates a PartitionReadRequest 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 |
PartitionReadRequest | PartitionReadRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for PartitionReadRequest
| 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 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 | |
|---|---|
| Name | Description |
message |
PartitionReadRequest
PartitionReadRequest |
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 PartitionReadRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|