ReadSession

google.cloud.bigquery.storage.v1. ReadSession

Represents a ReadSession.

Constructor

new ReadSession(propertiesopt)

Constructs a new ReadSession.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.storage.v1.IReadSession <optional>

Properties to set
Implements:
  • IReadSession

Classes

TableModifiers
TableReadOptions

Members

arrowSchema

ReadSession arrowSchema.

avroSchema

ReadSession avroSchema.

dataFormat

ReadSession dataFormat.

estimatedTotalBytesScanned

ReadSession estimatedTotalBytesScanned.

expireTime

ReadSession expireTime.

name

ReadSession name.

readOptions

ReadSession readOptions.

schema

ReadSession schema.

streams

ReadSession streams.

table

ReadSession table.

tableModifiers

ReadSession tableModifiers.

Methods

(static) create(propertiesopt) → {google.cloud.bigquery.storage.v1.ReadSession}

Creates a new ReadSession instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.storage.v1.IReadSession <optional>

Properties to set
Returns:
Type Description
google.cloud.bigquery.storage.v1.ReadSession

ReadSession instance

(static) decode(reader, lengthopt) → {google.cloud.bigquery.storage.v1.ReadSession}

Decodes a ReadSession 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
Returns:
Type Description
google.cloud.bigquery.storage.v1.ReadSession

ReadSession
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.cloud.bigquery.storage.v1.ReadSession}

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

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

Reader or buffer to decode from
Returns:
Type Description
google.cloud.bigquery.storage.v1.ReadSession

ReadSession
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 ReadSession message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.storage.v1.IReadSession

ReadSession message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

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

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

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.storage.v1.IReadSession

ReadSession message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.bigquery.storage.v1.ReadSession}

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

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

Plain object
Returns:
Type Description
google.cloud.bigquery.storage.v1.ReadSession

ReadSession

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

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

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.storage.v1.ReadSession

ReadSession
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a ReadSession message.

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

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

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

Converts this ReadSession to JSON.

Returns:
Type Description
Object.<string, *>

JSON object