Class ReadSession (2.3.0)

public sealed class ReadSession : IMessage<ReadSession>, IEquatable<ReadSession>, IDeepCloneable<ReadSession>, IBufferMessage, IMessage

Information about the ReadSession.

Inheritance

Object > ReadSession

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

ReadSession()

public ReadSession()

ReadSession(ReadSession)

public ReadSession(ReadSession other)
Parameter
NameDescription
otherReadSession

Properties

ArrowSchema

public ArrowSchema ArrowSchema { get; set; }

Output only. Arrow schema.

Property Value
TypeDescription
ArrowSchema

AvroSchema

public AvroSchema AvroSchema { get; set; }

Output only. Avro schema.

Property Value
TypeDescription
AvroSchema

DataFormat

public DataFormat DataFormat { get; set; }

Immutable. Data format of the output data.

Property Value
TypeDescription
DataFormat

ExpireTime

public Timestamp ExpireTime { get; set; }

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.

Property Value
TypeDescription
Timestamp

Name

public string Name { get; set; }

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

Property Value
TypeDescription
String

ReadOptions

public ReadSession.Types.TableReadOptions ReadOptions { get; set; }

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

Property Value
TypeDescription
ReadSession.Types.TableReadOptions

ReadSessionName

public ReadSessionName ReadSessionName { get; set; }

ReadSessionName-typed view over the Name resource name property.

Property Value
TypeDescription
ReadSessionName

SchemaCase

public ReadSession.SchemaOneofCase SchemaCase { get; }
Property Value
TypeDescription
ReadSession.SchemaOneofCase

Streams

public RepeatedField<ReadStream> Streams { get; }

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.

Property Value
TypeDescription
RepeatedField<ReadStream>

Table

public string Table { get; set; }

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

Property Value
TypeDescription
String

TableAsTableName

public TableName TableAsTableName { get; set; }

TableName-typed view over the Table resource name property.

Property Value
TypeDescription
TableName

TableModifiers

public ReadSession.Types.TableModifiers TableModifiers { get; set; }

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

Property Value
TypeDescription
ReadSession.Types.TableModifiers