Package com.google.cloud.bigquery.storage.v1beta2

Class ReadSession

  • All Implemented Interfaces:
    ReadSessionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ReadSession
extends com.google.protobuf.GeneratedMessageV3
implements ReadSessionOrBuilder
     Information about the ReadSession.
    Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession
    See Also:
    Serialized Form

    • Method Detail

      • 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

      • getName

        public 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];
        Specified by:
        getName in interface ReadSessionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface ReadSessionOrBuilder
        Returns:
        The bytes for name.

      • hasExpireTime

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

      • getExpireTime

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

      • getExpireTimeOrBuilder

        public 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];
        Specified by:
        getExpireTimeOrBuilder in interface ReadSessionOrBuilder

      • getDataFormatValue

        public int getDataFormatValue()
         Immutable. Data format of the output data.
        .google.cloud.bigquery.storage.v1beta2.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDataFormatValue in interface ReadSessionOrBuilder
        Returns:
        The enum numeric value on the wire for dataFormat.

      • getDataFormat

        public DataFormat getDataFormat()
         Immutable. Data format of the output data.
        .google.cloud.bigquery.storage.v1beta2.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDataFormat in interface ReadSessionOrBuilder
        Returns:
        The dataFormat.

      • hasAvroSchema

        public boolean hasAvroSchema()
         Output only. Avro schema.
        .google.cloud.bigquery.storage.v1beta2.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasAvroSchema in interface ReadSessionOrBuilder
        Returns:
        Whether the avroSchema field is set.

      • getAvroSchema

        public AvroSchema getAvroSchema()
         Output only. Avro schema.
        .google.cloud.bigquery.storage.v1beta2.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAvroSchema in interface ReadSessionOrBuilder
        Returns:
        The avroSchema.

      • hasArrowSchema

        public boolean hasArrowSchema()
         Output only. Arrow schema.
        .google.cloud.bigquery.storage.v1beta2.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasArrowSchema in interface ReadSessionOrBuilder
        Returns:
        Whether the arrowSchema field is set.

      • getArrowSchema

        public ArrowSchema getArrowSchema()
         Output only. Arrow schema.
        .google.cloud.bigquery.storage.v1beta2.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getArrowSchema in interface ReadSessionOrBuilder
        Returns:
        The arrowSchema.

      • getTable

        public 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) = { ... }
        Specified by:
        getTable in interface ReadSessionOrBuilder
        Returns:
        The table.

      • getTableBytes

        public 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) = { ... }
        Specified by:
        getTableBytes in interface ReadSessionOrBuilder
        Returns:
        The bytes for table.

      • hasTableModifiers

        public boolean hasTableModifiers()
         Optional. Any modifiers which are applied when reading from the specified table.
        .google.cloud.bigquery.storage.v1beta2.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasTableModifiers in interface ReadSessionOrBuilder
        Returns:
        Whether the tableModifiers field is set.

      • getTableModifiers

        public ReadSession.TableModifiers getTableModifiers()
         Optional. Any modifiers which are applied when reading from the specified table.
        .google.cloud.bigquery.storage.v1beta2.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTableModifiers in interface ReadSessionOrBuilder
        Returns:
        The tableModifiers.

      • hasReadOptions

        public boolean hasReadOptions()
         Optional. Read options for this session (e.g. column selection, filters).
        .google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasReadOptions in interface ReadSessionOrBuilder
        Returns:
        Whether the readOptions field is set.

      • getReadOptions

        public ReadSession.TableReadOptions getReadOptions()
         Optional. Read options for this session (e.g. column selection, filters).
        .google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReadOptions in interface ReadSessionOrBuilder
        Returns:
        The readOptions.

      • getStreamsList

        public 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.v1beta2.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStreamsList in interface ReadSessionOrBuilder

      • getStreamsOrBuilderList

        public 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.v1beta2.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStreamsOrBuilderList in interface ReadSessionOrBuilder

      • getStreamsCount

        public 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.v1beta2.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStreamsCount in interface ReadSessionOrBuilder

      • getStreams

        public 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.v1beta2.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStreams in interface ReadSessionOrBuilder

      • getStreamsOrBuilder

        public 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.v1beta2.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStreamsOrBuilder in interface ReadSessionOrBuilder

      • 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 ReadSession parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static 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 ReadSession parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static ReadSession getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<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 ReadSession getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder