Class ReadSession.Builder (3.5.0)

public static final class ReadSession.Builder extends GeneratedMessageV3.Builder<ReadSession.Builder> implements ReadSessionOrBuilder

Information about the ReadSession.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReadSession.Builder

Implements

ReadSessionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllStreams(Iterable<? extends ReadStream> values)

public ReadSession.Builder addAllStreams(Iterable<? extends ReadStream> values)

Output only. A list of streams created with the session.

At least one stream is created with the session. In the future, larger request_stream_count values may result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.bigquery.storage.v1.ReadStream>`

Returns
Type	Description
`ReadSession.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadSession.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addStreams(ReadStream value)

public ReadSession.Builder addStreams(ReadStream value)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`ReadStream`

Returns
Type	Description
`ReadSession.Builder`

addStreams(ReadStream.Builder builderForValue)

public ReadSession.Builder addStreams(ReadStream.Builder builderForValue)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`ReadStream.Builder`

Returns
Type	Description
`ReadSession.Builder`

addStreams(int index, ReadStream value)

public ReadSession.Builder addStreams(int index, ReadStream value)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
`index`	`int`
`value`	`ReadStream`

Returns
Type	Description
`ReadSession.Builder`

addStreams(int index, ReadStream.Builder builderForValue)

public ReadSession.Builder addStreams(int index, ReadStream.Builder builderForValue)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ReadStream.Builder`

Returns
Type	Description
`ReadSession.Builder`

addStreamsBuilder()

public ReadStream.Builder addStreamsBuilder()

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ReadStream.Builder`

addStreamsBuilder(int index)

public ReadStream.Builder addStreamsBuilder(int index)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ReadStream.Builder`

build()

public ReadSession build()

Returns
Type	Description
`ReadSession`

buildPartial()

public ReadSession buildPartial()

Returns
Type	Description
`ReadSession`

clear()

public ReadSession.Builder clear()

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearArrowSchema()

public ReadSession.Builder clearArrowSchema()

Output only. Arrow schema.

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

Returns
Type	Description
`ReadSession.Builder`

clearAvroSchema()

public ReadSession.Builder clearAvroSchema()

Output only. Avro schema.

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

Returns
Type	Description
`ReadSession.Builder`

clearDataFormat()

public ReadSession.Builder clearDataFormat()

Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.

.google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

clearEstimatedRowCount()

public ReadSession.Builder clearEstimatedRowCount()

Output only. An estimate on the number of rows present in this session's streams. This estimate is based on metadata from the table which might be incomplete or stale.

int64 estimated_row_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

clearEstimatedTotalBytesScanned()

public ReadSession.Builder clearEstimatedTotalBytesScanned()

Output only. An estimate on the number of bytes this session will scan when all streams are completely consumed. This estimate is based on metadata from the table which might be incomplete or stale.

int64 estimated_total_bytes_scanned = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

clearEstimatedTotalPhysicalFileSize()

public ReadSession.Builder clearEstimatedTotalPhysicalFileSize()

Output only. A pre-projected estimate of the total physical size of files (in bytes) that this session will scan when all streams are consumed. This estimate is independent of the selected columns and can be based on incomplete or stale metadata from the table. This field is only set for BigLake tables.

int64 estimated_total_physical_file_size = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

clearExpireTime()

public ReadSession.Builder clearExpireTime()

Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.

.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ReadSession.Builder`

clearField(Descriptors.FieldDescriptor field)

public ReadSession.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public ReadSession.Builder clearName()

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadSession.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReadOptions()

public ReadSession.Builder clearReadOptions()

Optional. Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.Builder`

clearSchema()

public ReadSession.Builder clearSchema()

Returns
Type	Description
`ReadSession.Builder`

clearStreams()

public ReadSession.Builder clearStreams()

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ReadSession.Builder`

clearTable()

public ReadSession.Builder clearTable()

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

clearTableModifiers()

public ReadSession.Builder clearTableModifiers()

Optional. Any modifiers which are applied when reading from the specified table.

.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.Builder`

clearTraceId()

public ReadSession.Builder clearTraceId()

Optional. ID set by client to annotate a session identity. This does not need to be strictly unique, but instead the same ID should be used to group logically connected sessions (e.g. All using the same ID for all sessions needed to complete a Spark SQL query is reasonable).

Maximum length is 256 bytes.

string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

clone()

public ReadSession.Builder clone()

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getArrowSchema()

public ArrowSchema getArrowSchema()

Output only. Arrow schema.

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

Returns
Type	Description
`ArrowSchema`	The arrowSchema.

getArrowSchemaBuilder()

public ArrowSchema.Builder getArrowSchemaBuilder()

Output only. Arrow schema.

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

Returns
Type	Description
`ArrowSchema.Builder`

getArrowSchemaOrBuilder()

public ArrowSchemaOrBuilder getArrowSchemaOrBuilder()

Output only. Arrow schema.

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

Returns
Type	Description
`ArrowSchemaOrBuilder`

getAvroSchema()

public AvroSchema getAvroSchema()

Output only. Avro schema.

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

Returns
Type	Description
`AvroSchema`	The avroSchema.

getAvroSchemaBuilder()

public AvroSchema.Builder getAvroSchemaBuilder()

Output only. Avro schema.

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

Returns
Type	Description
`AvroSchema.Builder`

getAvroSchemaOrBuilder()

public AvroSchemaOrBuilder getAvroSchemaOrBuilder()

Output only. Avro schema.

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

Returns
Type	Description
`AvroSchemaOrBuilder`

getDataFormat()

public DataFormat getDataFormat()

Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.

.google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`DataFormat`	The dataFormat.

getDataFormatValue()

public int getDataFormatValue()

Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.

.google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`int`	The enum numeric value on the wire for dataFormat.

getDefaultInstanceForType()

public ReadSession getDefaultInstanceForType()

Returns
Type	Description
`ReadSession`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEstimatedRowCount()

public long getEstimatedRowCount()

Output only. An estimate on the number of rows present in this session's streams. This estimate is based on metadata from the table which might be incomplete or stale.

int64 estimated_row_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The estimatedRowCount.

getEstimatedTotalBytesScanned()

public long getEstimatedTotalBytesScanned()

Output only. An estimate on the number of bytes this session will scan when all streams are completely consumed. This estimate is based on metadata from the table which might be incomplete or stale.

int64 estimated_total_bytes_scanned = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The estimatedTotalBytesScanned.

getEstimatedTotalPhysicalFileSize()

public long getEstimatedTotalPhysicalFileSize()

int64 estimated_total_physical_file_size = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The estimatedTotalPhysicalFileSize.

getExpireTime()

public Timestamp getExpireTime()

.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Builder`

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getName()

public String getName()

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for name.

getReadOptions()

public ReadSession.TableReadOptions getReadOptions()

Optional. Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.TableReadOptions`	The readOptions.

getReadOptionsBuilder()

public ReadSession.TableReadOptions.Builder getReadOptionsBuilder()

Optional. Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

getReadOptionsOrBuilder()

public ReadSession.TableReadOptionsOrBuilder getReadOptionsOrBuilder()

Optional. Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.TableReadOptionsOrBuilder`

getSchemaCase()

public ReadSession.SchemaCase getSchemaCase()

Returns
Type	Description
`ReadSession.SchemaCase`

getStreams(int index)

public ReadStream getStreams(int index)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ReadStream`

getStreamsBuilder(int index)

public ReadStream.Builder getStreamsBuilder(int index)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ReadStream.Builder`

getStreamsBuilderList()

public List<ReadStream.Builder> getStreamsBuilderList()

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<Builder>`

getStreamsCount()

public int getStreamsCount()

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

getStreamsList()

public List<ReadStream> getStreamsList()

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<ReadStream>`

getStreamsOrBuilder(int index)

public ReadStreamOrBuilder getStreamsOrBuilder(int index)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ReadStreamOrBuilder`

getStreamsOrBuilderList()

public List<? extends ReadStreamOrBuilder> getStreamsOrBuilderList()

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<? extends com.google.cloud.bigquery.storage.v1.ReadStreamOrBuilder>`

getTable()

public String getTable()

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The table.

getTableBytes()

public ByteString getTableBytes()

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for table.

getTableModifiers()

public ReadSession.TableModifiers getTableModifiers()

Optional. Any modifiers which are applied when reading from the specified table.

.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.TableModifiers`	The tableModifiers.

getTableModifiersBuilder()

public ReadSession.TableModifiers.Builder getTableModifiersBuilder()

Optional. Any modifiers which are applied when reading from the specified table.

.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.TableModifiers.Builder`

getTableModifiersOrBuilder()

public ReadSession.TableModifiersOrBuilder getTableModifiersOrBuilder()

Optional. Any modifiers which are applied when reading from the specified table.

.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReadSession.TableModifiersOrBuilder`

getTraceId()

public String getTraceId()

Maximum length is 256 bytes.

string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The traceId.

getTraceIdBytes()

public ByteString getTraceIdBytes()

Maximum length is 256 bytes.

string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for traceId.

hasArrowSchema()

public boolean hasArrowSchema()

Output only. Arrow schema.

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

Returns
Type	Description
`boolean`	Whether the arrowSchema field is set.

hasAvroSchema()

public boolean hasAvroSchema()

Output only. Avro schema.

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

Returns
Type	Description
`boolean`	Whether the avroSchema field is set.

hasExpireTime()

public boolean hasExpireTime()

.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the expireTime field is set.

hasReadOptions()

public boolean hasReadOptions()

Optional. Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the readOptions field is set.

hasTableModifiers()

public boolean hasTableModifiers()

Optional. Any modifiers which are applied when reading from the specified table.

.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the tableModifiers field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeArrowSchema(ArrowSchema value)

public ReadSession.Builder mergeArrowSchema(ArrowSchema value)

Output only. Arrow schema.

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

Parameter
Name	Description
`value`	`ArrowSchema`

Returns
Type	Description
`ReadSession.Builder`

mergeAvroSchema(AvroSchema value)

public ReadSession.Builder mergeAvroSchema(AvroSchema value)

Output only. Avro schema.

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

Parameter
Name	Description
`value`	`AvroSchema`

Returns
Type	Description
`ReadSession.Builder`

mergeExpireTime(Timestamp value)

public ReadSession.Builder mergeExpireTime(Timestamp value)

.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`ReadSession.Builder`

mergeFrom(ReadSession other)

public ReadSession.Builder mergeFrom(ReadSession other)

Parameter
Name	Description
`other`	`ReadSession`

Returns
Type	Description
`ReadSession.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadSession.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReadSession.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ReadSession.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ReadSession.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeReadOptions(ReadSession.TableReadOptions value)

public ReadSession.Builder mergeReadOptions(ReadSession.TableReadOptions value)

Optional. Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ReadSession.TableReadOptions`

Returns
Type	Description
`ReadSession.Builder`

mergeTableModifiers(ReadSession.TableModifiers value)

public ReadSession.Builder mergeTableModifiers(ReadSession.TableModifiers value)

Optional. Any modifiers which are applied when reading from the specified table.

.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ReadSession.TableModifiers`

Returns
Type	Description
`ReadSession.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadSession.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeStreams(int index)

public ReadSession.Builder removeStreams(int index)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ReadSession.Builder`

setArrowSchema(ArrowSchema value)

public ReadSession.Builder setArrowSchema(ArrowSchema value)

Output only. Arrow schema.

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

Parameter
Name	Description
`value`	`ArrowSchema`

Returns
Type	Description
`ReadSession.Builder`

setArrowSchema(ArrowSchema.Builder builderForValue)

public ReadSession.Builder setArrowSchema(ArrowSchema.Builder builderForValue)

Output only. Arrow schema.

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

Parameter
Name	Description
`builderForValue`	`ArrowSchema.Builder`

Returns
Type	Description
`ReadSession.Builder`

setAvroSchema(AvroSchema value)

public ReadSession.Builder setAvroSchema(AvroSchema value)

Output only. Avro schema.

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

Parameter
Name	Description
`value`	`AvroSchema`

Returns
Type	Description
`ReadSession.Builder`

setAvroSchema(AvroSchema.Builder builderForValue)

public ReadSession.Builder setAvroSchema(AvroSchema.Builder builderForValue)

Output only. Avro schema.

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

Parameter
Name	Description
`builderForValue`	`AvroSchema.Builder`

Returns
Type	Description
`ReadSession.Builder`

setDataFormat(DataFormat value)

public ReadSession.Builder setDataFormat(DataFormat value)

Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.

.google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`value`	`DataFormat` The dataFormat to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setDataFormatValue(int value)

public ReadSession.Builder setDataFormatValue(int value)

Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.

.google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for dataFormat to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setEstimatedRowCount(long value)

public ReadSession.Builder setEstimatedRowCount(long value)

Output only. An estimate on the number of rows present in this session's streams. This estimate is based on metadata from the table which might be incomplete or stale.

int64 estimated_row_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`long` The estimatedRowCount to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setEstimatedTotalBytesScanned(long value)

public ReadSession.Builder setEstimatedTotalBytesScanned(long value)

Output only. An estimate on the number of bytes this session will scan when all streams are completely consumed. This estimate is based on metadata from the table which might be incomplete or stale.

int64 estimated_total_bytes_scanned = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`long` The estimatedTotalBytesScanned to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setEstimatedTotalPhysicalFileSize(long value)

public ReadSession.Builder setEstimatedTotalPhysicalFileSize(long value)

int64 estimated_total_physical_file_size = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`long` The estimatedTotalPhysicalFileSize to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setExpireTime(Timestamp value)

public ReadSession.Builder setExpireTime(Timestamp value)

.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`ReadSession.Builder`

setExpireTime(Timestamp.Builder builderForValue)

public ReadSession.Builder setExpireTime(Timestamp.Builder builderForValue)

.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`ReadSession.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public ReadSession.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public ReadSession.Builder setName(String value)

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public ReadSession.Builder setNameBytes(ByteString value)

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setReadOptions(ReadSession.TableReadOptions value)

public ReadSession.Builder setReadOptions(ReadSession.TableReadOptions value)

Optional. Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ReadSession.TableReadOptions`

Returns
Type	Description
`ReadSession.Builder`

setReadOptions(ReadSession.TableReadOptions.Builder builderForValue)

public ReadSession.Builder setReadOptions(ReadSession.TableReadOptions.Builder builderForValue)

Optional. Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`ReadSession.TableReadOptions.Builder`

Returns
Type	Description
`ReadSession.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStreams(int index, ReadStream value)

public ReadSession.Builder setStreams(int index, ReadStream value)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
`index`	`int`
`value`	`ReadStream`

Returns
Type	Description
`ReadSession.Builder`

setStreams(int index, ReadStream.Builder builderForValue)

public ReadSession.Builder setStreams(int index, ReadStream.Builder builderForValue)

Output only. A list of streams created with the session.

repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ReadStream.Builder`

Returns
Type	Description
`ReadSession.Builder`

setTable(String value)

public ReadSession.Builder setTable(String value)

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The table to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setTableBytes(ByteString value)

public ReadSession.Builder setTableBytes(ByteString value)

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for table to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setTableModifiers(ReadSession.TableModifiers value)

public ReadSession.Builder setTableModifiers(ReadSession.TableModifiers value)

Optional. Any modifiers which are applied when reading from the specified table.

.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ReadSession.TableModifiers`

Returns
Type	Description
`ReadSession.Builder`

setTableModifiers(ReadSession.TableModifiers.Builder builderForValue)

public ReadSession.Builder setTableModifiers(ReadSession.TableModifiers.Builder builderForValue)

Optional. Any modifiers which are applied when reading from the specified table.

.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`ReadSession.TableModifiers.Builder`

Returns
Type	Description
`ReadSession.Builder`

setTraceId(String value)

public ReadSession.Builder setTraceId(String value)

Maximum length is 256 bytes.

string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The traceId to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setTraceIdBytes(ByteString value)

public ReadSession.Builder setTraceIdBytes(ByteString value)

Maximum length is 256 bytes.

string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for traceId to set.

Returns
Type	Description
`ReadSession.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadSession.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ReadSession.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)