Google BigQuery Storage V1 Client - Class Progress (1.8.0)

Version 1.8.0

• 2.1.2 (latest)
• 2.1.1
• 2.0.0
• 1.10.4
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.1
• 1.3.2
• 1.2.12

Reference documentation and code samples for the Google BigQuery Storage V1 Client class Progress.

Generated from protobuf message google.cloud.bigquery.storage.v1.StreamStats.Progress

Namespace

Google \ Cloud \ BigQuery \ Storage \ V1 \ StreamStats

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ at_response_start	float The fraction of rows assigned to the stream that have been processed by the server so far, not including the rows in the current response message. This value, along with at_response_end, can be used to interpolate the progress made as the rows in the message are being processed using the following formula: at_response_start + (at_response_end - at_response_start) * rows_processed_from_response / rows_in_response. Note that if a filter is provided, the at_response_end value of the previous response may not necessarily be equal to the at_response_start value of the current response.
↳ at_response_end	float Similar to at_response_start, except that this value includes the rows in the current response.

getAtResponseStart

The fraction of rows assigned to the stream that have been processed by the server so far, not including the rows in the current response message.

This value, along with at_response_end, can be used to interpolate the progress made as the rows in the message are being processed using the following formula: at_response_start + (at_response_end - at_response_start) * rows_processed_from_response / rows_in_response. Note that if a filter is provided, the at_response_end value of the previous response may not necessarily be equal to the at_response_start value of the current response.

Returns
Type	Description
float

setAtResponseStart

The fraction of rows assigned to the stream that have been processed by the server so far, not including the rows in the current response message.

This value, along with at_response_end, can be used to interpolate the progress made as the rows in the message are being processed using the following formula: at_response_start + (at_response_end - at_response_start) * rows_processed_from_response / rows_in_response. Note that if a filter is provided, the at_response_end value of the previous response may not necessarily be equal to the at_response_start value of the current response.

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getAtResponseEnd

Similar to at_response_start, except that this value includes the rows in the current response.

Returns
Type	Description
float

setAtResponseEnd

Similar to at_response_start, except that this value includes the rows in the current response.

Parameter
Name	Description
var	float

Returns
Type	Description
$this