Class ReadSession (3.8.0) 

public final class ReadSession extends GeneratedMessageV3 implements ReadSessionOrBuilder

Information about the ReadSession.

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

Inheritance

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

Static Fields

ARROW_SCHEMA_FIELD_NUMBER

public static final int ARROW_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

AVRO_SCHEMA_FIELD_NUMBER

public static final int AVRO_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

DATA_FORMAT_FIELD_NUMBER

public static final int DATA_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

ESTIMATED_ROW_COUNT_FIELD_NUMBER

public static final int ESTIMATED_ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

ESTIMATED_TOTAL_BYTES_SCANNED_FIELD_NUMBER

public static final int ESTIMATED_TOTAL_BYTES_SCANNED_FIELD_NUMBER
Field Value
Type Description
int

ESTIMATED_TOTAL_PHYSICAL_FILE_SIZE_FIELD_NUMBER

public static final int ESTIMATED_TOTAL_PHYSICAL_FILE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

STREAMS_FIELD_NUMBER

public static final int STREAMS_FIELD_NUMBER
Field Value
Type Description
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
Type Description
int

TABLE_MODIFIERS_FIELD_NUMBER

public static final int TABLE_MODIFIERS_FIELD_NUMBER
Field Value
Type Description
int

TRACE_ID_FIELD_NUMBER

public static final int TRACE_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReadSession getDefaultInstance()
Returns
Type Description
ReadSession

getDescriptor()

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

newBuilder()

public static ReadSession.Builder newBuilder()
Returns
Type Description
ReadSession.Builder

newBuilder(ReadSession prototype)

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

parseDelimitedFrom(InputStream input)

public static ReadSession parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadSession
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ReadSession parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReadSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ReadSession parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReadSession
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ReadSession parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadSession
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ReadSession parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReadSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ReadSession> parser()
Returns
Type Description
Parser<ReadSession>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
ArrowSchema

The arrowSchema.

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.

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

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()

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
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
Type Description
Timestamp

The expireTime.

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

getParserForType()

public Parser<ReadSession> getParserForType()
Returns
Type Description
Parser<ReadSession>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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
Name Description
index int
Returns
Type Description
ReadStream

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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
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.

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()

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
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
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()

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

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 ReadSession.Builder newBuilderForType()
Returns
Type Description
ReadSession.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadSession.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReadSession.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReadSession.Builder toBuilder()
Returns
Type Description
ReadSession.Builder

writeTo(CodedOutputStream output)

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