Class Storage.ReadSession (3.9.1) 

public static final class Storage.ReadSession extends GeneratedMessageV3 implements Storage.ReadSessionOrBuilder

Information returned from a CreateReadSession request.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Storage.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

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

SHARDING_STRATEGY_FIELD_NUMBER

public static final int SHARDING_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

STREAMS_FIELD_NUMBER

public static final int STREAMS_FIELD_NUMBER
Field Value
Type Description
int

TABLE_MODIFIERS_FIELD_NUMBER

public static final int TABLE_MODIFIERS_FIELD_NUMBER
Field Value
Type Description
int

TABLE_REFERENCE_FIELD_NUMBER

public static final int TABLE_REFERENCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Storage.ReadSession getDefaultInstance()
Returns
Type Description
Storage.ReadSession

getDescriptor()

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

newBuilder()

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

newBuilder(Storage.ReadSession prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Storage.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 ArrowProto.ArrowSchema getArrowSchema()

Arrow schema.

.google.cloud.bigquery.storage.v1beta1.ArrowSchema arrow_schema = 6;

Returns
Type Description
ArrowProto.ArrowSchema

The arrowSchema.

getArrowSchemaOrBuilder()

public ArrowProto.ArrowSchemaOrBuilder getArrowSchemaOrBuilder()

Arrow schema.

.google.cloud.bigquery.storage.v1beta1.ArrowSchema arrow_schema = 6;

Returns
Type Description
ArrowProto.ArrowSchemaOrBuilder

getAvroSchema()

public AvroProto.AvroSchema getAvroSchema()

Avro schema.

.google.cloud.bigquery.storage.v1beta1.AvroSchema avro_schema = 5;

Returns
Type Description
AvroProto.AvroSchema

The avroSchema.

getAvroSchemaOrBuilder()

public AvroProto.AvroSchemaOrBuilder getAvroSchemaOrBuilder()

Avro schema.

.google.cloud.bigquery.storage.v1beta1.AvroSchema avro_schema = 5;

Returns
Type Description
AvroProto.AvroSchemaOrBuilder

getDefaultInstanceForType()

public Storage.ReadSession getDefaultInstanceForType()
Returns
Type Description
Storage.ReadSession

getExpireTime()

public Timestamp getExpireTime()

Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors.

.google.protobuf.Timestamp expire_time = 2;

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors.

.google.protobuf.Timestamp expire_time = 2;

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSchemaCase()

public Storage.ReadSession.SchemaCase getSchemaCase()
Returns
Type Description
Storage.ReadSession.SchemaCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShardingStrategy()

public Storage.ShardingStrategy getShardingStrategy()

The strategy to use for distributing data among the streams.

.google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 9;

Returns
Type Description
Storage.ShardingStrategy

The shardingStrategy.

getShardingStrategyValue()

public int getShardingStrategyValue()

The strategy to use for distributing data among the streams.

.google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 9;

Returns
Type Description
int

The enum numeric value on the wire for shardingStrategy.

getStreams(int index)

public Storage.Stream getStreams(int index)

Streams associated with this session.

repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;

Parameter
Name Description
index int
Returns
Type Description
Storage.Stream

getStreamsCount()

public int getStreamsCount()

Streams associated with this session.

repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;

Returns
Type Description
int

getStreamsList()

public List<Storage.Stream> getStreamsList()

Streams associated with this session.

repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;

Returns
Type Description
List<Stream>

getStreamsOrBuilder(int index)

public Storage.StreamOrBuilder getStreamsOrBuilder(int index)

Streams associated with this session.

repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;

Parameter
Name Description
index int
Returns
Type Description
Storage.StreamOrBuilder

getStreamsOrBuilderList()

public List<? extends Storage.StreamOrBuilder> getStreamsOrBuilderList()

Streams associated with this session.

repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;

Returns
Type Description
List<? extends com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder>

getTableModifiers()

public TableReferenceProto.TableModifiers getTableModifiers()

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

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 8;

Returns
Type Description
TableReferenceProto.TableModifiers

The tableModifiers.

getTableModifiersOrBuilder()

public TableReferenceProto.TableModifiersOrBuilder getTableModifiersOrBuilder()

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

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 8;

Returns
Type Description
TableReferenceProto.TableModifiersOrBuilder

getTableReference()

public TableReferenceProto.TableReference getTableReference()

Table that this ReadSession is reading from.

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 7;

Returns
Type Description
TableReferenceProto.TableReference

The tableReference.

getTableReferenceOrBuilder()

public TableReferenceProto.TableReferenceOrBuilder getTableReferenceOrBuilder()

Table that this ReadSession is reading from.

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 7;

Returns
Type Description
TableReferenceProto.TableReferenceOrBuilder

hasArrowSchema()

public boolean hasArrowSchema()

Arrow schema.

.google.cloud.bigquery.storage.v1beta1.ArrowSchema arrow_schema = 6;

Returns
Type Description
boolean

Whether the arrowSchema field is set.

hasAvroSchema()

public boolean hasAvroSchema()

Avro schema.

.google.cloud.bigquery.storage.v1beta1.AvroSchema avro_schema = 5;

Returns
Type Description
boolean

Whether the avroSchema field is set.

hasExpireTime()

public boolean hasExpireTime()

Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors.

.google.protobuf.Timestamp expire_time = 2;

Returns
Type Description
boolean

Whether the expireTime field is set.

hasTableModifiers()

public boolean hasTableModifiers()

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

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 8;

Returns
Type Description
boolean

Whether the tableModifiers field is set.

hasTableReference()

public boolean hasTableReference()

Table that this ReadSession is reading from.

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 7;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Storage.ReadSession.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Storage.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 Storage.ReadSession.Builder toBuilder()
Returns
Type Description
Storage.ReadSession.Builder

writeTo(CodedOutputStream output)

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