Class protos.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

Represents a TableReadOptions.

Package

@google-cloud/bigquery-storage

Constructors

(constructor)(properties)

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

Constructs a new TableReadOptions.

Parameter
NameDescription
properties ITableReadOptions

Properties to set

Properties

arrowSerializationOptions

public arrowSerializationOptions?: (google.cloud.bigquery.storage.v1.IArrowSerializationOptions|null);

TableReadOptions arrowSerializationOptions.

outputFormatSerializationOptions

public outputFormatSerializationOptions?: "arrowSerializationOptions";

TableReadOptions outputFormatSerializationOptions.

rowRestriction

public rowRestriction: string;

TableReadOptions rowRestriction.

selectedFields

public selectedFields: string[];

TableReadOptions selectedFields.

Methods

create(properties)

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

Creates a new TableReadOptions instance using the specified properties.

Parameter
NameDescription
properties ITableReadOptions

Properties to set

Returns
TypeDescription
google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

TableReadOptions instance

decode(reader, length)

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

Decodes a TableReadOptions message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

TableReadOptions

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

TableReadOptions

encode(message, writer)

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

Encodes the specified TableReadOptions message. Does not implicitly messages.

Parameters
NameDescription
message ITableReadOptions

TableReadOptions message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.bigquery.storage.v1.ReadSession.ITableReadOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITableReadOptions

TableReadOptions message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

TableReadOptions

toJSON()

public toJSON(): { [k: string]: any };

Converts this TableReadOptions to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

TableReadOptions

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a TableReadOptions message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not