Package com.google.cloud.bigquery.storage.v1

Class ReadRowsResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.cloud.bigquery.storage.v1.ReadRowsResponse
All Implemented Interfaces:
ReadRowsResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ReadRowsResponse extends com.google.protobuf.GeneratedMessageV3 implements ReadRowsResponseOrBuilder
 Response from calling `ReadRows` may include row data, progress and
 throttling information.
Protobuf type google.cloud.bigquery.storage.v1.ReadRowsResponse
See Also:

  • Field Details

    • AVRO_ROWS_FIELD_NUMBER

      public static final int AVRO_ROWS_FIELD_NUMBER
      See Also:

    • ARROW_RECORD_BATCH_FIELD_NUMBER

      public static final int ARROW_RECORD_BATCH_FIELD_NUMBER
      See Also:

    • ROW_COUNT_FIELD_NUMBER

      public static final int ROW_COUNT_FIELD_NUMBER
      See Also:

    • STATS_FIELD_NUMBER

      public static final int STATS_FIELD_NUMBER
      See Also:

    • THROTTLE_STATE_FIELD_NUMBER

      public static final int THROTTLE_STATE_FIELD_NUMBER
      See Also:

    • AVRO_SCHEMA_FIELD_NUMBER

      public static final int AVRO_SCHEMA_FIELD_NUMBER
      See Also:

    • ARROW_SCHEMA_FIELD_NUMBER

      public static final int ARROW_SCHEMA_FIELD_NUMBER
      See Also:

    • UNCOMPRESSED_BYTE_SIZE_FIELD_NUMBER

      public static final int UNCOMPRESSED_BYTE_SIZE_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

    • getRowsCase

      public ReadRowsResponse.RowsCase getRowsCase()
      Specified by:
      getRowsCase in interface ReadRowsResponseOrBuilder

    • getSchemaCase

      public ReadRowsResponse.SchemaCase getSchemaCase()
      Specified by:
      getSchemaCase in interface ReadRowsResponseOrBuilder

    • hasAvroRows

      public boolean hasAvroRows()
       Serialized row data in AVRO format.
      .google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;
      Specified by:
      hasAvroRows in interface ReadRowsResponseOrBuilder
      Returns:
      Whether the avroRows field is set.

    • getAvroRows

      public AvroRows getAvroRows()
       Serialized row data in AVRO format.
      .google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;
      Specified by:
      getAvroRows in interface ReadRowsResponseOrBuilder
      Returns:
      The avroRows.

    • getAvroRowsOrBuilder

      public AvroRowsOrBuilder getAvroRowsOrBuilder()
       Serialized row data in AVRO format.
      .google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;
      Specified by:
      getAvroRowsOrBuilder in interface ReadRowsResponseOrBuilder

    • hasArrowRecordBatch

      public boolean hasArrowRecordBatch()
       Serialized row data in Arrow RecordBatch format.
      .google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;
      Specified by:
      hasArrowRecordBatch in interface ReadRowsResponseOrBuilder
      Returns:
      Whether the arrowRecordBatch field is set.

    • getArrowRecordBatch

      public ArrowRecordBatch getArrowRecordBatch()
       Serialized row data in Arrow RecordBatch format.
      .google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;
      Specified by:
      getArrowRecordBatch in interface ReadRowsResponseOrBuilder
      Returns:
      The arrowRecordBatch.

    • getArrowRecordBatchOrBuilder

      public ArrowRecordBatchOrBuilder getArrowRecordBatchOrBuilder()
       Serialized row data in Arrow RecordBatch format.
      .google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;
      Specified by:
      getArrowRecordBatchOrBuilder in interface ReadRowsResponseOrBuilder

    • getRowCount

      public long getRowCount()
       Number of serialized rows in the rows block.
      int64 row_count = 6;
      Specified by:
      getRowCount in interface ReadRowsResponseOrBuilder
      Returns:
      The rowCount.

    • hasStats

      public boolean hasStats()
       Statistics for the stream.
      .google.cloud.bigquery.storage.v1.StreamStats stats = 2;
      Specified by:
      hasStats in interface ReadRowsResponseOrBuilder
      Returns:
      Whether the stats field is set.

    • getStats

      public StreamStats getStats()
       Statistics for the stream.
      .google.cloud.bigquery.storage.v1.StreamStats stats = 2;
      Specified by:
      getStats in interface ReadRowsResponseOrBuilder
      Returns:
      The stats.

    • getStatsOrBuilder

      public StreamStatsOrBuilder getStatsOrBuilder()
       Statistics for the stream.
      .google.cloud.bigquery.storage.v1.StreamStats stats = 2;
      Specified by:
      getStatsOrBuilder in interface ReadRowsResponseOrBuilder

    • hasThrottleState

      public boolean hasThrottleState()
       Throttling state. If unset, the latest response still describes
 the current throttling status.
      .google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;
      Specified by:
      hasThrottleState in interface ReadRowsResponseOrBuilder
      Returns:
      Whether the throttleState field is set.

    • getThrottleState

      public ThrottleState getThrottleState()
       Throttling state. If unset, the latest response still describes
 the current throttling status.
      .google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;
      Specified by:
      getThrottleState in interface ReadRowsResponseOrBuilder
      Returns:
      The throttleState.

    • getThrottleStateOrBuilder

      public ThrottleStateOrBuilder getThrottleStateOrBuilder()
       Throttling state. If unset, the latest response still describes
 the current throttling status.
      .google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;
      Specified by:
      getThrottleStateOrBuilder in interface ReadRowsResponseOrBuilder

    • hasAvroSchema

      public boolean hasAvroSchema()
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasAvroSchema in interface ReadRowsResponseOrBuilder
      Returns:
      Whether the avroSchema field is set.

    • getAvroSchema

      public AvroSchema getAvroSchema()
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAvroSchema in interface ReadRowsResponseOrBuilder
      Returns:
      The avroSchema.

    • getAvroSchemaOrBuilder

      public AvroSchemaOrBuilder getAvroSchemaOrBuilder()
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAvroSchemaOrBuilder in interface ReadRowsResponseOrBuilder

    • hasArrowSchema

      public boolean hasArrowSchema()
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasArrowSchema in interface ReadRowsResponseOrBuilder
      Returns:
      Whether the arrowSchema field is set.

    • getArrowSchema

      public ArrowSchema getArrowSchema()
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getArrowSchema in interface ReadRowsResponseOrBuilder
      Returns:
      The arrowSchema.

    • getArrowSchemaOrBuilder

      public ArrowSchemaOrBuilder getArrowSchemaOrBuilder()
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getArrowSchemaOrBuilder in interface ReadRowsResponseOrBuilder

    • hasUncompressedByteSize

      public boolean hasUncompressedByteSize()
       Optional. If the row data in this ReadRowsResponse is compressed, then
 uncompressed byte size is the original size of the uncompressed row data.
 If it is set to a value greater than 0, then decompress into a buffer of
 size uncompressed_byte_size using the compression codec that was requested
 during session creation time and which is specified in
 TableReadOptions.response_compression_codec in ReadSession.
 This value is not set if no response_compression_codec was not requested
 and it is -1 if the requested compression would not have reduced the size
 of this ReadRowsResponse's row data. This attempts to match Apache Arrow's
 behavior described here https://github.com/apache/arrow/issues/15102 where
 the uncompressed length may be set to -1 to indicate that the data that
 follows is not compressed, which can be useful for cases where compression
 does not yield appreciable savings. When uncompressed_byte_size is not
 greater than 0, the client should skip decompression.
      optional int64 uncompressed_byte_size = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasUncompressedByteSize in interface ReadRowsResponseOrBuilder
      Returns:
      Whether the uncompressedByteSize field is set.

    • getUncompressedByteSize

      public long getUncompressedByteSize()
       Optional. If the row data in this ReadRowsResponse is compressed, then
 uncompressed byte size is the original size of the uncompressed row data.
 If it is set to a value greater than 0, then decompress into a buffer of
 size uncompressed_byte_size using the compression codec that was requested
 during session creation time and which is specified in
 TableReadOptions.response_compression_codec in ReadSession.
 This value is not set if no response_compression_codec was not requested
 and it is -1 if the requested compression would not have reduced the size
 of this ReadRowsResponse's row data. This attempts to match Apache Arrow's
 behavior described here https://github.com/apache/arrow/issues/15102 where
 the uncompressed length may be set to -1 to indicate that the data that
 follows is not compressed, which can be useful for cases where compression
 does not yield appreciable savings. When uncompressed_byte_size is not
 greater than 0, the client should skip decompression.
      optional int64 uncompressed_byte_size = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUncompressedByteSize in interface ReadRowsResponseOrBuilder
      Returns:
      The uncompressedByteSize.

    • 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 ReadRowsResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ReadRowsResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ReadRowsResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ReadRowsResponse.Builder newBuilder()

    • newBuilder

      public static ReadRowsResponse.Builder newBuilder(ReadRowsResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ReadRowsResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ReadRowsResponse> 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 ReadRowsResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder