Class ReadRowsResponse (2.36.0)

public final class ReadRowsResponse extends GeneratedMessageV3 implements ReadRowsResponseOrBuilder

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

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

Static Fields

ARROW_RECORD_BATCH_FIELD_NUMBER

public static final int ARROW_RECORD_BATCH_FIELD_NUMBER
Field Value
TypeDescription
int

ARROW_SCHEMA_FIELD_NUMBER

public static final int ARROW_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

AVRO_ROWS_FIELD_NUMBER

public static final int AVRO_ROWS_FIELD_NUMBER
Field Value
TypeDescription
int

AVRO_SCHEMA_FIELD_NUMBER

public static final int AVRO_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

STATS_FIELD_NUMBER

public static final int STATS_FIELD_NUMBER
Field Value
TypeDescription
int

THROTTLE_STATE_FIELD_NUMBER

public static final int THROTTLE_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReadRowsResponse getDefaultInstance()
Returns
TypeDescription
ReadRowsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReadRowsResponse.Builder newBuilder()
Returns
TypeDescription
ReadRowsResponse.Builder

newBuilder(ReadRowsResponse prototype)

public static ReadRowsResponse.Builder newBuilder(ReadRowsResponse prototype)
Parameter
NameDescription
prototypeReadRowsResponse
Returns
TypeDescription
ReadRowsResponse.Builder

parseDelimitedFrom(InputStream input)

public static ReadRowsResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReadRowsResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadRowsResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadRowsResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReadRowsResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReadRowsResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReadRowsResponse> parser()
Returns
TypeDescription
Parser<ReadRowsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getArrowRecordBatch()

public ArrowRecordBatch getArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

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

Returns
TypeDescription
ArrowRecordBatch

The arrowRecordBatch.

getArrowRecordBatchOrBuilder()

public ArrowRecordBatchOrBuilder getArrowRecordBatchOrBuilder()

Serialized row data in Arrow RecordBatch format.

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

Returns
TypeDescription
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
TypeDescription
ArrowSchema

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

Returns
TypeDescription
ArrowSchemaOrBuilder

getAvroRows()

public AvroRows getAvroRows()

Serialized row data in AVRO format.

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

Returns
TypeDescription
AvroRows

The avroRows.

getAvroRowsOrBuilder()

public AvroRowsOrBuilder getAvroRowsOrBuilder()

Serialized row data in AVRO format.

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

Returns
TypeDescription
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
TypeDescription
AvroSchema

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

Returns
TypeDescription
AvroSchemaOrBuilder

getDefaultInstanceForType()

public ReadRowsResponse getDefaultInstanceForType()
Returns
TypeDescription
ReadRowsResponse

getParserForType()

public Parser<ReadRowsResponse> getParserForType()
Returns
TypeDescription
Parser<ReadRowsResponse>
Overrides

getRowCount()

public long getRowCount()

Number of serialized rows in the rows block.

int64 row_count = 6;

Returns
TypeDescription
long

The rowCount.

getRowsCase()

public ReadRowsResponse.RowsCase getRowsCase()
Returns
TypeDescription
ReadRowsResponse.RowsCase

getSchemaCase()

public ReadRowsResponse.SchemaCase getSchemaCase()
Returns
TypeDescription
ReadRowsResponse.SchemaCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStats()

public StreamStats getStats()

Statistics for the stream.

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

Returns
TypeDescription
StreamStats

The stats.

getStatsOrBuilder()

public StreamStatsOrBuilder getStatsOrBuilder()

Statistics for the stream.

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

Returns
TypeDescription
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
TypeDescription
ThrottleState

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;

Returns
TypeDescription
ThrottleStateOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasArrowRecordBatch()

public boolean hasArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the avroSchema field is set.

hasStats()

public boolean hasStats()

Statistics for the stream.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the throttleState field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReadRowsResponse.Builder newBuilderForType()
Returns
TypeDescription
ReadRowsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadRowsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReadRowsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReadRowsResponse.Builder toBuilder()
Returns
TypeDescription
ReadRowsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException