ReadRowsResponse

google.cloud.bigquery.storage.v1. ReadRowsResponse

Represents a ReadRowsResponse.

Constructor

new ReadRowsResponse(propertiesopt)

Constructs a new ReadRowsResponse.

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

Properties to set

Implements:
  • IReadRowsResponse

Members

_uncompressedByteSize

ReadRowsResponse _uncompressedByteSize.

arrowRecordBatch

ReadRowsResponse arrowRecordBatch.

arrowSchema

ReadRowsResponse arrowSchema.

avroRows

ReadRowsResponse avroRows.

avroSchema

ReadRowsResponse avroSchema.

rowCount

ReadRowsResponse rowCount.

rows

ReadRowsResponse rows.

schema

ReadRowsResponse schema.

stats

ReadRowsResponse stats.

throttleState

ReadRowsResponse throttleState.

uncompressedByteSize

ReadRowsResponse uncompressedByteSize.

Methods

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

Converts this ReadRowsResponse to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new ReadRowsResponse instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.bigquery.storage.v1.ReadRowsResponse

ReadRowsResponse instance

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

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

ReadRowsResponse

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.ReadRowsResponse}

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

ReadRowsResponse

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

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

ReadRowsResponse 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 ReadRowsResponse message, length delimited. Does not implicitly verify messages.

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

ReadRowsResponse 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.ReadRowsResponse}

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

ReadRowsResponse

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ReadRowsResponse

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

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

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

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

ReadRowsResponse

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a ReadRowsResponse 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