Package com.google.cloud.bigquery.storage.v1beta1

Class Storage.StreamStatus

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamStatus
All Implemented Interfaces:
Storage.StreamStatusOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Storage
public static final class Storage.StreamStatus extends com.google.protobuf.GeneratedMessageV3 implements Storage.StreamStatusOrBuilder
 Progress information for a given Stream.
Protobuf type google.cloud.bigquery.storage.v1beta1.StreamStatus
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Storage.StreamStatus.Builder
    Progress information for a given Stream.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ESTIMATED_ROW_COUNT_FIELD_NUMBER
     
    static final int
    FRACTION_CONSUMED_FIELD_NUMBER
     
    static final int
    IS_SPLITTABLE_FIELD_NUMBER
     
    static final int
    PROGRESS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Storage.StreamStatus
    getDefaultInstance()
     
    Storage.StreamStatus
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getEstimatedRowCount()
    Number of estimated rows in the current stream.
    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.
    boolean
    getIsSplittable()
    Whether this stream can be split.
    com.google.protobuf.Parser<Storage.StreamStatus>
    getParserForType()
     
    Storage.Progress
    getProgress()
    Represents the progress of the current stream.
    Storage.ProgressOrBuilder
    getProgressOrBuilder()
    Represents the progress of the current stream.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasProgress()
    Represents the progress of the current stream.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Storage.StreamStatus.Builder
    newBuilder()
     
    static Storage.StreamStatus.Builder
    newBuilder(Storage.StreamStatus prototype)
     
    Storage.StreamStatus.Builder
    newBuilderForType()
     
    protected Storage.StreamStatus.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Storage.StreamStatus
    parseDelimitedFrom(InputStream input)
     
    static Storage.StreamStatus
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Storage.StreamStatus
    parseFrom(byte[] data)
     
    static Storage.StreamStatus
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Storage.StreamStatus
    parseFrom(com.google.protobuf.ByteString data)
     
    static Storage.StreamStatus
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Storage.StreamStatus
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Storage.StreamStatus
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Storage.StreamStatus
    parseFrom(InputStream input)
     
    static Storage.StreamStatus
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Storage.StreamStatus
    parseFrom(ByteBuffer data)
     
    static Storage.StreamStatus
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Storage.StreamStatus>
    parser()
     
    Storage.StreamStatus.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • ESTIMATED_ROW_COUNT_FIELD_NUMBER

      public static final int ESTIMATED_ROW_COUNT_FIELD_NUMBER
      See Also:

    • FRACTION_CONSUMED_FIELD_NUMBER

      public static final int FRACTION_CONSUMED_FIELD_NUMBER
      See Also:

    • PROGRESS_FIELD_NUMBER

      public static final int PROGRESS_FIELD_NUMBER
      See Also:

    • IS_SPLITTABLE_FIELD_NUMBER

      public static final int IS_SPLITTABLE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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;
      Specified by:
      getEstimatedRowCount in interface Storage.StreamStatusOrBuilder
      Returns:
      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;
      Specified by:
      getFractionConsumed in interface Storage.StreamStatusOrBuilder
      Returns:
      The fractionConsumed.

    • hasProgress

      public boolean hasProgress()
       Represents the progress of the current stream.
      .google.cloud.bigquery.storage.v1beta1.Progress progress = 4;
      Specified by:
      hasProgress in interface Storage.StreamStatusOrBuilder
      Returns:
      Whether the progress field is set.

    • getProgress

      public Storage.Progress getProgress()
       Represents the progress of the current stream.
      .google.cloud.bigquery.storage.v1beta1.Progress progress = 4;
      Specified by:
      getProgress in interface Storage.StreamStatusOrBuilder
      Returns:
      The progress.

    • getProgressOrBuilder

      public Storage.ProgressOrBuilder getProgressOrBuilder()
       Represents the progress of the current stream.
      .google.cloud.bigquery.storage.v1beta1.Progress progress = 4;
      Specified by:
      getProgressOrBuilder in interface Storage.StreamStatusOrBuilder

    • 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;
      Specified by:
      getIsSplittable in interface Storage.StreamStatusOrBuilder
      Returns:
      The isSplittable.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Storage.StreamStatus parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.StreamStatus parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.StreamStatus parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.StreamStatus parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.StreamStatus parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.StreamStatus parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.StreamStatus parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Storage.StreamStatus parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Storage.StreamStatus parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Storage.StreamStatus parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Storage.StreamStatus parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Storage.StreamStatus parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Storage.StreamStatus.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Storage.StreamStatus.Builder newBuilder()

    • newBuilder

      public static Storage.StreamStatus.Builder newBuilder(Storage.StreamStatus prototype)

    • toBuilder

      public Storage.StreamStatus.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Storage.StreamStatus.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Storage.StreamStatus getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Storage.StreamStatus> parser()

    • getParserForType

      public com.google.protobuf.Parser<Storage.StreamStatus> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Storage.StreamStatus getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder