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

Class Storage.CreateReadSessionRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Storage.CreateReadSessionRequest.Builder>
com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequest.Builder
All Implemented Interfaces:
Storage.CreateReadSessionRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Storage.CreateReadSessionRequest
public static final class Storage.CreateReadSessionRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Storage.CreateReadSessionRequest.Builder> implements Storage.CreateReadSessionRequestOrBuilder
 Creates a new read session, which may include additional options such as
 requested parallelism, projection filters and constraints.
Protobuf type google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest

  • 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<Storage.CreateReadSessionRequest.Builder>

    • clear

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • setField

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • clearField

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • clearOneof

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • setRepeatedField

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • addRepeatedField

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • mergeFrom

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • mergeFrom

      public Storage.CreateReadSessionRequest.Builder mergeFrom(Storage.CreateReadSessionRequest other)

    • isInitialized

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

    • mergeFrom

      public Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>
      Throws:
      IOException

    • hasTableReference

      public boolean hasTableReference()
       Required. Reference to the table to read.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasTableReference in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      Whether the tableReference field is set.

    • getTableReference

      public TableReferenceProto.TableReference getTableReference()
       Required. Reference to the table to read.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTableReference in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The tableReference.

    • setTableReference

      public Storage.CreateReadSessionRequest.Builder setTableReference(TableReferenceProto.TableReference value)
       Required. Reference to the table to read.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];

    • setTableReference

      public Storage.CreateReadSessionRequest.Builder setTableReference(TableReferenceProto.TableReference.Builder builderForValue)
       Required. Reference to the table to read.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];

    • mergeTableReference

      public Storage.CreateReadSessionRequest.Builder mergeTableReference(TableReferenceProto.TableReference value)
       Required. Reference to the table to read.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];

    • clearTableReference

      public Storage.CreateReadSessionRequest.Builder clearTableReference()
       Required. Reference to the table to read.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];

    • getTableReferenceBuilder

      public TableReferenceProto.TableReference.Builder getTableReferenceBuilder()
       Required. Reference to the table to read.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];

    • getTableReferenceOrBuilder

      public TableReferenceProto.TableReferenceOrBuilder getTableReferenceOrBuilder()
       Required. Reference to the table to read.
      .google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTableReferenceOrBuilder in interface Storage.CreateReadSessionRequestOrBuilder

    • getParent

      public String getParent()
       Required. String of the form `projects/{project_id}` indicating the
 project this ReadSession is associated with. This is the project that will
 be billed for usage.
      string parent = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. String of the form `projects/{project_id}` indicating the
 project this ReadSession is associated with. This is the project that will
 be billed for usage.
      string parent = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public Storage.CreateReadSessionRequest.Builder setParent(String value)
       Required. String of the form `projects/{project_id}` indicating the
 project this ReadSession is associated with. This is the project that will
 be billed for usage.
      string parent = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public Storage.CreateReadSessionRequest.Builder clearParent()
       Required. String of the form `projects/{project_id}` indicating the
 project this ReadSession is associated with. This is the project that will
 be billed for usage.
      string parent = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public Storage.CreateReadSessionRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. String of the form `projects/{project_id}` indicating the
 project this ReadSession is associated with. This is the project that will
 be billed for usage.
      string parent = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • hasTableModifiers

      public boolean hasTableModifiers()
       Any modifiers to the Table (e.g. snapshot timestamp).
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;
      Specified by:
      hasTableModifiers in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      Whether the tableModifiers field is set.

    • getTableModifiers

      public TableReferenceProto.TableModifiers getTableModifiers()
       Any modifiers to the Table (e.g. snapshot timestamp).
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;
      Specified by:
      getTableModifiers in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The tableModifiers.

    • setTableModifiers

      public Storage.CreateReadSessionRequest.Builder setTableModifiers(TableReferenceProto.TableModifiers value)
       Any modifiers to the Table (e.g. snapshot timestamp).
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

    • setTableModifiers

      public Storage.CreateReadSessionRequest.Builder setTableModifiers(TableReferenceProto.TableModifiers.Builder builderForValue)
       Any modifiers to the Table (e.g. snapshot timestamp).
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

    • mergeTableModifiers

      public Storage.CreateReadSessionRequest.Builder mergeTableModifiers(TableReferenceProto.TableModifiers value)
       Any modifiers to the Table (e.g. snapshot timestamp).
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

    • clearTableModifiers

      public Storage.CreateReadSessionRequest.Builder clearTableModifiers()
       Any modifiers to the Table (e.g. snapshot timestamp).
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

    • getTableModifiersBuilder

      public TableReferenceProto.TableModifiers.Builder getTableModifiersBuilder()
       Any modifiers to the Table (e.g. snapshot timestamp).
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

    • getTableModifiersOrBuilder

      public TableReferenceProto.TableModifiersOrBuilder getTableModifiersOrBuilder()
       Any modifiers to the Table (e.g. snapshot timestamp).
      .google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;
      Specified by:
      getTableModifiersOrBuilder in interface Storage.CreateReadSessionRequestOrBuilder

    • getRequestedStreams

      public int getRequestedStreams()
       Initial number of streams. If unset or 0, we will
 provide a value of streams so as to produce reasonable throughput. Must be
 non-negative. The number of streams may be lower than the requested number,
 depending on the amount parallelism that is reasonable for the table and
 the maximum amount of parallelism allowed by the system.

 Streams must be read starting from offset 0.
      int32 requested_streams = 3;
      Specified by:
      getRequestedStreams in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The requestedStreams.

    • setRequestedStreams

      public Storage.CreateReadSessionRequest.Builder setRequestedStreams(int value)
       Initial number of streams. If unset or 0, we will
 provide a value of streams so as to produce reasonable throughput. Must be
 non-negative. The number of streams may be lower than the requested number,
 depending on the amount parallelism that is reasonable for the table and
 the maximum amount of parallelism allowed by the system.

 Streams must be read starting from offset 0.
      int32 requested_streams = 3;
      Parameters:
      value - The requestedStreams to set.
      Returns:
      This builder for chaining.

    • clearRequestedStreams

      public Storage.CreateReadSessionRequest.Builder clearRequestedStreams()
       Initial number of streams. If unset or 0, we will
 provide a value of streams so as to produce reasonable throughput. Must be
 non-negative. The number of streams may be lower than the requested number,
 depending on the amount parallelism that is reasonable for the table and
 the maximum amount of parallelism allowed by the system.

 Streams must be read starting from offset 0.
      int32 requested_streams = 3;
      Returns:
      This builder for chaining.

    • hasReadOptions

      public boolean hasReadOptions()
       Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;
      Specified by:
      hasReadOptions in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      Whether the readOptions field is set.

    • getReadOptions

      public ReadOptions.TableReadOptions getReadOptions()
       Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;
      Specified by:
      getReadOptions in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The readOptions.

    • setReadOptions

      public Storage.CreateReadSessionRequest.Builder setReadOptions(ReadOptions.TableReadOptions value)
       Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

    • setReadOptions

      public Storage.CreateReadSessionRequest.Builder setReadOptions(ReadOptions.TableReadOptions.Builder builderForValue)
       Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

    • mergeReadOptions

      public Storage.CreateReadSessionRequest.Builder mergeReadOptions(ReadOptions.TableReadOptions value)
       Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

    • clearReadOptions

      public Storage.CreateReadSessionRequest.Builder clearReadOptions()
       Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

    • getReadOptionsBuilder

      public ReadOptions.TableReadOptions.Builder getReadOptionsBuilder()
       Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

    • getReadOptionsOrBuilder

      public ReadOptions.TableReadOptionsOrBuilder getReadOptionsOrBuilder()
       Read options for this session (e.g. column selection, filters).
      .google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;
      Specified by:
      getReadOptionsOrBuilder in interface Storage.CreateReadSessionRequestOrBuilder

    • getFormatValue

      public int getFormatValue()
       Data output format. Currently default to Avro.
 DATA_FORMAT_UNSPECIFIED not supported.
      .google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;
      Specified by:
      getFormatValue in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The enum numeric value on the wire for format.

    • setFormatValue

      public Storage.CreateReadSessionRequest.Builder setFormatValue(int value)
       Data output format. Currently default to Avro.
 DATA_FORMAT_UNSPECIFIED not supported.
      .google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;
      Parameters:
      value - The enum numeric value on the wire for format to set.
      Returns:
      This builder for chaining.

    • getFormat

      public Storage.DataFormat getFormat()
       Data output format. Currently default to Avro.
 DATA_FORMAT_UNSPECIFIED not supported.
      .google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;
      Specified by:
      getFormat in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The format.

    • setFormat

      public Storage.CreateReadSessionRequest.Builder setFormat(Storage.DataFormat value)
       Data output format. Currently default to Avro.
 DATA_FORMAT_UNSPECIFIED not supported.
      .google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;
      Parameters:
      value - The format to set.
      Returns:
      This builder for chaining.

    • clearFormat

      public Storage.CreateReadSessionRequest.Builder clearFormat()
       Data output format. Currently default to Avro.
 DATA_FORMAT_UNSPECIFIED not supported.
      .google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;
      Returns:
      This builder for chaining.

    • getShardingStrategyValue

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

    • setShardingStrategyValue

      public Storage.CreateReadSessionRequest.Builder setShardingStrategyValue(int value)
       The strategy to use for distributing data among multiple streams. Currently
 defaults to liquid sharding.
      .google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 7;
      Parameters:
      value - The enum numeric value on the wire for shardingStrategy to set.
      Returns:
      This builder for chaining.

    • getShardingStrategy

      public Storage.ShardingStrategy getShardingStrategy()
       The strategy to use for distributing data among multiple streams. Currently
 defaults to liquid sharding.
      .google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 7;
      Specified by:
      getShardingStrategy in interface Storage.CreateReadSessionRequestOrBuilder
      Returns:
      The shardingStrategy.

    • setShardingStrategy

      public Storage.CreateReadSessionRequest.Builder setShardingStrategy(Storage.ShardingStrategy value)
       The strategy to use for distributing data among multiple streams. Currently
 defaults to liquid sharding.
      .google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 7;
      Parameters:
      value - The shardingStrategy to set.
      Returns:
      This builder for chaining.

    • clearShardingStrategy

      public Storage.CreateReadSessionRequest.Builder clearShardingStrategy()
       The strategy to use for distributing data among multiple streams. Currently
 defaults to liquid sharding.
      .google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 7;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>

    • mergeUnknownFields

      public final Storage.CreateReadSessionRequest.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<Storage.CreateReadSessionRequest.Builder>