Class protos.google.cloud.bigquery.storage.v1.ReadSession (4.2.1)

Represents a ReadSession.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.storage.v1.IReadSession);

Constructs a new ReadSession.

Parameter
Name	Description
`properties`	`IReadSession` Properties to set

Properties

arrowSchema

public arrowSchema?: (google.cloud.bigquery.storage.v1.IArrowSchema|null);

ReadSession arrowSchema.

avroSchema

public avroSchema?: (google.cloud.bigquery.storage.v1.IAvroSchema|null);

ReadSession avroSchema.

dataFormat

public dataFormat: (google.cloud.bigquery.storage.v1.DataFormat|keyof typeof google.cloud.bigquery.storage.v1.DataFormat);

ReadSession dataFormat.

estimatedRowCount

public estimatedRowCount: (number|Long|string);

ReadSession estimatedRowCount.

estimatedTotalBytesScanned

public estimatedTotalBytesScanned: (number|Long|string);

ReadSession estimatedTotalBytesScanned.

estimatedTotalPhysicalFileSize

public estimatedTotalPhysicalFileSize: (number|Long|string);

ReadSession estimatedTotalPhysicalFileSize.

expireTime

public expireTime?: (google.protobuf.ITimestamp|null);

ReadSession expireTime.

name

public name: string;

ReadSession name.

readOptions

public readOptions?: (google.cloud.bigquery.storage.v1.ReadSession.ITableReadOptions|null);

ReadSession readOptions.

schema

public schema?: ("avroSchema"|"arrowSchema");

ReadSession schema.

streams

public streams: google.cloud.bigquery.storage.v1.IReadStream[];

ReadSession streams.

table

public table: string;

ReadSession table.

tableModifiers

public tableModifiers?: (google.cloud.bigquery.storage.v1.ReadSession.ITableModifiers|null);

ReadSession tableModifiers.

traceId

public traceId: string;

ReadSession traceId.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.storage.v1.IReadSession): google.cloud.bigquery.storage.v1.ReadSession;

Creates a new ReadSession instance using the specified properties.

Parameter
Name	Description
`properties`	`IReadSession` Properties to set

Returns
Type	Description
`ReadSession`	ReadSession instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.storage.v1.ReadSession;

Decodes a ReadSession 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
`ReadSession`	ReadSession

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.storage.v1.ReadSession;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`ReadSession`	ReadSession

encode(message, writer)

public static encode(message: google.cloud.bigquery.storage.v1.IReadSession, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ReadSession message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IReadSession` ReadSession 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.cloud.bigquery.storage.v1.IReadSession, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IReadSession` ReadSession 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.cloud.bigquery.storage.v1.ReadSession;

Creates a ReadSession 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
`ReadSession`	ReadSession

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ReadSession

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 ReadSession to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`ReadSession` ReadSession
`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 ReadSession message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not