Class Storage.ReadRowsResponse (3.11.0) 

public static final class Storage.ReadRowsResponse extends GeneratedMessageV3 implements Storage.ReadRowsResponseOrBuilder

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

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Storage.ReadRowsResponse

Static Fields

ARROW_RECORD_BATCH_FIELD_NUMBER

public static final int ARROW_RECORD_BATCH_FIELD_NUMBER
Field Value
Type Description
int

ARROW_SCHEMA_FIELD_NUMBER

public static final int ARROW_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

AVRO_ROWS_FIELD_NUMBER

public static final int AVRO_ROWS_FIELD_NUMBER
Field Value
Type Description
int

AVRO_SCHEMA_FIELD_NUMBER

public static final int AVRO_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

THROTTLE_STATUS_FIELD_NUMBER

public static final int THROTTLE_STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Storage.ReadRowsResponse getDefaultInstance()
Returns
Type Description
Storage.ReadRowsResponse

getDescriptor()

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

newBuilder()

public static Storage.ReadRowsResponse.Builder newBuilder()
Returns
Type Description
Storage.ReadRowsResponse.Builder

newBuilder(Storage.ReadRowsResponse prototype)

public static Storage.ReadRowsResponse.Builder newBuilder(Storage.ReadRowsResponse prototype)
Parameter
Name Description
prototype Storage.ReadRowsResponse
Returns
Type Description
Storage.ReadRowsResponse.Builder

parseDelimitedFrom(InputStream input)

public static Storage.ReadRowsResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.ReadRowsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Storage.ReadRowsResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Storage.ReadRowsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Storage.ReadRowsResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Storage.ReadRowsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Storage.ReadRowsResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.ReadRowsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Storage.ReadRowsResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.ReadRowsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Storage.ReadRowsResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Storage.ReadRowsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Storage.ReadRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Storage.ReadRowsResponse> parser()
Returns
Type Description
Parser<ReadRowsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

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.

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.

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

getParserForType()

public Parser<Storage.ReadRowsResponse> getParserForType()
Returns
Type Description
Parser<ReadRowsResponse>
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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public Storage.StreamStatus getStatus()

Estimated stream statistics.

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

Returns
Type Description
Storage.StreamStatus

The status.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Storage.ReadRowsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Storage.ReadRowsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException