Reference documentation and code samples for the Google BigQuery Storage V1 Client class WindowStats.
Aggregate connection metrics over a window interval.
Generated from protobuf message google.cloud.bigquery.storage.v1.ClientStats.WindowStats
Namespace
Google \ Cloud \ BigQuery \ Storage \ V1 \ ClientStatsMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ max_response_latency_millis |
int|string
Optional. The maximum response latency observed in the window, expressed in milliseconds. |
↳ avg_response_latency_millis |
int|string
Optional. The average response latency observed in the window, expressed in milliseconds. |
↳ longest_wait_no_response_millis |
int|string
Optional. The longest time spent waiting without receiving a response in the window. This could exceed max_response_latency_millis because the latter is evaluated only when a response is received. Expressed in milliseconds. |
↳ requests_sent_count |
int|string
Optional. How many requests were sent in the window. |
↳ responses_received_count |
int|string
Optional. How many responses were received in the window. |
↳ bytes_sent_count |
int|string
Optional. How many bytes were sent in the window. |
↳ window_start_time_epoch_millis |
int|string
Optional. Start time of the window interval for which these stats are aggregated, expressed in epoch milliseconds. |
↳ window_millis |
int|string
Optional. Duration of the window interval for which these stats are aggregated, expressed in milliseconds. |
getMaxResponseLatencyMillis
Optional. The maximum response latency observed in the window, expressed in milliseconds.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMaxResponseLatencyMillis
clearMaxResponseLatencyMillis
setMaxResponseLatencyMillis
Optional. The maximum response latency observed in the window, expressed in milliseconds.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvgResponseLatencyMillis
Optional. The average response latency observed in the window, expressed in milliseconds.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasAvgResponseLatencyMillis
clearAvgResponseLatencyMillis
setAvgResponseLatencyMillis
Optional. The average response latency observed in the window, expressed in milliseconds.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLongestWaitNoResponseMillis
Optional. The longest time spent waiting without receiving a response in the window. This could exceed max_response_latency_millis because the latter is evaluated only when a response is received. Expressed in milliseconds.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasLongestWaitNoResponseMillis
clearLongestWaitNoResponseMillis
setLongestWaitNoResponseMillis
Optional. The longest time spent waiting without receiving a response in the window. This could exceed max_response_latency_millis because the latter is evaluated only when a response is received. Expressed in milliseconds.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestsSentCount
Optional. How many requests were sent in the window.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasRequestsSentCount
clearRequestsSentCount
setRequestsSentCount
Optional. How many requests were sent in the window.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResponsesReceivedCount
Optional. How many responses were received in the window.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasResponsesReceivedCount
clearResponsesReceivedCount
setResponsesReceivedCount
Optional. How many responses were received in the window.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBytesSentCount
Optional. How many bytes were sent in the window.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasBytesSentCount
clearBytesSentCount
setBytesSentCount
Optional. How many bytes were sent in the window.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWindowStartTimeEpochMillis
Optional. Start time of the window interval for which these stats are aggregated, expressed in epoch milliseconds.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasWindowStartTimeEpochMillis
clearWindowStartTimeEpochMillis
setWindowStartTimeEpochMillis
Optional. Start time of the window interval for which these stats are aggregated, expressed in epoch milliseconds.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWindowMillis
Optional. Duration of the window interval for which these stats are aggregated, expressed in milliseconds.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasWindowMillis
clearWindowMillis
setWindowMillis
Optional. Duration of the window interval for which these stats are aggregated, expressed in milliseconds.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|