Class Storage.ReadSession (2.36.0)

Version 2.36.0

• 3.10.3 (latest)
• 3.10.2
• 3.9.3
• 3.8.0
• 3.6.1
• 3.5.2
• 3.4.0
• 3.3.1
• 3.2.0
• 3.1.0
• 3.0.1
• 2.47.0
• 2.45.0
• 2.44.1
• 2.43.0

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

Implements

Storage.ReadSessionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getSchemaCase()

public Storage.ReadSession.SchemaCase getSchemaCase()

Returns
Type	Description
Storage.ReadSession.SchemaCase

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException