public static final class Storage.StreamStatus extends GeneratedMessageV3 implements Storage.StreamStatusOrBuilderProgress information for a given Stream.
Protobuf type google.cloud.bigquery.storage.v1beta1.StreamStatus
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Storage.StreamStatusImplements
Storage.StreamStatusOrBuilderStatic Fields
ESTIMATED_ROW_COUNT_FIELD_NUMBER
public static final int ESTIMATED_ROW_COUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FRACTION_CONSUMED_FIELD_NUMBER
public static final int FRACTION_CONSUMED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
IS_SPLITTABLE_FIELD_NUMBER
public static final int IS_SPLITTABLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROGRESS_FIELD_NUMBER
public static final int PROGRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Storage.StreamStatus getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Storage.StreamStatus.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus.Builder |
|
newBuilder(Storage.StreamStatus prototype)
public static Storage.StreamStatus.Builder newBuilder(Storage.StreamStatus prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Storage.StreamStatus |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus.Builder |
|
parseDelimitedFrom(InputStream input)
public static Storage.StreamStatus parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Storage.StreamStatus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Storage.StreamStatus parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Storage.StreamStatus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Storage.StreamStatus parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Storage.StreamStatus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Storage.StreamStatus parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Storage.StreamStatus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Storage.StreamStatus parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Storage.StreamStatus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Storage.StreamStatus parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Storage.StreamStatus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Storage.StreamStatus> parser()| Returns | |
|---|---|
| Type | Description |
Parser<StreamStatus> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public Storage.StreamStatus getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
getParserForType()
public Parser<Storage.StreamStatus> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<StreamStatus> |
|
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. |
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 |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Storage.StreamStatus.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Storage.StreamStatus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Storage.StreamStatus.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Storage.StreamStatus.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|