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

Interface ReadRowsResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReadRowsResponse, ReadRowsResponse.Builder
public interface ReadRowsResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasAvroRows

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

    • getAvroRows

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

    • getAvroRowsOrBuilder

      AvroRowsOrBuilder getAvroRowsOrBuilder()
       Serialized row data in AVRO format.
      .google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

    • hasArrowRecordBatch

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

    • getArrowRecordBatch

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

    • getArrowRecordBatchOrBuilder

      ArrowRecordBatchOrBuilder getArrowRecordBatchOrBuilder()
       Serialized row data in Arrow RecordBatch format.
      .google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

    • getRowCount

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

    • hasStats

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

    • getStats

      StreamStats getStats()
       Statistics for the stream.
      .google.cloud.bigquery.storage.v1.StreamStats stats = 2;
      Returns:
      The stats.

    • getStatsOrBuilder

      StreamStatsOrBuilder getStatsOrBuilder()
       Statistics for the stream.
      .google.cloud.bigquery.storage.v1.StreamStats stats = 2;

    • hasThrottleState

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

    • getThrottleState

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

    • getThrottleStateOrBuilder

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

    • hasAvroSchema

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

    • getAvroSchema

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

    • getAvroSchemaOrBuilder

      AvroSchemaOrBuilder getAvroSchemaOrBuilder()
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasArrowSchema

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

    • getArrowSchema

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

    • getArrowSchemaOrBuilder

      ArrowSchemaOrBuilder getArrowSchemaOrBuilder()
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUncompressedByteSize

      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];
      Returns:
      Whether the uncompressedByteSize field is set.

    • getUncompressedByteSize

      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];
      Returns:
      The uncompressedByteSize.

    • getRowsCase

      ReadRowsResponse.RowsCase getRowsCase()

    • getSchemaCase

      ReadRowsResponse.SchemaCase getSchemaCase()