Class Storage.StreamStatus.Builder (3.5.2)

public static final class Storage.StreamStatus.Builder extends GeneratedMessageV3.Builder<Storage.StreamStatus.Builder> implements Storage.StreamStatusOrBuilder

Progress information for a given Stream.

Protobuf type google.cloud.bigquery.storage.v1beta1.StreamStatus

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Storage.StreamStatus.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

build()

public Storage.StreamStatus build()
Returns
Type Description
Storage.StreamStatus

buildPartial()

public Storage.StreamStatus buildPartial()
Returns
Type Description
Storage.StreamStatus

clear()

public Storage.StreamStatus.Builder clear()
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

clearEstimatedRowCount()

public Storage.StreamStatus.Builder clearEstimatedRowCount()

Number of estimated rows in the current stream. May change over time as different readers in the stream progress at rates which are relatively fast or slow.

int64 estimated_row_count = 1;

Returns
Type Description
Storage.StreamStatus.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Storage.StreamStatus.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

clearFractionConsumed()

public Storage.StreamStatus.Builder clearFractionConsumed()

A value in the range [0.0, 1.0] that represents the fraction of rows assigned to this stream that have been processed by the server. In the presence of read filters, the server may process more rows than it returns, so this value reflects progress through the pre-filtering rows.

This value is only populated for sessions created through the BALANCED sharding strategy.

float fraction_consumed = 2;

Returns
Type Description
Storage.StreamStatus.Builder

This builder for chaining.

clearIsSplittable()

public Storage.StreamStatus.Builder clearIsSplittable()

Whether this stream can be split. For sessions that use the LIQUID sharding strategy, this value is always false. For BALANCED sessions, this value is false when enough data have been read such that no more splits are possible at that point or beyond. For small tables or streams that are the result of a chain of splits, this value may never be true.

bool is_splittable = 3;

Returns
Type Description
Storage.StreamStatus.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Storage.StreamStatus.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

clearProgress()

public Storage.StreamStatus.Builder clearProgress()

Represents the progress of the current stream.

.google.cloud.bigquery.storage.v1beta1.Progress progress = 4;

Returns
Type Description
Storage.StreamStatus.Builder

clone()

public Storage.StreamStatus.Builder clone()
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

getDefaultInstanceForType()

public Storage.StreamStatus getDefaultInstanceForType()
Returns
Type Description
Storage.StreamStatus

getDescriptorForType()

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

getEstimatedRowCount()

public long getEstimatedRowCount()

Number of estimated rows in the current stream. May change over time as different readers in the stream progress at rates which are relatively fast or slow.

int64 estimated_row_count = 1;

Returns
Type Description
long

The estimatedRowCount.

getFractionConsumed()

public float getFractionConsumed()

A value in the range [0.0, 1.0] that represents the fraction of rows assigned to this stream that have been processed by the server. In the presence of read filters, the server may process more rows than it returns, so this value reflects progress through the pre-filtering rows.

This value is only populated for sessions created through the BALANCED sharding strategy.

float fraction_consumed = 2;

Returns
Type Description
float

The fractionConsumed.

getIsSplittable()

public boolean getIsSplittable()

Whether this stream can be split. For sessions that use the LIQUID sharding strategy, this value is always false. For BALANCED sessions, this value is false when enough data have been read such that no more splits are possible at that point or beyond. For small tables or streams that are the result of a chain of splits, this value may never be true.

bool is_splittable = 3;

Returns
Type Description
boolean

The isSplittable.

getProgress()

public Storage.Progress getProgress()

Represents the progress of the current stream.

.google.cloud.bigquery.storage.v1beta1.Progress progress = 4;

Returns
Type Description
Storage.Progress

The progress.

getProgressBuilder()

public Storage.Progress.Builder getProgressBuilder()

Represents the progress of the current stream.

.google.cloud.bigquery.storage.v1beta1.Progress progress = 4;

Returns
Type Description
Storage.Progress.Builder

getProgressOrBuilder()

public Storage.ProgressOrBuilder getProgressOrBuilder()

Represents the progress of the current stream.

.google.cloud.bigquery.storage.v1beta1.Progress progress = 4;

Returns
Type Description
Storage.ProgressOrBuilder

hasProgress()

public boolean hasProgress()

Represents the progress of the current stream.

.google.cloud.bigquery.storage.v1beta1.Progress progress = 4;

Returns
Type Description
boolean

Whether the progress field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Storage.StreamStatus other)

public Storage.StreamStatus.Builder mergeFrom(Storage.StreamStatus other)
Parameter
Name Description
other Storage.StreamStatus
Returns
Type Description
Storage.StreamStatus.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Storage.StreamStatus.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

mergeProgress(Storage.Progress value)

public Storage.StreamStatus.Builder mergeProgress(Storage.Progress value)

Represents the progress of the current stream.

.google.cloud.bigquery.storage.v1beta1.Progress progress = 4;

Parameter
Name Description
value Storage.Progress
Returns
Type Description
Storage.StreamStatus.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Storage.StreamStatus.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

setEstimatedRowCount(long value)

public Storage.StreamStatus.Builder setEstimatedRowCount(long value)

Number of estimated rows in the current stream. May change over time as different readers in the stream progress at rates which are relatively fast or slow.

int64 estimated_row_count = 1;

Parameter
Name Description
value long

The estimatedRowCount to set.

Returns
Type Description
Storage.StreamStatus.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Storage.StreamStatus.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

setFractionConsumed(float value)

public Storage.StreamStatus.Builder setFractionConsumed(float value)

A value in the range [0.0, 1.0] that represents the fraction of rows assigned to this stream that have been processed by the server. In the presence of read filters, the server may process more rows than it returns, so this value reflects progress through the pre-filtering rows.

This value is only populated for sessions created through the BALANCED sharding strategy.

float fraction_consumed = 2;

Parameter
Name Description
value float

The fractionConsumed to set.

Returns
Type Description
Storage.StreamStatus.Builder

This builder for chaining.

setIsSplittable(boolean value)

public Storage.StreamStatus.Builder setIsSplittable(boolean value)

Whether this stream can be split. For sessions that use the LIQUID sharding strategy, this value is always false. For BALANCED sessions, this value is false when enough data have been read such that no more splits are possible at that point or beyond. For small tables or streams that are the result of a chain of splits, this value may never be true.

bool is_splittable = 3;

Parameter
Name Description
value boolean

The isSplittable to set.

Returns
Type Description
Storage.StreamStatus.Builder

This builder for chaining.

setProgress(Storage.Progress value)

public Storage.StreamStatus.Builder setProgress(Storage.Progress value)

Represents the progress of the current stream.

.google.cloud.bigquery.storage.v1beta1.Progress progress = 4;

Parameter
Name Description
value Storage.Progress
Returns
Type Description
Storage.StreamStatus.Builder

setProgress(Storage.Progress.Builder builderForValue)

public Storage.StreamStatus.Builder setProgress(Storage.Progress.Builder builderForValue)

Represents the progress of the current stream.

.google.cloud.bigquery.storage.v1beta1.Progress progress = 4;

Parameter
Name Description
builderForValue Storage.Progress.Builder
Returns
Type Description
Storage.StreamStatus.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Storage.StreamStatus.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Storage.StreamStatus.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Storage.StreamStatus.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Storage.StreamStatus.Builder
Overrides