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

Represents a TableReadOptions.

Package

Constructors

(constructor)(properties)

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

Constructs a new TableReadOptions.

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

Properties

_samplePercentage

public _samplePercentage?: "samplePercentage";

TableReadOptions _samplePercentage.

arrowSerializationOptions

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

TableReadOptions arrowSerializationOptions.

avroSerializationOptions

public avroSerializationOptions?: (google.cloud.bigquery.storage.v1.IAvroSerializationOptions|null);

TableReadOptions avroSerializationOptions.

outputFormatSerializationOptions

public outputFormatSerializationOptions?: ("arrowSerializationOptions"|"avroSerializationOptions");

TableReadOptions outputFormatSerializationOptions.

rowRestriction

public rowRestriction: string;

TableReadOptions rowRestriction.

samplePercentage

public samplePercentage?: (number|null);

TableReadOptions samplePercentage.

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
Name	Description
`properties`	`ITableReadOptions` Properties to set

Returns
Type	Description
`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
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`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
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`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
Name	Description
`message`	`ITableReadOptions` TableReadOptions 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.ReadSession.ITableReadOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`ITableReadOptions` TableReadOptions 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.TableReadOptions;

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

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TableReadOptions

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

Returns
Type	Description
`{ [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
Name	Description
`message`	`TableReadOptions` TableReadOptions
`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 TableReadOptions 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