com.google.cloud.bigquery.storage.v1

Interface ReadSessionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ReadSession, ReadSession.Builder

public interface ReadSessionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ArrowSchema	getArrowSchema() Output only.
ArrowSchemaOrBuilder	getArrowSchemaOrBuilder() Output only.
AvroSchema	getAvroSchema() Output only.
AvroSchemaOrBuilder	getAvroSchemaOrBuilder() Output only.
DataFormat	getDataFormat() Immutable.
int	getDataFormatValue() Immutable.
long	getEstimatedRowCount() Output only.
long	getEstimatedTotalBytesScanned() Output only.
com.google.protobuf.Timestamp	getExpireTime() Output only.
com.google.protobuf.TimestampOrBuilder	getExpireTimeOrBuilder() Output only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
ReadSession.TableReadOptions	getReadOptions() Optional.
ReadSession.TableReadOptionsOrBuilder	getReadOptionsOrBuilder() Optional.
ReadSession.SchemaCase	getSchemaCase()
ReadStream	getStreams(int index) Output only.
int	getStreamsCount() Output only.
List<ReadStream>	getStreamsList() Output only.
ReadStreamOrBuilder	getStreamsOrBuilder(int index) Output only.
List<? extends ReadStreamOrBuilder>	getStreamsOrBuilderList() Output only.
String	getTable() Immutable.
com.google.protobuf.ByteString	getTableBytes() Immutable.
ReadSession.TableModifiers	getTableModifiers() Optional.
ReadSession.TableModifiersOrBuilder	getTableModifiersOrBuilder() Optional.
String	getTraceId() Optional.
com.google.protobuf.ByteString	getTraceIdBytes() Optional.
boolean	hasArrowSchema() Output only.
boolean	hasAvroSchema() Output only.
boolean	hasExpireTime() Output only.
boolean	hasReadOptions() Optional.
boolean	hasTableModifiers() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

hasExpireTime

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:

Whether the expireTime field is set.

getExpireTime

com.google.protobuf.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:

The expireTime.

getExpireTimeOrBuilder

com.google.protobuf.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];

getDataFormatValue

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:

The enum numeric value on the wire for dataFormat.

getDataFormat

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:

The dataFormat.

hasAvroSchema

boolean hasAvroSchema()

 Output only. Avro schema.
 

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

Returns:

Whether the avroSchema field is set.

getAvroSchema

AvroSchema getAvroSchema()

 Output only. Avro schema.
 

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

Returns:

The avroSchema.

getAvroSchemaOrBuilder

AvroSchemaOrBuilder getAvroSchemaOrBuilder()

 Output only. Avro schema.
 

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

hasArrowSchema

boolean hasArrowSchema()

 Output only. Arrow schema.
 

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

Returns:

Whether the arrowSchema field is set.

getArrowSchema

ArrowSchema getArrowSchema()

 Output only. Arrow schema.
 

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

Returns:

The arrowSchema.

getArrowSchemaOrBuilder

ArrowSchemaOrBuilder getArrowSchemaOrBuilder()

 Output only. Arrow schema.
 

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

getTable

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:

The table.

getTableBytes

com.google.protobuf.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:

The bytes for table.

hasTableModifiers

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:

Whether the tableModifiers field is set.

getTableModifiers

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:

The tableModifiers.

getTableModifiersOrBuilder

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

hasReadOptions

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:

Whether the readOptions field is set.

getReadOptions

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:

The readOptions.

getReadOptionsOrBuilder

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

getStreamsList

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

getStreams

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

getStreamsCount

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

getStreamsOrBuilderList

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

getStreamsOrBuilder

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

getEstimatedTotalBytesScanned

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:

The estimatedTotalBytesScanned.

getEstimatedRowCount

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:

The estimatedRowCount.

getTraceId

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:

The traceId.

getTraceIdBytes

com.google.protobuf.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:

The bytes for traceId.

getSchemaCase

ReadSession.SchemaCase getSchemaCase()