ReadRequest

google.spanner.v1. ReadRequest

Represents a ReadRequest.

Constructor

new ReadRequest(propertiesopt)

Constructs a new ReadRequest.

Parameters:
Name Type Attributes Description
properties google.spanner.v1.IReadRequest <optional>

Properties to set

Implements:
  • IReadRequest

Members

columns :Array.<string>

ReadRequest columns.

index :string

ReadRequest index.

keySet :google.spanner.v1.IKeySet|null|undefined

ReadRequest keySet.

limit :number|Long

ReadRequest limit.

partitionToken :Uint8Array

ReadRequest partitionToken.

resumeToken :Uint8Array

ReadRequest resumeToken.

session :string

ReadRequest session.

table :string

ReadRequest table.

transaction :google.spanner.v1.ITransactionSelector|null|undefined

ReadRequest transaction.

Methods

(static) create(propertiesopt) → {google.spanner.v1.ReadRequest}

Creates a new ReadRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.spanner.v1.IReadRequest <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.spanner.v1.ReadRequest}

Decodes a ReadRequest message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.spanner.v1.ReadRequest}

Decodes a ReadRequest message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified ReadRequest message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.v1.IReadRequest

ReadRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.spanner.v1.IReadRequest

ReadRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.spanner.v1.ReadRequest}

Creates a ReadRequest message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.spanner.v1.ReadRequest

ReadRequest

options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a ReadRequest message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this ReadRequest to JSON.