Class ClientStats.WindowStats.Builder (3.35.0)

public static final class ClientStats.WindowStats.Builder extends GeneratedMessage.Builder<ClientStats.WindowStats.Builder> implements ClientStats.WindowStatsOrBuilder

Aggregate connection metrics over a window interval.

Protobuf type google.cloud.bigquery.storage.v1.ClientStats.WindowStats

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ClientStats.WindowStats build()
Returns
Type Description
ClientStats.WindowStats

buildPartial()

public ClientStats.WindowStats buildPartial()
Returns
Type Description
ClientStats.WindowStats

clear()

public ClientStats.WindowStats.Builder clear()
Returns
Type Description
ClientStats.WindowStats.Builder
Overrides

clearAvgResponseLatencyMillis()

public ClientStats.WindowStats.Builder clearAvgResponseLatencyMillis()

Optional. The average response latency observed in the window, expressed in milliseconds.

optional int64 avg_response_latency_millis = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

clearBytesSentCount()

public ClientStats.WindowStats.Builder clearBytesSentCount()

Optional. How many bytes were sent in the window.

optional int64 bytes_sent_count = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

clearLongestWaitNoResponseMillis()

public ClientStats.WindowStats.Builder clearLongestWaitNoResponseMillis()

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.

optional int64 longest_wait_no_response_millis = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

clearMaxResponseLatencyMillis()

public ClientStats.WindowStats.Builder clearMaxResponseLatencyMillis()

Optional. The maximum response latency observed in the window, expressed in milliseconds.

optional int64 max_response_latency_millis = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

clearRequestsSentCount()

public ClientStats.WindowStats.Builder clearRequestsSentCount()

Optional. How many requests were sent in the window.

optional int64 requests_sent_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

clearResponsesReceivedCount()

public ClientStats.WindowStats.Builder clearResponsesReceivedCount()

Optional. How many responses were received in the window.

optional int64 responses_received_count = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

clearWindowMillis()

public ClientStats.WindowStats.Builder clearWindowMillis()

Optional. Duration of the window interval for which these stats are aggregated, expressed in milliseconds.

optional int64 window_millis = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

clearWindowStartTimeEpochMillis()

public ClientStats.WindowStats.Builder clearWindowStartTimeEpochMillis()

Optional. Start time of the window interval for which these stats are aggregated, expressed in epoch milliseconds.

optional int64 window_start_time_epoch_millis = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

getAvgResponseLatencyMillis()

public long getAvgResponseLatencyMillis()

Optional. The average response latency observed in the window, expressed in milliseconds.

optional int64 avg_response_latency_millis = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The avgResponseLatencyMillis.

getBytesSentCount()

public long getBytesSentCount()

Optional. How many bytes were sent in the window.

optional int64 bytes_sent_count = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The bytesSentCount.

getDefaultInstanceForType()

public ClientStats.WindowStats getDefaultInstanceForType()
Returns
Type Description
ClientStats.WindowStats

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLongestWaitNoResponseMillis()

public long 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.

optional int64 longest_wait_no_response_millis = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The longestWaitNoResponseMillis.

getMaxResponseLatencyMillis()

public long getMaxResponseLatencyMillis()

Optional. The maximum response latency observed in the window, expressed in milliseconds.

optional int64 max_response_latency_millis = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The maxResponseLatencyMillis.

getRequestsSentCount()

public long getRequestsSentCount()

Optional. How many requests were sent in the window.

optional int64 requests_sent_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The requestsSentCount.

getResponsesReceivedCount()

public long getResponsesReceivedCount()

Optional. How many responses were received in the window.

optional int64 responses_received_count = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The responsesReceivedCount.

getWindowMillis()

public long getWindowMillis()

Optional. Duration of the window interval for which these stats are aggregated, expressed in milliseconds.

optional int64 window_millis = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The windowMillis.

getWindowStartTimeEpochMillis()

public long getWindowStartTimeEpochMillis()

Optional. Start time of the window interval for which these stats are aggregated, expressed in epoch milliseconds.

optional int64 window_start_time_epoch_millis = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The windowStartTimeEpochMillis.

hasAvgResponseLatencyMillis()

public boolean hasAvgResponseLatencyMillis()

Optional. The average response latency observed in the window, expressed in milliseconds.

optional int64 avg_response_latency_millis = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the avgResponseLatencyMillis field is set.

hasBytesSentCount()

public boolean hasBytesSentCount()

Optional. How many bytes were sent in the window.

optional int64 bytes_sent_count = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the bytesSentCount field is set.

hasLongestWaitNoResponseMillis()

public boolean hasLongestWaitNoResponseMillis()

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.

optional int64 longest_wait_no_response_millis = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the longestWaitNoResponseMillis field is set.

hasMaxResponseLatencyMillis()

public boolean hasMaxResponseLatencyMillis()

Optional. The maximum response latency observed in the window, expressed in milliseconds.

optional int64 max_response_latency_millis = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxResponseLatencyMillis field is set.

hasRequestsSentCount()

public boolean hasRequestsSentCount()

Optional. How many requests were sent in the window.

optional int64 requests_sent_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the requestsSentCount field is set.

hasResponsesReceivedCount()

public boolean hasResponsesReceivedCount()

Optional. How many responses were received in the window.

optional int64 responses_received_count = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the responsesReceivedCount field is set.

hasWindowMillis()

public boolean hasWindowMillis()

Optional. Duration of the window interval for which these stats are aggregated, expressed in milliseconds.

optional int64 window_millis = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the windowMillis field is set.

hasWindowStartTimeEpochMillis()

public boolean hasWindowStartTimeEpochMillis()

Optional. Start time of the window interval for which these stats are aggregated, expressed in epoch milliseconds.

optional int64 window_start_time_epoch_millis = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the windowStartTimeEpochMillis field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ClientStats.WindowStats other)

public ClientStats.WindowStats.Builder mergeFrom(ClientStats.WindowStats other)
Parameter
Name Description
other ClientStats.WindowStats
Returns
Type Description
ClientStats.WindowStats.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ClientStats.WindowStats.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClientStats.WindowStats.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ClientStats.WindowStats.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ClientStats.WindowStats.Builder
Overrides

setAvgResponseLatencyMillis(long value)

public ClientStats.WindowStats.Builder setAvgResponseLatencyMillis(long value)

Optional. The average response latency observed in the window, expressed in milliseconds.

optional int64 avg_response_latency_millis = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The avgResponseLatencyMillis to set.

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

setBytesSentCount(long value)

public ClientStats.WindowStats.Builder setBytesSentCount(long value)

Optional. How many bytes were sent in the window.

optional int64 bytes_sent_count = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The bytesSentCount to set.

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

setLongestWaitNoResponseMillis(long value)

public ClientStats.WindowStats.Builder setLongestWaitNoResponseMillis(long value)

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.

optional int64 longest_wait_no_response_millis = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The longestWaitNoResponseMillis to set.

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

setMaxResponseLatencyMillis(long value)

public ClientStats.WindowStats.Builder setMaxResponseLatencyMillis(long value)

Optional. The maximum response latency observed in the window, expressed in milliseconds.

optional int64 max_response_latency_millis = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The maxResponseLatencyMillis to set.

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

setRequestsSentCount(long value)

public ClientStats.WindowStats.Builder setRequestsSentCount(long value)

Optional. How many requests were sent in the window.

optional int64 requests_sent_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The requestsSentCount to set.

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

setResponsesReceivedCount(long value)

public ClientStats.WindowStats.Builder setResponsesReceivedCount(long value)

Optional. How many responses were received in the window.

optional int64 responses_received_count = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The responsesReceivedCount to set.

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

setWindowMillis(long value)

public ClientStats.WindowStats.Builder setWindowMillis(long value)

Optional. Duration of the window interval for which these stats are aggregated, expressed in milliseconds.

optional int64 window_millis = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The windowMillis to set.

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.

setWindowStartTimeEpochMillis(long value)

public ClientStats.WindowStats.Builder setWindowStartTimeEpochMillis(long value)

Optional. Start time of the window interval for which these stats are aggregated, expressed in epoch milliseconds.

optional int64 window_start_time_epoch_millis = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The windowStartTimeEpochMillis to set.

Returns
Type Description
ClientStats.WindowStats.Builder

This builder for chaining.