Class Storage.ReadRowsRequest.Builder (3.6.0)

public static final class Storage.ReadRowsRequest.Builder extends GeneratedMessageV3.Builder<Storage.ReadRowsRequest.Builder> implements Storage.ReadRowsRequestOrBuilder

Requesting row data via ReadRows must provide Stream position information.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearReadPosition()

public Storage.ReadRowsRequest.Builder clearReadPosition()

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.ReadRowsRequest.Builder

clone()

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

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

getReadPositionBuilder()

public Storage.StreamPosition.Builder getReadPositionBuilder()

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.Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Storage.ReadRowsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadPosition(Storage.StreamPosition value)

public Storage.ReadRowsRequest.Builder mergeReadPosition(Storage.StreamPosition value)

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

Parameter
Name Description
value Storage.StreamPosition
Returns
Type Description
Storage.ReadRowsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setReadPosition(Storage.StreamPosition value)

public Storage.ReadRowsRequest.Builder setReadPosition(Storage.StreamPosition value)

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

Parameter
Name Description
value Storage.StreamPosition
Returns
Type Description
Storage.ReadRowsRequest.Builder

setReadPosition(Storage.StreamPosition.Builder builderForValue)

public Storage.ReadRowsRequest.Builder setReadPosition(Storage.StreamPosition.Builder builderForValue)

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

Parameter
Name Description
builderForValue Storage.StreamPosition.Builder
Returns
Type Description
Storage.ReadRowsRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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