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

Class Storage.CreateReadSessionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequest
All Implemented Interfaces:
Storage.CreateReadSessionRequestOrBuilder, 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.CreateReadSessionRequest extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Field Details

    • TABLE_REFERENCE_FIELD_NUMBER

      public static final int TABLE_REFERENCE_FIELD_NUMBER
      See Also:

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • TABLE_MODIFIERS_FIELD_NUMBER

      public static final int TABLE_MODIFIERS_FIELD_NUMBER
      See Also:

    • REQUESTED_STREAMS_FIELD_NUMBER

      public static final int REQUESTED_STREAMS_FIELD_NUMBER
      See Also:

    • READ_OPTIONS_FIELD_NUMBER

      public static final int READ_OPTIONS_FIELD_NUMBER
      See Also:

    • FORMAT_FIELD_NUMBER

      public static final int FORMAT_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

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

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

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

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

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

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

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

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

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Storage.CreateReadSessionRequest.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Storage.CreateReadSessionRequest getDefaultInstance()

    • parser

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

    • getParserForType

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