Class Storage.StreamStatus (3.1.0)

public static final class Storage.StreamStatus extends GeneratedMessageV3 implements Storage.StreamStatusOrBuilder

Progress information for a given Stream.

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

Static Fields

ESTIMATED_ROW_COUNT_FIELD_NUMBER

public static final int ESTIMATED_ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

FRACTION_CONSUMED_FIELD_NUMBER

public static final int FRACTION_CONSUMED_FIELD_NUMBER
Field Value
TypeDescription
int

IS_SPLITTABLE_FIELD_NUMBER

public static final int IS_SPLITTABLE_FIELD_NUMBER
Field Value
TypeDescription
int

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Storage.StreamStatus getDefaultInstance()
Returns
TypeDescription
Storage.StreamStatus

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Storage.StreamStatus.Builder newBuilder()
Returns
TypeDescription
Storage.StreamStatus.Builder

newBuilder(Storage.StreamStatus prototype)

public static Storage.StreamStatus.Builder newBuilder(Storage.StreamStatus prototype)
Parameter
NameDescription
prototypeStorage.StreamStatus
Returns
TypeDescription
Storage.StreamStatus.Builder

parseDelimitedFrom(InputStream input)

public static Storage.StreamStatus parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.StreamStatus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Storage.StreamStatus parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Storage.StreamStatus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Storage.StreamStatus parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Storage.StreamStatus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Storage.StreamStatus parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.StreamStatus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Storage.StreamStatus parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.StreamStatus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Storage.StreamStatus parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Storage.StreamStatus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Storage.StreamStatus
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Storage.StreamStatus> parser()
Returns
TypeDescription
Parser<StreamStatus>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Storage.StreamStatus getDefaultInstanceForType()
Returns
TypeDescription
Storage.StreamStatus

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The isSplittable.

getParserForType()

public Parser<Storage.StreamStatus> getParserForType()
Returns
TypeDescription
Parser<StreamStatus>
Overrides

getProgress()

public Storage.Progress getProgress()

Represents the progress of the current stream.

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

Returns
TypeDescription
Storage.Progress

The progress.

getProgressOrBuilder()

public Storage.ProgressOrBuilder getProgressOrBuilder()

Represents the progress of the current stream.

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

Returns
TypeDescription
Storage.ProgressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasProgress()

public boolean hasProgress()

Represents the progress of the current stream.

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

Returns
TypeDescription
boolean

Whether the progress field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Storage.StreamStatus.Builder newBuilderForType()
Returns
TypeDescription
Storage.StreamStatus.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Storage.StreamStatus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Storage.StreamStatus.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Storage.StreamStatus.Builder toBuilder()
Returns
TypeDescription
Storage.StreamStatus.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException