Class ReadRowsResponse.Builder (3.8.0)

public static final class ReadRowsResponse.Builder extends GeneratedMessageV3.Builder<ReadRowsResponse.Builder> implements ReadRowsResponseOrBuilder

Response from calling ReadRows may include row data, progress and throttling information.

Protobuf type google.cloud.bigquery.storage.v1.ReadRowsResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadRowsResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReadRowsResponse.Builder
Overrides

build()

public ReadRowsResponse build()
Returns
Type Description
ReadRowsResponse

buildPartial()

public ReadRowsResponse buildPartial()
Returns
Type Description
ReadRowsResponse

clear()

public ReadRowsResponse.Builder clear()
Returns
Type Description
ReadRowsResponse.Builder
Overrides

clearArrowRecordBatch()

public ReadRowsResponse.Builder clearArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Returns
Type Description
ReadRowsResponse.Builder

clearArrowSchema()

public ReadRowsResponse.Builder clearArrowSchema()

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReadRowsResponse.Builder

clearAvroRows()

public ReadRowsResponse.Builder clearAvroRows()

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Returns
Type Description
ReadRowsResponse.Builder

clearAvroSchema()

public ReadRowsResponse.Builder clearAvroSchema()

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReadRowsResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ReadRowsResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ReadRowsResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadRowsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ReadRowsResponse.Builder
Overrides

clearRowCount()

public ReadRowsResponse.Builder clearRowCount()

Number of serialized rows in the rows block.

int64 row_count = 6;

Returns
Type Description
ReadRowsResponse.Builder

This builder for chaining.

clearRows()

public ReadRowsResponse.Builder clearRows()
Returns
Type Description
ReadRowsResponse.Builder

clearSchema()

public ReadRowsResponse.Builder clearSchema()
Returns
Type Description
ReadRowsResponse.Builder

clearStats()

public ReadRowsResponse.Builder clearStats()

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Returns
Type Description
ReadRowsResponse.Builder

clearThrottleState()

public ReadRowsResponse.Builder clearThrottleState()

Throttling state. If unset, the latest response still describes the current throttling status.

.google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;

Returns
Type Description
ReadRowsResponse.Builder

clearUncompressedByteSize()

public ReadRowsResponse.Builder clearUncompressedByteSize()

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
Type Description
ReadRowsResponse.Builder

This builder for chaining.

clone()

public ReadRowsResponse.Builder clone()
Returns
Type Description
ReadRowsResponse.Builder
Overrides

getArrowRecordBatch()

public ArrowRecordBatch getArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Returns
Type Description
ArrowRecordBatch

The arrowRecordBatch.

getArrowRecordBatchBuilder()

public ArrowRecordBatch.Builder getArrowRecordBatchBuilder()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Returns
Type Description
ArrowRecordBatch.Builder

getArrowRecordBatchOrBuilder()

public ArrowRecordBatchOrBuilder getArrowRecordBatchOrBuilder()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Returns
Type Description
ArrowRecordBatchOrBuilder

getArrowSchema()

public ArrowSchema getArrowSchema()

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ArrowSchema

The arrowSchema.

getArrowSchemaBuilder()

public ArrowSchema.Builder getArrowSchemaBuilder()

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ArrowSchema.Builder

getArrowSchemaOrBuilder()

public ArrowSchemaOrBuilder getArrowSchemaOrBuilder()

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ArrowSchemaOrBuilder

getAvroRows()

public AvroRows getAvroRows()

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Returns
Type Description
AvroRows

The avroRows.

getAvroRowsBuilder()

public AvroRows.Builder getAvroRowsBuilder()

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Returns
Type Description
AvroRows.Builder

getAvroRowsOrBuilder()

public AvroRowsOrBuilder getAvroRowsOrBuilder()

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Returns
Type Description
AvroRowsOrBuilder

getAvroSchema()

public AvroSchema getAvroSchema()

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AvroSchema

The avroSchema.

getAvroSchemaBuilder()

public AvroSchema.Builder getAvroSchemaBuilder()

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AvroSchema.Builder

getAvroSchemaOrBuilder()

public AvroSchemaOrBuilder getAvroSchemaOrBuilder()

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AvroSchemaOrBuilder

getDefaultInstanceForType()

public ReadRowsResponse getDefaultInstanceForType()
Returns
Type Description
ReadRowsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getRowCount()

public long getRowCount()

Number of serialized rows in the rows block.

int64 row_count = 6;

Returns
Type Description
long

The rowCount.

getRowsCase()

public ReadRowsResponse.RowsCase getRowsCase()
Returns
Type Description
ReadRowsResponse.RowsCase

getSchemaCase()

public ReadRowsResponse.SchemaCase getSchemaCase()
Returns
Type Description
ReadRowsResponse.SchemaCase

getStats()

public StreamStats getStats()

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Returns
Type Description
StreamStats

The stats.

getStatsBuilder()

public StreamStats.Builder getStatsBuilder()

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Returns
Type Description
StreamStats.Builder

getStatsOrBuilder()

public StreamStatsOrBuilder getStatsOrBuilder()

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Returns
Type Description
StreamStatsOrBuilder

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;

Returns
Type Description
ThrottleState

The throttleState.

getThrottleStateBuilder()

public ThrottleState.Builder getThrottleStateBuilder()

Throttling state. If unset, the latest response still describes the current throttling status.

.google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;

Returns
Type Description
ThrottleState.Builder

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;

Returns
Type Description
ThrottleStateOrBuilder

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];

Returns
Type Description
long

The uncompressedByteSize.

hasArrowRecordBatch()

public boolean hasArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Returns
Type Description
boolean

Whether the arrowRecordBatch field is set.

hasArrowSchema()

public boolean hasArrowSchema()

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the arrowSchema field is set.

hasAvroRows()

public boolean hasAvroRows()

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Returns
Type Description
boolean

Whether the avroRows field is set.

hasAvroSchema()

public boolean hasAvroSchema()

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the avroSchema field is set.

hasStats()

public boolean hasStats()

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Returns
Type Description
boolean

Whether the stats field is set.

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;

Returns
Type Description
boolean

Whether the throttleState field is set.

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];

Returns
Type Description
boolean

Whether the uncompressedByteSize field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeArrowRecordBatch(ArrowRecordBatch value)

public ReadRowsResponse.Builder mergeArrowRecordBatch(ArrowRecordBatch value)

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Parameter
Name Description
value ArrowRecordBatch
Returns
Type Description
ReadRowsResponse.Builder

mergeArrowSchema(ArrowSchema value)

public ReadRowsResponse.Builder mergeArrowSchema(ArrowSchema value)

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ArrowSchema
Returns
Type Description
ReadRowsResponse.Builder

mergeAvroRows(AvroRows value)

public ReadRowsResponse.Builder mergeAvroRows(AvroRows value)

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Parameter
Name Description
value AvroRows
Returns
Type Description
ReadRowsResponse.Builder

mergeAvroSchema(AvroSchema value)

public ReadRowsResponse.Builder mergeAvroSchema(AvroSchema value)

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value AvroSchema
Returns
Type Description
ReadRowsResponse.Builder

mergeFrom(ReadRowsResponse other)

public ReadRowsResponse.Builder mergeFrom(ReadRowsResponse other)
Parameter
Name Description
other ReadRowsResponse
Returns
Type Description
ReadRowsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadRowsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadRowsResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ReadRowsResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ReadRowsResponse.Builder
Overrides

mergeStats(StreamStats value)

public ReadRowsResponse.Builder mergeStats(StreamStats value)

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Parameter
Name Description
value StreamStats
Returns
Type Description
ReadRowsResponse.Builder

mergeThrottleState(ThrottleState value)

public ReadRowsResponse.Builder mergeThrottleState(ThrottleState value)

Throttling state. If unset, the latest response still describes the current throttling status.

.google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;

Parameter
Name Description
value ThrottleState
Returns
Type Description
ReadRowsResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadRowsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReadRowsResponse.Builder
Overrides

setArrowRecordBatch(ArrowRecordBatch value)

public ReadRowsResponse.Builder setArrowRecordBatch(ArrowRecordBatch value)

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Parameter
Name Description
value ArrowRecordBatch
Returns
Type Description
ReadRowsResponse.Builder

setArrowRecordBatch(ArrowRecordBatch.Builder builderForValue)

public ReadRowsResponse.Builder setArrowRecordBatch(ArrowRecordBatch.Builder builderForValue)

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Parameter
Name Description
builderForValue ArrowRecordBatch.Builder
Returns
Type Description
ReadRowsResponse.Builder

setArrowSchema(ArrowSchema value)

public ReadRowsResponse.Builder setArrowSchema(ArrowSchema value)

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ArrowSchema
Returns
Type Description
ReadRowsResponse.Builder

setArrowSchema(ArrowSchema.Builder builderForValue)

public ReadRowsResponse.Builder setArrowSchema(ArrowSchema.Builder builderForValue)

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ArrowSchema.Builder
Returns
Type Description
ReadRowsResponse.Builder

setAvroRows(AvroRows value)

public ReadRowsResponse.Builder setAvroRows(AvroRows value)

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Parameter
Name Description
value AvroRows
Returns
Type Description
ReadRowsResponse.Builder

setAvroRows(AvroRows.Builder builderForValue)

public ReadRowsResponse.Builder setAvroRows(AvroRows.Builder builderForValue)

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Parameter
Name Description
builderForValue AvroRows.Builder
Returns
Type Description
ReadRowsResponse.Builder

setAvroSchema(AvroSchema value)

public ReadRowsResponse.Builder setAvroSchema(AvroSchema value)

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value AvroSchema
Returns
Type Description
ReadRowsResponse.Builder

setAvroSchema(AvroSchema.Builder builderForValue)

public ReadRowsResponse.Builder setAvroSchema(AvroSchema.Builder builderForValue)

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue AvroSchema.Builder
Returns
Type Description
ReadRowsResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ReadRowsResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReadRowsResponse.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReadRowsResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReadRowsResponse.Builder
Overrides

setRowCount(long value)

public ReadRowsResponse.Builder setRowCount(long value)

Number of serialized rows in the rows block.

int64 row_count = 6;

Parameter
Name Description
value long

The rowCount to set.

Returns
Type Description
ReadRowsResponse.Builder

This builder for chaining.

setStats(StreamStats value)

public ReadRowsResponse.Builder setStats(StreamStats value)

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Parameter
Name Description
value StreamStats
Returns
Type Description
ReadRowsResponse.Builder

setStats(StreamStats.Builder builderForValue)

public ReadRowsResponse.Builder setStats(StreamStats.Builder builderForValue)

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Parameter
Name Description
builderForValue StreamStats.Builder
Returns
Type Description
ReadRowsResponse.Builder

setThrottleState(ThrottleState value)

public ReadRowsResponse.Builder setThrottleState(ThrottleState value)

Throttling state. If unset, the latest response still describes the current throttling status.

.google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;

Parameter
Name Description
value ThrottleState
Returns
Type Description
ReadRowsResponse.Builder

setThrottleState(ThrottleState.Builder builderForValue)

public ReadRowsResponse.Builder setThrottleState(ThrottleState.Builder builderForValue)

Throttling state. If unset, the latest response still describes the current throttling status.

.google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;

Parameter
Name Description
builderForValue ThrottleState.Builder
Returns
Type Description
ReadRowsResponse.Builder

setUncompressedByteSize(long value)

public ReadRowsResponse.Builder setUncompressedByteSize(long value)

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];

Parameter
Name Description
value long

The uncompressedByteSize to set.

Returns
Type Description
ReadRowsResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadRowsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReadRowsResponse.Builder
Overrides