Class protos.google.cloud.bigquery.storage.v1beta1.ReadRowsRequest (2.6.2)

Version 2.6.2

• 4.10.0 (latest)
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.1
• 4.1.0
• 4.0.0
• 3.4.0
• 3.2.0
• 3.1.1
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.4
• 2.3.0

Represents a ReadRowsRequest.

Package

@google-cloud/bigquery-storage!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.storage.v1beta1.IReadRowsRequest);

Constructs a new ReadRowsRequest.

Parameter

Name	Description
properties	IReadRowsRequest Properties to set

Properties

readPosition

public readPosition?: (google.cloud.bigquery.storage.v1beta1.IStreamPosition|null);

ReadRowsRequest readPosition.

Property Value

Type	Description
(google.cloud.bigquery.storage.v1beta1.IStreamPosition|null)

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.storage.v1beta1.IReadRowsRequest): google.cloud.bigquery.storage.v1beta1.ReadRowsRequest;

Creates a new ReadRowsRequest instance using the specified properties.

Parameter

Name	Description
properties	IReadRowsRequest Properties to set

Returns

Type	Description
google.cloud.bigquery.storage.v1beta1.ReadRowsRequest	ReadRowsRequest instance

decode(reader, length)

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

Decodes a ReadRowsRequest message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.cloud.bigquery.storage.v1beta1.ReadRowsRequest	ReadRowsRequest

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.cloud.bigquery.storage.v1beta1.ReadRowsRequest	ReadRowsRequest

encode(message, writer)

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

Encodes the specified ReadRowsRequest message. Does not implicitly messages.

Parameters

Name	Description
message	IReadRowsRequest ReadRowsRequest 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.v1beta1.IReadRowsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IReadRowsRequest ReadRowsRequest 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.v1beta1.ReadRowsRequest;

Creates a ReadRowsRequest 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
google.cloud.bigquery.storage.v1beta1.ReadRowsRequest	ReadRowsRequest

toJSON()

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

Converts this ReadRowsRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.bigquery.storage.v1beta1.ReadRowsRequest ReadRowsRequest
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 ReadRowsRequest 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