Class ReadSession.Builder (3.4.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.bigquery.storage.v1.ReadStream>
Returns
TypeDescription
ReadSession.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadSession.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadSession.Builder
Overrides

addStreams(ReadStream value)

public ReadSession.Builder addStreams(ReadStream value)

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
NameDescription
valueReadStream
Returns
TypeDescription
ReadSession.Builder

addStreams(ReadStream.Builder builderForValue)

public ReadSession.Builder addStreams(ReadStream.Builder builderForValue)

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
NameDescription
builderForValueReadStream.Builder
Returns
TypeDescription
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.

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

Parameters
NameDescription
indexint
valueReadStream
Returns
TypeDescription
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.

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

Parameters
NameDescription
indexint
builderForValueReadStream.Builder
Returns
TypeDescription
ReadSession.Builder

addStreamsBuilder()

public ReadStream.Builder addStreamsBuilder()

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

Returns
TypeDescription
ReadStream.Builder

addStreamsBuilder(int index)

public ReadStream.Builder addStreamsBuilder(int index)

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
NameDescription
indexint
Returns
TypeDescription
ReadStream.Builder

build()

public ReadSession build()
Returns
TypeDescription
ReadSession

buildPartial()

public ReadSession buildPartial()
Returns
TypeDescription
ReadSession

clear()

public ReadSession.Builder clear()
Returns
TypeDescription
ReadSession.Builder
Overrides

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

clearField(Descriptors.FieldDescriptor field)

public ReadSession.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ReadSession.Builder
Overrides

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadSession.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ReadSession.Builder
Overrides

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

clearSchema()

public ReadSession.Builder clearSchema()
Returns
TypeDescription
ReadSession.Builder

clearStreams()

public ReadSession.Builder clearStreams()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ReadSession.Builder

This builder for chaining.

clone()

public ReadSession.Builder clone()
Returns
TypeDescription
ReadSession.Builder
Overrides

getArrowSchema()

public ArrowSchema getArrowSchema()

Output only. Arrow schema.

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

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

The enum numeric value on the wire for dataFormat.

getDefaultInstanceForType()

public ReadSession getDefaultInstanceForType()
Returns
TypeDescription
ReadSession

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
long

The estimatedTotalBytesScanned.

getEstimatedTotalPhysicalFileSize()

public long getEstimatedTotalPhysicalFileSize()

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
TypeDescription
long

The estimatedTotalPhysicalFileSize.

getExpireTime()

public Timestamp getExpireTime()

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
TypeDescription
Timestamp

The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

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

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ReadSession.TableReadOptionsOrBuilder

getSchemaCase()

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

getStreams(int index)

public ReadStream getStreams(int index)

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
NameDescription
indexint
Returns
TypeDescription
ReadStream

getStreamsBuilder(int index)

public ReadStream.Builder getStreamsBuilder(int index)

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
NameDescription
indexint
Returns
TypeDescription
ReadStream.Builder

getStreamsBuilderList()

public List<ReadStream.Builder> getStreamsBuilderList()

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

Returns
TypeDescription
List<Builder>

getStreamsCount()

public int getStreamsCount()

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

Returns
TypeDescription
int

getStreamsList()

public List<ReadStream> getStreamsList()

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

Returns
TypeDescription
List<ReadStream>

getStreamsOrBuilder(int index)

public ReadStreamOrBuilder getStreamsOrBuilder(int index)

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
NameDescription
indexint
Returns
TypeDescription
ReadStreamOrBuilder

getStreamsOrBuilderList()

public List<? extends ReadStreamOrBuilder> getStreamsOrBuilderList()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ReadSession.TableModifiersOrBuilder

getTraceId()

public String getTraceId()

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
TypeDescription
String

The traceId.

getTraceIdBytes()

public ByteString getTraceIdBytes()

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

Whether the avroSchema field is set.

hasExpireTime()

public boolean hasExpireTime()

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

Whether the tableModifiers field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueArrowSchema
Returns
TypeDescription
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
NameDescription
valueAvroSchema
Returns
TypeDescription
ReadSession.Builder

mergeExpireTime(Timestamp value)

public ReadSession.Builder mergeExpireTime(Timestamp value)

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ReadSession.Builder

mergeFrom(ReadSession other)

public ReadSession.Builder mergeFrom(ReadSession other)
Parameter
NameDescription
otherReadSession
Returns
TypeDescription
ReadSession.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadSession.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadSession.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ReadSession.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ReadSession.Builder
Overrides

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
NameDescription
valueReadSession.TableReadOptions
Returns
TypeDescription
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
NameDescription
valueReadSession.TableModifiers
Returns
TypeDescription
ReadSession.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadSession.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadSession.Builder
Overrides

removeStreams(int index)

public ReadSession.Builder removeStreams(int index)

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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueArrowSchema
Returns
TypeDescription
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
NameDescription
builderForValueArrowSchema.Builder
Returns
TypeDescription
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
NameDescription
valueAvroSchema
Returns
TypeDescription
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
NameDescription
builderForValueAvroSchema.Builder
Returns
TypeDescription
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
NameDescription
valueDataFormat

The dataFormat to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for dataFormat to set.

Returns
TypeDescription
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
NameDescription
valuelong

The estimatedRowCount to set.

Returns
TypeDescription
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
NameDescription
valuelong

The estimatedTotalBytesScanned to set.

Returns
TypeDescription
ReadSession.Builder

This builder for chaining.

setEstimatedTotalPhysicalFileSize(long value)

public ReadSession.Builder setEstimatedTotalPhysicalFileSize(long value)

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

Parameter
NameDescription
valuelong

The estimatedTotalPhysicalFileSize to set.

Returns
TypeDescription
ReadSession.Builder

This builder for chaining.

setExpireTime(Timestamp value)

public ReadSession.Builder setExpireTime(Timestamp value)

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ReadSession.Builder

setExpireTime(Timestamp.Builder builderForValue)

public ReadSession.Builder setExpireTime(Timestamp.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ReadSession.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ReadSession.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadSession.Builder
Overrides

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueReadSession.TableReadOptions
Returns
TypeDescription
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
NameDescription
builderForValueReadSession.TableReadOptions.Builder
Returns
TypeDescription
ReadSession.Builder

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

public ReadSession.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ReadSession.Builder
Overrides

setStreams(int index, ReadStream value)

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

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

Parameters
NameDescription
indexint
valueReadStream
Returns
TypeDescription
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.

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

Parameters
NameDescription
indexint
builderForValueReadStream.Builder
Returns
TypeDescription
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
NameDescription
valueString

The table to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for table to set.

Returns
TypeDescription
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
NameDescription
valueReadSession.TableModifiers
Returns
TypeDescription
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
NameDescription
builderForValueReadSession.TableModifiers.Builder
Returns
TypeDescription
ReadSession.Builder

setTraceId(String value)

public ReadSession.Builder setTraceId(String value)

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

Parameter
NameDescription
valueString

The traceId to set.

Returns
TypeDescription
ReadSession.Builder

This builder for chaining.

setTraceIdBytes(ByteString value)

public ReadSession.Builder setTraceIdBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for traceId to set.

Returns
TypeDescription
ReadSession.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadSession.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadSession.Builder
Overrides