Package com.google.cloud.bigquery.storage.v1

Class ReadSession.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>
com.google.cloud.bigquery.storage.v1.ReadSession.Builder
All Implemented Interfaces:
ReadSessionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ReadSession
public static final class ReadSession.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder> implements ReadSessionOrBuilder
 Information about the ReadSession.
Protobuf type google.cloud.bigquery.storage.v1.ReadSession

  • Method Details

    • 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.Builder<ReadSession.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public ReadSession.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>

    • clearField

      public ReadSession.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>

    • clearOneof

      public ReadSession.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>

    • setRepeatedField

      public ReadSession.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>

    • addRepeatedField

      public ReadSession.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>

    • mergeFrom

      public ReadSession.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadSession.Builder>

    • mergeFrom

      public ReadSession.Builder mergeFrom(ReadSession other)

    • isInitialized

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

    • mergeFrom

      public ReadSession.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadSession.Builder>
      Throws:
      IOException

    • getSchemaCase

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

    • clearSchema

      public ReadSession.Builder clearSchema()

    • 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.

    • setName

      public ReadSession.Builder setName(String value)
       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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public ReadSession.Builder clearName()
       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];
      Returns:
      This builder for chaining.

    • setNameBytes

      public ReadSession.Builder setNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setExpireTime

      public ReadSession.Builder setExpireTime(com.google.protobuf.Timestamp value)
       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];

    • setExpireTime

      public ReadSession.Builder setExpireTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];

    • mergeExpireTime

      public ReadSession.Builder mergeExpireTime(com.google.protobuf.Timestamp value)
       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];

    • clearExpireTime

      public ReadSession.Builder clearExpireTime()
       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];

    • getExpireTimeBuilder

      public com.google.protobuf.Timestamp.Builder getExpireTimeBuilder()
       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];

    • 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. DATA_FORMAT_UNSPECIFIED not
 supported.
      .google.cloud.bigquery.storage.v1.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.

    • setDataFormatValue

      public ReadSession.Builder setDataFormatValue(int value)
       Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not
 supported.
      .google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The enum numeric value on the wire for dataFormat to set.
      Returns:
      This builder for chaining.

    • getDataFormat

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

    • setDataFormat

      public ReadSession.Builder setDataFormat(DataFormat value)
       Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not
 supported.
      .google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The dataFormat to set.
      Returns:
      This builder for chaining.

    • clearDataFormat

      public ReadSession.Builder clearDataFormat()
       Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not
 supported.
      .google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • hasAvroSchema

      public boolean hasAvroSchema()
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.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.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAvroSchema in interface ReadSessionOrBuilder
      Returns:
      The avroSchema.

    • setAvroSchema

      public ReadSession.Builder setAvroSchema(AvroSchema value)
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setAvroSchema

      public ReadSession.Builder setAvroSchema(AvroSchema.Builder builderForValue)
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeAvroSchema

      public ReadSession.Builder mergeAvroSchema(AvroSchema value)
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearAvroSchema

      public ReadSession.Builder clearAvroSchema()
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getAvroSchemaBuilder

      public AvroSchema.Builder getAvroSchemaBuilder()
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getAvroSchemaOrBuilder

      public AvroSchemaOrBuilder getAvroSchemaOrBuilder()
       Output only. Avro schema.
      .google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAvroSchemaOrBuilder in interface ReadSessionOrBuilder

    • hasArrowSchema

      public boolean hasArrowSchema()
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.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.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getArrowSchema in interface ReadSessionOrBuilder
      Returns:
      The arrowSchema.

    • setArrowSchema

      public ReadSession.Builder setArrowSchema(ArrowSchema value)
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setArrowSchema

      public ReadSession.Builder setArrowSchema(ArrowSchema.Builder builderForValue)
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeArrowSchema

      public ReadSession.Builder mergeArrowSchema(ArrowSchema value)
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearArrowSchema

      public ReadSession.Builder clearArrowSchema()
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getArrowSchemaBuilder

      public ArrowSchema.Builder getArrowSchemaBuilder()
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getArrowSchemaOrBuilder

      public ArrowSchemaOrBuilder getArrowSchemaOrBuilder()
       Output only. Arrow schema.
      .google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getArrowSchemaOrBuilder in interface ReadSessionOrBuilder

    • 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.

    • setTable

      public ReadSession.Builder setTable(String value)
       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) = { ... }
      Parameters:
      value - The table to set.
      Returns:
      This builder for chaining.

    • clearTable

      public ReadSession.Builder clearTable()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setTableBytes

      public ReadSession.Builder setTableBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for table to set.
      Returns:
      This builder for chaining.

    • hasTableModifiers

      public boolean hasTableModifiers()
       Optional. Any modifiers which are applied when reading from the specified
 table.
      .google.cloud.bigquery.storage.v1.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.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTableModifiers in interface ReadSessionOrBuilder
      Returns:
      The tableModifiers.

    • setTableModifiers

      public ReadSession.Builder setTableModifiers(ReadSession.TableModifiers value)
       Optional. Any modifiers which are applied when reading from the specified
 table.
      .google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

    • setTableModifiers

      public ReadSession.Builder setTableModifiers(ReadSession.TableModifiers.Builder builderForValue)
       Optional. Any modifiers which are applied when reading from the specified
 table.
      .google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

    • mergeTableModifiers

      public ReadSession.Builder mergeTableModifiers(ReadSession.TableModifiers value)
       Optional. Any modifiers which are applied when reading from the specified
 table.
      .google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

    • clearTableModifiers

      public ReadSession.Builder clearTableModifiers()
       Optional. Any modifiers which are applied when reading from the specified
 table.
      .google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getTableModifiersBuilder

      public ReadSession.TableModifiers.Builder getTableModifiersBuilder()
       Optional. Any modifiers which are applied when reading from the specified
 table.
      .google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getTableModifiersOrBuilder

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

    • hasReadOptions

      public boolean hasReadOptions()
       Optional. Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1.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.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getReadOptions in interface ReadSessionOrBuilder
      Returns:
      The readOptions.

    • setReadOptions

      public ReadSession.Builder setReadOptions(ReadSession.TableReadOptions value)
       Optional. Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

    • setReadOptions

      public ReadSession.Builder setReadOptions(ReadSession.TableReadOptions.Builder builderForValue)
       Optional. Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

    • mergeReadOptions

      public ReadSession.Builder mergeReadOptions(ReadSession.TableReadOptions value)
       Optional. Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

    • clearReadOptions

      public ReadSession.Builder clearReadOptions()
       Optional. Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getReadOptionsBuilder

      public ReadSession.TableReadOptions.Builder getReadOptionsBuilder()
       Optional. Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getReadOptionsOrBuilder

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

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

    • setStreams

      public ReadSession.Builder setStreams(int index, ReadStream value)
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setStreams

      public ReadSession.Builder setStreams(int index, ReadStream.Builder builderForValue)
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • addStreams

      public ReadSession.Builder addStreams(ReadStream value)
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • addStreams

      public ReadSession.Builder addStreams(int index, ReadStream value)
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • addStreams

      public ReadSession.Builder addStreams(ReadStream.Builder builderForValue)
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • addStreams

      public ReadSession.Builder addStreams(int index, ReadStream.Builder builderForValue)
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • addAllStreams

      public ReadSession.Builder addAllStreams(Iterable<? extends ReadStream> values)
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearStreams

      public ReadSession.Builder clearStreams()
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • removeStreams

      public ReadSession.Builder removeStreams(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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStreamsBuilder

      public ReadStream.Builder getStreamsBuilder(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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

    • addStreamsBuilder

      public ReadStream.Builder addStreamsBuilder()
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • addStreamsBuilder

      public ReadStream.Builder addStreamsBuilder(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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStreamsBuilderList

      public List<ReadStream.Builder> getStreamsBuilderList()
       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.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getEstimatedTotalBytesScanned

      public long getEstimatedTotalBytesScanned()
       Output only. An estimate on the number of bytes this session will scan when
 all streams are completely consumed. This estimate is based on
 metadata from the table which might be incomplete or stale.
      int64 estimated_total_bytes_scanned = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEstimatedTotalBytesScanned in interface ReadSessionOrBuilder
      Returns:
      The estimatedTotalBytesScanned.

    • setEstimatedTotalBytesScanned

      public ReadSession.Builder setEstimatedTotalBytesScanned(long value)
       Output only. An estimate on the number of bytes this session will scan when
 all streams are completely consumed. This estimate is based on
 metadata from the table which might be incomplete or stale.
      int64 estimated_total_bytes_scanned = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The estimatedTotalBytesScanned to set.
      Returns:
      This builder for chaining.

    • clearEstimatedTotalBytesScanned

      public ReadSession.Builder clearEstimatedTotalBytesScanned()
       Output only. An estimate on the number of bytes this session will scan when
 all streams are completely consumed. This estimate is based on
 metadata from the table which might be incomplete or stale.
      int64 estimated_total_bytes_scanned = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getEstimatedTotalPhysicalFileSize

      public long getEstimatedTotalPhysicalFileSize()
       Output only. A pre-projected estimate of the total physical size of files
 (in bytes) that this session will scan when all streams are consumed. This
 estimate is independent of the selected columns and can be based on
 incomplete or stale metadata from the table.  This field is only set for
 BigLake tables.
      int64 estimated_total_physical_file_size = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEstimatedTotalPhysicalFileSize in interface ReadSessionOrBuilder
      Returns:
      The estimatedTotalPhysicalFileSize.

    • setEstimatedTotalPhysicalFileSize

      public ReadSession.Builder setEstimatedTotalPhysicalFileSize(long value)
       Output only. A pre-projected estimate of the total physical size of files
 (in bytes) that this session will scan when all streams are consumed. This
 estimate is independent of the selected columns and can be based on
 incomplete or stale metadata from the table.  This field is only set for
 BigLake tables.
      int64 estimated_total_physical_file_size = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The estimatedTotalPhysicalFileSize to set.
      Returns:
      This builder for chaining.

    • clearEstimatedTotalPhysicalFileSize

      public ReadSession.Builder clearEstimatedTotalPhysicalFileSize()
       Output only. A pre-projected estimate of the total physical size of files
 (in bytes) that this session will scan when all streams are consumed. This
 estimate is independent of the selected columns and can be based on
 incomplete or stale metadata from the table.  This field is only set for
 BigLake tables.
      int64 estimated_total_physical_file_size = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getEstimatedRowCount

      public long getEstimatedRowCount()
       Output only. An estimate on the number of rows present in this session's
 streams. This estimate is based on metadata from the table which might be
 incomplete or stale.
      int64 estimated_row_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEstimatedRowCount in interface ReadSessionOrBuilder
      Returns:
      The estimatedRowCount.

    • setEstimatedRowCount

      public ReadSession.Builder setEstimatedRowCount(long value)
       Output only. An estimate on the number of rows present in this session's
 streams. This estimate is based on metadata from the table which might be
 incomplete or stale.
      int64 estimated_row_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The estimatedRowCount to set.
      Returns:
      This builder for chaining.

    • clearEstimatedRowCount

      public ReadSession.Builder clearEstimatedRowCount()
       Output only. An estimate on the number of rows present in this session's
 streams. This estimate is based on metadata from the table which might be
 incomplete or stale.
      int64 estimated_row_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getTraceId

      public String getTraceId()
       Optional. ID set by client to annotate a session identity.  This does not
 need to be strictly unique, but instead the same ID should be used to group
 logically connected sessions (e.g. All using the same ID for all sessions
 needed to complete a Spark SQL query is reasonable).

 Maximum length is 256 bytes.
      string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTraceId in interface ReadSessionOrBuilder
      Returns:
      The traceId.

    • getTraceIdBytes

      public com.google.protobuf.ByteString getTraceIdBytes()
       Optional. ID set by client to annotate a session identity.  This does not
 need to be strictly unique, but instead the same ID should be used to group
 logically connected sessions (e.g. All using the same ID for all sessions
 needed to complete a Spark SQL query is reasonable).

 Maximum length is 256 bytes.
      string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTraceIdBytes in interface ReadSessionOrBuilder
      Returns:
      The bytes for traceId.

    • setTraceId

      public ReadSession.Builder setTraceId(String value)
       Optional. ID set by client to annotate a session identity.  This does not
 need to be strictly unique, but instead the same ID should be used to group
 logically connected sessions (e.g. All using the same ID for all sessions
 needed to complete a Spark SQL query is reasonable).

 Maximum length is 256 bytes.
      string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The traceId to set.
      Returns:
      This builder for chaining.

    • clearTraceId

      public ReadSession.Builder clearTraceId()
       Optional. ID set by client to annotate a session identity.  This does not
 need to be strictly unique, but instead the same ID should be used to group
 logically connected sessions (e.g. All using the same ID for all sessions
 needed to complete a Spark SQL query is reasonable).

 Maximum length is 256 bytes.
      string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setTraceIdBytes

      public ReadSession.Builder setTraceIdBytes(com.google.protobuf.ByteString value)
       Optional. ID set by client to annotate a session identity.  This does not
 need to be strictly unique, but instead the same ID should be used to group
 logically connected sessions (e.g. All using the same ID for all sessions
 needed to complete a Spark SQL query is reasonable).

 Maximum length is 256 bytes.
      string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for traceId to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final ReadSession.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>

    • mergeUnknownFields

      public final ReadSession.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.Builder>