Class Storage.ReadRowsRequest (3.5.0)

public static final class Storage.ReadRowsRequest extends GeneratedMessageV3 implements Storage.ReadRowsRequestOrBuilder

Requesting row data via ReadRows must provide Stream position information.

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

Static Fields

READ_POSITION_FIELD_NUMBER

public static final int READ_POSITION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(Storage.ReadRowsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

getParserForType()

public Parser<Storage.ReadRowsRequest> getParserForType()
Returns
Type Description
Parser<ReadRowsRequest>
Overrides

getReadPosition()

public Storage.StreamPosition getReadPosition()

Required. Identifier of the position in the stream to start reading from. The offset requested must be less than the last row read from ReadRows. Requesting a larger offset is undefined.

.google.cloud.bigquery.storage.v1beta1.StreamPosition read_position = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Storage.StreamPosition

The readPosition.

getReadPositionOrBuilder()

public Storage.StreamPositionOrBuilder getReadPositionOrBuilder()

Required. Identifier of the position in the stream to start reading from. The offset requested must be less than the last row read from ReadRows. Requesting a larger offset is undefined.

.google.cloud.bigquery.storage.v1beta1.StreamPosition read_position = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Storage.StreamPositionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasReadPosition()

public boolean hasReadPosition()

Required. Identifier of the position in the stream to start reading from. The offset requested must be less than the last row read from ReadRows. Requesting a larger offset is undefined.

.google.cloud.bigquery.storage.v1beta1.StreamPosition read_position = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the readPosition 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.ReadRowsRequest.Builder newBuilderForType()
Returns
Type Description
Storage.ReadRowsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Storage.ReadRowsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Storage.ReadRowsRequest.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.ReadRowsRequest.Builder toBuilder()
Returns
Type Description
Storage.ReadRowsRequest.Builder

writeTo(CodedOutputStream output)

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