Class Storage.ReadRowsResponse.Builder (3.9.1)

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

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

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Storage.ReadRowsResponse build()
Returns
Type Description
Storage.ReadRowsResponse

buildPartial()

public Storage.ReadRowsResponse buildPartial()
Returns
Type Description
Storage.ReadRowsResponse

clear()

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

clearArrowRecordBatch()

public Storage.ReadRowsResponse.Builder clearArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

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

Returns
Type Description
Storage.ReadRowsResponse.Builder

clearArrowSchema()

public Storage.ReadRowsResponse.Builder clearArrowSchema()

Output only. Arrow schema.

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

Returns
Type Description
Storage.ReadRowsResponse.Builder

clearAvroRows()

public Storage.ReadRowsResponse.Builder clearAvroRows()

Serialized row data in AVRO format.

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

Returns
Type Description
Storage.ReadRowsResponse.Builder

clearAvroSchema()

public Storage.ReadRowsResponse.Builder clearAvroSchema()

Output only. Avro schema.

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

Returns
Type Description
Storage.ReadRowsResponse.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRowCount()

public Storage.ReadRowsResponse.Builder clearRowCount()

Number of serialized rows in the rows block. This value is recorded here, in addition to the row_count values in the output-specific messages in rows, so that code which needs to record progress through the stream can do so in an output format-independent way.

int64 row_count = 6;

Returns
Type Description
Storage.ReadRowsResponse.Builder

This builder for chaining.

clearRows()

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

clearSchema()

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

clearStatus()

public Storage.ReadRowsResponse.Builder clearStatus()

Estimated stream statistics.

.google.cloud.bigquery.storage.v1beta1.StreamStatus status = 2;

Returns
Type Description
Storage.ReadRowsResponse.Builder

clearThrottleStatus()

public Storage.ReadRowsResponse.Builder clearThrottleStatus()

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

.google.cloud.bigquery.storage.v1beta1.ThrottleStatus throttle_status = 5;

Returns
Type Description
Storage.ReadRowsResponse.Builder

clone()

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

getArrowRecordBatch()

public ArrowProto.ArrowRecordBatch getArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

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

Returns
Type Description
ArrowProto.ArrowRecordBatch

The arrowRecordBatch.

getArrowRecordBatchBuilder()

public ArrowProto.ArrowRecordBatch.Builder getArrowRecordBatchBuilder()

Serialized row data in Arrow RecordBatch format.

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

Returns
Type Description
ArrowProto.ArrowRecordBatch.Builder

getArrowRecordBatchOrBuilder()

public ArrowProto.ArrowRecordBatchOrBuilder getArrowRecordBatchOrBuilder()

Serialized row data in Arrow RecordBatch format.

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

Returns
Type Description
ArrowProto.ArrowRecordBatchOrBuilder

getArrowSchema()

public ArrowProto.ArrowSchema getArrowSchema()

Output only. Arrow schema.

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

Returns
Type Description
ArrowProto.ArrowSchema

The arrowSchema.

getArrowSchemaBuilder()

public ArrowProto.ArrowSchema.Builder getArrowSchemaBuilder()

Output only. Arrow schema.

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

Returns
Type Description
ArrowProto.ArrowSchema.Builder

getArrowSchemaOrBuilder()

public ArrowProto.ArrowSchemaOrBuilder getArrowSchemaOrBuilder()

Output only. Arrow schema.

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

Returns
Type Description
ArrowProto.ArrowSchemaOrBuilder

getAvroRows()

public AvroProto.AvroRows getAvroRows()

Serialized row data in AVRO format.

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

Returns
Type Description
AvroProto.AvroRows

The avroRows.

getAvroRowsBuilder()

public AvroProto.AvroRows.Builder getAvroRowsBuilder()

Serialized row data in AVRO format.

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

Returns
Type Description
AvroProto.AvroRows.Builder

getAvroRowsOrBuilder()

public AvroProto.AvroRowsOrBuilder getAvroRowsOrBuilder()

Serialized row data in AVRO format.

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

Returns
Type Description
AvroProto.AvroRowsOrBuilder

getAvroSchema()

public AvroProto.AvroSchema getAvroSchema()

Output only. Avro schema.

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

Returns
Type Description
AvroProto.AvroSchema

The avroSchema.

getAvroSchemaBuilder()

public AvroProto.AvroSchema.Builder getAvroSchemaBuilder()

Output only. Avro schema.

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

Returns
Type Description
AvroProto.AvroSchema.Builder

getAvroSchemaOrBuilder()

public AvroProto.AvroSchemaOrBuilder getAvroSchemaOrBuilder()

Output only. Avro schema.

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

Returns
Type Description
AvroProto.AvroSchemaOrBuilder

getDefaultInstanceForType()

public Storage.ReadRowsResponse getDefaultInstanceForType()
Returns
Type Description
Storage.ReadRowsResponse

getDescriptorForType()

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

getRowCount()

public long getRowCount()

Number of serialized rows in the rows block. This value is recorded here, in addition to the row_count values in the output-specific messages in rows, so that code which needs to record progress through the stream can do so in an output format-independent way.

int64 row_count = 6;

Returns
Type Description
long

The rowCount.

getRowsCase()

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

getSchemaCase()

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

getStatus()

public Storage.StreamStatus getStatus()

Estimated stream statistics.

.google.cloud.bigquery.storage.v1beta1.StreamStatus status = 2;

Returns
Type Description
Storage.StreamStatus

The status.

getStatusBuilder()

public Storage.StreamStatus.Builder getStatusBuilder()

Estimated stream statistics.

.google.cloud.bigquery.storage.v1beta1.StreamStatus status = 2;

Returns
Type Description
Storage.StreamStatus.Builder

getStatusOrBuilder()

public Storage.StreamStatusOrBuilder getStatusOrBuilder()

Estimated stream statistics.

.google.cloud.bigquery.storage.v1beta1.StreamStatus status = 2;

Returns
Type Description
Storage.StreamStatusOrBuilder

getThrottleStatus()

public Storage.ThrottleStatus getThrottleStatus()

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

.google.cloud.bigquery.storage.v1beta1.ThrottleStatus throttle_status = 5;

Returns
Type Description
Storage.ThrottleStatus

The throttleStatus.

getThrottleStatusBuilder()

public Storage.ThrottleStatus.Builder getThrottleStatusBuilder()

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

.google.cloud.bigquery.storage.v1beta1.ThrottleStatus throttle_status = 5;

Returns
Type Description
Storage.ThrottleStatus.Builder

getThrottleStatusOrBuilder()

public Storage.ThrottleStatusOrBuilder getThrottleStatusOrBuilder()

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

.google.cloud.bigquery.storage.v1beta1.ThrottleStatus throttle_status = 5;

Returns
Type Description
Storage.ThrottleStatusOrBuilder

hasArrowRecordBatch()

public boolean hasArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the avroSchema field is set.

hasStatus()

public boolean hasStatus()

Estimated stream statistics.

.google.cloud.bigquery.storage.v1beta1.StreamStatus status = 2;

Returns
Type Description
boolean

Whether the status field is set.

hasThrottleStatus()

public boolean hasThrottleStatus()

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

.google.cloud.bigquery.storage.v1beta1.ThrottleStatus throttle_status = 5;

Returns
Type Description
boolean

Whether the throttleStatus field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeArrowRecordBatch(ArrowProto.ArrowRecordBatch value)

public Storage.ReadRowsResponse.Builder mergeArrowRecordBatch(ArrowProto.ArrowRecordBatch value)

Serialized row data in Arrow RecordBatch format.

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

Parameter
Name Description
value ArrowProto.ArrowRecordBatch
Returns
Type Description
Storage.ReadRowsResponse.Builder

mergeArrowSchema(ArrowProto.ArrowSchema value)

public Storage.ReadRowsResponse.Builder mergeArrowSchema(ArrowProto.ArrowSchema value)

Output only. Arrow schema.

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

Parameter
Name Description
value ArrowProto.ArrowSchema
Returns
Type Description
Storage.ReadRowsResponse.Builder

mergeAvroRows(AvroProto.AvroRows value)

public Storage.ReadRowsResponse.Builder mergeAvroRows(AvroProto.AvroRows value)

Serialized row data in AVRO format.

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

Parameter
Name Description
value AvroProto.AvroRows
Returns
Type Description
Storage.ReadRowsResponse.Builder

mergeAvroSchema(AvroProto.AvroSchema value)

public Storage.ReadRowsResponse.Builder mergeAvroSchema(AvroProto.AvroSchema value)

Output only. Avro schema.

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

Parameter
Name Description
value AvroProto.AvroSchema
Returns
Type Description
Storage.ReadRowsResponse.Builder

mergeFrom(Storage.ReadRowsResponse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeStatus(Storage.StreamStatus value)

public Storage.ReadRowsResponse.Builder mergeStatus(Storage.StreamStatus value)

Estimated stream statistics.

.google.cloud.bigquery.storage.v1beta1.StreamStatus status = 2;

Parameter
Name Description
value Storage.StreamStatus
Returns
Type Description
Storage.ReadRowsResponse.Builder

mergeThrottleStatus(Storage.ThrottleStatus value)

public Storage.ReadRowsResponse.Builder mergeThrottleStatus(Storage.ThrottleStatus value)

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

.google.cloud.bigquery.storage.v1beta1.ThrottleStatus throttle_status = 5;

Parameter
Name Description
value Storage.ThrottleStatus
Returns
Type Description
Storage.ReadRowsResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setArrowRecordBatch(ArrowProto.ArrowRecordBatch value)

public Storage.ReadRowsResponse.Builder setArrowRecordBatch(ArrowProto.ArrowRecordBatch value)

Serialized row data in Arrow RecordBatch format.

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

Parameter
Name Description
value ArrowProto.ArrowRecordBatch
Returns
Type Description
Storage.ReadRowsResponse.Builder

setArrowRecordBatch(ArrowProto.ArrowRecordBatch.Builder builderForValue)

public Storage.ReadRowsResponse.Builder setArrowRecordBatch(ArrowProto.ArrowRecordBatch.Builder builderForValue)

Serialized row data in Arrow RecordBatch format.

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

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

setArrowSchema(ArrowProto.ArrowSchema value)

public Storage.ReadRowsResponse.Builder setArrowSchema(ArrowProto.ArrowSchema value)

Output only. Arrow schema.

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

Parameter
Name Description
value ArrowProto.ArrowSchema
Returns
Type Description
Storage.ReadRowsResponse.Builder

setArrowSchema(ArrowProto.ArrowSchema.Builder builderForValue)

public Storage.ReadRowsResponse.Builder setArrowSchema(ArrowProto.ArrowSchema.Builder builderForValue)

Output only. Arrow schema.

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

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

setAvroRows(AvroProto.AvroRows value)

public Storage.ReadRowsResponse.Builder setAvroRows(AvroProto.AvroRows value)

Serialized row data in AVRO format.

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

Parameter
Name Description
value AvroProto.AvroRows
Returns
Type Description
Storage.ReadRowsResponse.Builder

setAvroRows(AvroProto.AvroRows.Builder builderForValue)

public Storage.ReadRowsResponse.Builder setAvroRows(AvroProto.AvroRows.Builder builderForValue)

Serialized row data in AVRO format.

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

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

setAvroSchema(AvroProto.AvroSchema value)

public Storage.ReadRowsResponse.Builder setAvroSchema(AvroProto.AvroSchema value)

Output only. Avro schema.

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

Parameter
Name Description
value AvroProto.AvroSchema
Returns
Type Description
Storage.ReadRowsResponse.Builder

setAvroSchema(AvroProto.AvroSchema.Builder builderForValue)

public Storage.ReadRowsResponse.Builder setAvroSchema(AvroProto.AvroSchema.Builder builderForValue)

Output only. Avro schema.

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

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setRowCount(long value)

public Storage.ReadRowsResponse.Builder setRowCount(long value)

Number of serialized rows in the rows block. This value is recorded here, in addition to the row_count values in the output-specific messages in rows, so that code which needs to record progress through the stream can do so in an output format-independent way.

int64 row_count = 6;

Parameter
Name Description
value long

The rowCount to set.

Returns
Type Description
Storage.ReadRowsResponse.Builder

This builder for chaining.

setStatus(Storage.StreamStatus value)

public Storage.ReadRowsResponse.Builder setStatus(Storage.StreamStatus value)

Estimated stream statistics.

.google.cloud.bigquery.storage.v1beta1.StreamStatus status = 2;

Parameter
Name Description
value Storage.StreamStatus
Returns
Type Description
Storage.ReadRowsResponse.Builder

setStatus(Storage.StreamStatus.Builder builderForValue)

public Storage.ReadRowsResponse.Builder setStatus(Storage.StreamStatus.Builder builderForValue)

Estimated stream statistics.

.google.cloud.bigquery.storage.v1beta1.StreamStatus status = 2;

Parameter
Name Description
builderForValue Storage.StreamStatus.Builder
Returns
Type Description
Storage.ReadRowsResponse.Builder

setThrottleStatus(Storage.ThrottleStatus value)

public Storage.ReadRowsResponse.Builder setThrottleStatus(Storage.ThrottleStatus value)

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

.google.cloud.bigquery.storage.v1beta1.ThrottleStatus throttle_status = 5;

Parameter
Name Description
value Storage.ThrottleStatus
Returns
Type Description
Storage.ReadRowsResponse.Builder

setThrottleStatus(Storage.ThrottleStatus.Builder builderForValue)

public Storage.ReadRowsResponse.Builder setThrottleStatus(Storage.ThrottleStatus.Builder builderForValue)

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

.google.cloud.bigquery.storage.v1beta1.ThrottleStatus throttle_status = 5;

Parameter
Name Description
builderForValue Storage.ThrottleStatus.Builder
Returns
Type Description
Storage.ReadRowsResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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