Class 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:
    Serialized Form
    • Field Detail

      • ESTIMATED_ROW_COUNT_FIELD_NUMBER

        public static final int ESTIMATED_ROW_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FRACTION_CONSUMED_FIELD_NUMBER

        public static final int FRACTION_CONSUMED_FIELD_NUMBER
        See Also:
        Constant Field Values
      • IS_SPLITTABLE_FIELD_NUMBER

        public static final int IS_SPLITTABLE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • 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.
      • 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
      • newBuilderForType

        public Storage.StreamStatus.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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
      • 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