Package com.google.cloud.bigquery.storage.v1beta1

Class Storage.ReadSession

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSession
All Implemented Interfaces:
Storage.ReadSessionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Storage
public static final class Storage.ReadSession extends com.google.protobuf.GeneratedMessageV3 implements Storage.ReadSessionOrBuilder
 Information returned from a `CreateReadSession` request.
Protobuf type google.cloud.bigquery.storage.v1beta1.ReadSession
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • EXPIRE_TIME_FIELD_NUMBER

      public static final int EXPIRE_TIME_FIELD_NUMBER
      See Also:

    • AVRO_SCHEMA_FIELD_NUMBER

      public static final int AVRO_SCHEMA_FIELD_NUMBER
      See Also:

    • ARROW_SCHEMA_FIELD_NUMBER

      public static final int ARROW_SCHEMA_FIELD_NUMBER
      See Also:

    • STREAMS_FIELD_NUMBER

      public static final int STREAMS_FIELD_NUMBER
      See Also:

    • TABLE_REFERENCE_FIELD_NUMBER

      public static final int TABLE_REFERENCE_FIELD_NUMBER
      See Also:

    • TABLE_MODIFIERS_FIELD_NUMBER

      public static final int TABLE_MODIFIERS_FIELD_NUMBER
      See Also:

    • SHARDING_STRATEGY_FIELD_NUMBER

      public static final int SHARDING_STRATEGY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getSchemaCase

      public Storage.ReadSession.SchemaCase getSchemaCase()
      Specified by:
      getSchemaCase in interface Storage.ReadSessionOrBuilder

    • getName

      public String getName()
       Unique identifier for the session, in the form
 `projects/{project_id}/locations/{location}/sessions/{session_id}`.
      string name = 1;
      Specified by:
      getName in interface Storage.ReadSessionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Unique identifier for the session, in the form
 `projects/{project_id}/locations/{location}/sessions/{session_id}`.
      string name = 1;
      Specified by:
      getNameBytes in interface Storage.ReadSessionOrBuilder
      Returns:
      The bytes for name.

    • 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;
      Specified by:
      hasExpireTime in interface Storage.ReadSessionOrBuilder
      Returns:
      Whether the expireTime field is set.

    • getExpireTime

      public com.google.protobuf.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;
      Specified by:
      getExpireTime in interface Storage.ReadSessionOrBuilder
      Returns:
      The expireTime.

    • getExpireTimeOrBuilder

      public com.google.protobuf.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;
      Specified by:
      getExpireTimeOrBuilder in interface Storage.ReadSessionOrBuilder

    • hasAvroSchema

      public boolean hasAvroSchema()
       Avro schema.
      .google.cloud.bigquery.storage.v1beta1.AvroSchema avro_schema = 5;
      Specified by:
      hasAvroSchema in interface Storage.ReadSessionOrBuilder
      Returns:
      Whether the avroSchema field is set.

    • getAvroSchema

      public AvroProto.AvroSchema getAvroSchema()
       Avro schema.
      .google.cloud.bigquery.storage.v1beta1.AvroSchema avro_schema = 5;
      Specified by:
      getAvroSchema in interface Storage.ReadSessionOrBuilder
      Returns:
      The avroSchema.

    • getAvroSchemaOrBuilder

      public AvroProto.AvroSchemaOrBuilder getAvroSchemaOrBuilder()
       Avro schema.
      .google.cloud.bigquery.storage.v1beta1.AvroSchema avro_schema = 5;
      Specified by:
      getAvroSchemaOrBuilder in interface Storage.ReadSessionOrBuilder

    • hasArrowSchema

      public boolean hasArrowSchema()
       Arrow schema.
      .google.cloud.bigquery.storage.v1beta1.ArrowSchema arrow_schema = 6;
      Specified by:
      hasArrowSchema in interface Storage.ReadSessionOrBuilder
      Returns:
      Whether the arrowSchema field is set.

    • getArrowSchema

      public ArrowProto.ArrowSchema getArrowSchema()
       Arrow schema.
      .google.cloud.bigquery.storage.v1beta1.ArrowSchema arrow_schema = 6;
      Specified by:
      getArrowSchema in interface Storage.ReadSessionOrBuilder
      Returns:
      The arrowSchema.

    • getArrowSchemaOrBuilder

      public ArrowProto.ArrowSchemaOrBuilder getArrowSchemaOrBuilder()
       Arrow schema.
      .google.cloud.bigquery.storage.v1beta1.ArrowSchema arrow_schema = 6;
      Specified by:
      getArrowSchemaOrBuilder in interface Storage.ReadSessionOrBuilder

    • getStreamsList

      public List<Storage.Stream> getStreamsList()
       Streams associated with this session.
      repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;
      Specified by:
      getStreamsList in interface Storage.ReadSessionOrBuilder

    • getStreamsOrBuilderList

      public List<? extends Storage.StreamOrBuilder> getStreamsOrBuilderList()
       Streams associated with this session.
      repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;
      Specified by:
      getStreamsOrBuilderList in interface Storage.ReadSessionOrBuilder

    • getStreamsCount

      public int getStreamsCount()
       Streams associated with this session.
      repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;
      Specified by:
      getStreamsCount in interface Storage.ReadSessionOrBuilder

    • getStreams

      public Storage.Stream getStreams(int index)
       Streams associated with this session.
      repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;
      Specified by:
      getStreams in interface Storage.ReadSessionOrBuilder

    • getStreamsOrBuilder

      public Storage.StreamOrBuilder getStreamsOrBuilder(int index)
       Streams associated with this session.
      repeated .google.cloud.bigquery.storage.v1beta1.Stream streams = 4;
      Specified by:
      getStreamsOrBuilder in interface Storage.ReadSessionOrBuilder

    • hasTableReference

      public boolean hasTableReference()
       Table that this ReadSession is reading from.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 7;
      Specified by:
      hasTableReference in interface Storage.ReadSessionOrBuilder
      Returns:
      Whether the tableReference field is set.

    • getTableReference

      public TableReferenceProto.TableReference getTableReference()
       Table that this ReadSession is reading from.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 7;
      Specified by:
      getTableReference in interface Storage.ReadSessionOrBuilder
      Returns:
      The tableReference.

    • getTableReferenceOrBuilder

      public TableReferenceProto.TableReferenceOrBuilder getTableReferenceOrBuilder()
       Table that this ReadSession is reading from.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 7;
      Specified by:
      getTableReferenceOrBuilder in interface Storage.ReadSessionOrBuilder

    • hasTableModifiers

      public boolean hasTableModifiers()
       Any modifiers which are applied when reading from the specified table.
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 8;
      Specified by:
      hasTableModifiers in interface Storage.ReadSessionOrBuilder
      Returns:
      Whether the tableModifiers field is set.

    • 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;
      Specified by:
      getTableModifiers in interface Storage.ReadSessionOrBuilder
      Returns:
      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;
      Specified by:
      getTableModifiersOrBuilder in interface Storage.ReadSessionOrBuilder

    • getShardingStrategyValue

      public int getShardingStrategyValue()
       The strategy to use for distributing data among the streams.
      .google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 9;
      Specified by:
      getShardingStrategyValue in interface Storage.ReadSessionOrBuilder
      Returns:
      The enum numeric value on the wire for shardingStrategy.

    • getShardingStrategy

      public Storage.ShardingStrategy getShardingStrategy()
       The strategy to use for distributing data among the streams.
      .google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 9;
      Specified by:
      getShardingStrategy in interface Storage.ReadSessionOrBuilder
      Returns:
      The shardingStrategy.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Storage.ReadSession parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.ReadSession parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.ReadSession parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.ReadSession parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.ReadSession parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.ReadSession parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Storage.ReadSession parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Storage.ReadSession parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Storage.ReadSession parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Storage.ReadSession parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Storage.ReadSession parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Storage.ReadSession parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Storage.ReadSession.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Storage.ReadSession.Builder newBuilder()

    • newBuilder

      public static Storage.ReadSession.Builder newBuilder(Storage.ReadSession prototype)

    • toBuilder

      public Storage.ReadSession.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Storage.ReadSession.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Storage.ReadSession getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Storage.ReadSession> parser()

    • getParserForType

      public com.google.protobuf.Parser<Storage.ReadSession> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Storage.ReadSession getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder