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

Class ReadSession.TableReadOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>
com.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.Builder
All Implemented Interfaces:
ReadSession.TableReadOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ReadSession.TableReadOptions
public static final class ReadSession.TableReadOptions.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder> implements ReadSession.TableReadOptionsOrBuilder
 Options dictating how we read a table.
Protobuf type google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

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

    • clear

      public ReadSession.TableReadOptions.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.TableReadOptions.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.TableReadOptions.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public ReadSession.TableReadOptions.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.TableReadOptions.Builder>

    • setField

      public ReadSession.TableReadOptions.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.TableReadOptions.Builder>

    • clearField

      public ReadSession.TableReadOptions.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.TableReadOptions.Builder>

    • clearOneof

      public ReadSession.TableReadOptions.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.TableReadOptions.Builder>

    • setRepeatedField

      public ReadSession.TableReadOptions.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.TableReadOptions.Builder>

    • addRepeatedField

      public ReadSession.TableReadOptions.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.TableReadOptions.Builder>

    • mergeFrom

      public ReadSession.TableReadOptions.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.TableReadOptions.Builder>

    • mergeFrom

      public ReadSession.TableReadOptions.Builder mergeFrom(ReadSession.TableReadOptions 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.TableReadOptions.Builder>

    • mergeFrom

      public ReadSession.TableReadOptions.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.TableReadOptions.Builder>
      Throws:
      IOException

    • getOutputFormatSerializationOptionsCase

      public ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase getOutputFormatSerializationOptionsCase()
      Specified by:
      getOutputFormatSerializationOptionsCase in interface ReadSession.TableReadOptionsOrBuilder

    • clearOutputFormatSerializationOptions

      public ReadSession.TableReadOptions.Builder clearOutputFormatSerializationOptions()

    • getSelectedFieldsList

      public com.google.protobuf.ProtocolStringList getSelectedFieldsList()
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Specified by:
      getSelectedFieldsList in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      A list containing the selectedFields.

    • getSelectedFieldsCount

      public int getSelectedFieldsCount()
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Specified by:
      getSelectedFieldsCount in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      The count of selectedFields.

    • getSelectedFields

      public String getSelectedFields(int index)
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Specified by:
      getSelectedFields in interface ReadSession.TableReadOptionsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The selectedFields at the given index.

    • getSelectedFieldsBytes

      public com.google.protobuf.ByteString getSelectedFieldsBytes(int index)
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Specified by:
      getSelectedFieldsBytes in interface ReadSession.TableReadOptionsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedFields at the given index.

    • setSelectedFields

      public ReadSession.TableReadOptions.Builder setSelectedFields(int index, String value)
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Parameters:
      index - The index to set the value at.
      value - The selectedFields to set.
      Returns:
      This builder for chaining.

    • addSelectedFields

      public ReadSession.TableReadOptions.Builder addSelectedFields(String value)
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Parameters:
      value - The selectedFields to add.
      Returns:
      This builder for chaining.

    • addAllSelectedFields

      public ReadSession.TableReadOptions.Builder addAllSelectedFields(Iterable<String> values)
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Parameters:
      values - The selectedFields to add.
      Returns:
      This builder for chaining.

    • clearSelectedFields

      public ReadSession.TableReadOptions.Builder clearSelectedFields()
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Returns:
      This builder for chaining.

    • addSelectedFieldsBytes

      public ReadSession.TableReadOptions.Builder addSelectedFieldsBytes(com.google.protobuf.ByteString value)
       Optional. The names of the fields in the table to be returned. If no
 field names are specified, then all fields in the table are returned.

 Nested fields -- the child elements of a STRUCT field -- can be selected
 individually using their fully-qualified names, and will be returned as
 record fields containing only the selected nested fields. If a STRUCT
 field is specified in the selected fields list, all of the child elements
 will be returned.

 As an example, consider a table with the following schema:

   {
       "name": "struct_field",
       "type": "RECORD",
       "mode": "NULLABLE",
       "fields": [
           {
               "name": "string_field1",
               "type": "STRING",
 .              "mode": "NULLABLE"
           },
           {
               "name": "string_field2",
               "type": "STRING",
               "mode": "NULLABLE"
           }
       ]
   }

 Specifying "struct_field" in the selected fields list will result in a
 read session schema with the following logical structure:

   struct_field {
       string_field1
       string_field2
   }

 Specifying "struct_field.string_field1" in the selected fields list will
 result in a read session schema with the following logical structure:

   struct_field {
       string_field1
   }

 The order of the fields in the read session schema is derived from the
 table schema and does not correspond to the order in which the fields are
 specified in this list.
      repeated string selected_fields = 1;
      Parameters:
      value - The bytes of the selectedFields to add.
      Returns:
      This builder for chaining.

    • getRowRestriction

      public String getRowRestriction()
       SQL text filtering statement, similar to a WHERE clause in a query.
 Aggregates are not supported.

 Examples: "int_field > 5"
           "date_field = CAST('2014-9-27' as DATE)"
           "nullable_field is not NULL"
           "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
           "numeric_field BETWEEN 1.0 AND 5.0"

 Restricted to a maximum length for 1 MB.
      string row_restriction = 2;
      Specified by:
      getRowRestriction in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      The rowRestriction.

    • getRowRestrictionBytes

      public com.google.protobuf.ByteString getRowRestrictionBytes()
       SQL text filtering statement, similar to a WHERE clause in a query.
 Aggregates are not supported.

 Examples: "int_field > 5"
           "date_field = CAST('2014-9-27' as DATE)"
           "nullable_field is not NULL"
           "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
           "numeric_field BETWEEN 1.0 AND 5.0"

 Restricted to a maximum length for 1 MB.
      string row_restriction = 2;
      Specified by:
      getRowRestrictionBytes in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      The bytes for rowRestriction.

    • setRowRestriction

      public ReadSession.TableReadOptions.Builder setRowRestriction(String value)
       SQL text filtering statement, similar to a WHERE clause in a query.
 Aggregates are not supported.

 Examples: "int_field > 5"
           "date_field = CAST('2014-9-27' as DATE)"
           "nullable_field is not NULL"
           "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
           "numeric_field BETWEEN 1.0 AND 5.0"

 Restricted to a maximum length for 1 MB.
      string row_restriction = 2;
      Parameters:
      value - The rowRestriction to set.
      Returns:
      This builder for chaining.

    • clearRowRestriction

      public ReadSession.TableReadOptions.Builder clearRowRestriction()
       SQL text filtering statement, similar to a WHERE clause in a query.
 Aggregates are not supported.

 Examples: "int_field > 5"
           "date_field = CAST('2014-9-27' as DATE)"
           "nullable_field is not NULL"
           "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
           "numeric_field BETWEEN 1.0 AND 5.0"

 Restricted to a maximum length for 1 MB.
      string row_restriction = 2;
      Returns:
      This builder for chaining.

    • setRowRestrictionBytes

      public ReadSession.TableReadOptions.Builder setRowRestrictionBytes(com.google.protobuf.ByteString value)
       SQL text filtering statement, similar to a WHERE clause in a query.
 Aggregates are not supported.

 Examples: "int_field > 5"
           "date_field = CAST('2014-9-27' as DATE)"
           "nullable_field is not NULL"
           "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
           "numeric_field BETWEEN 1.0 AND 5.0"

 Restricted to a maximum length for 1 MB.
      string row_restriction = 2;
      Parameters:
      value - The bytes for rowRestriction to set.
      Returns:
      This builder for chaining.

    • hasArrowSerializationOptions

      public boolean hasArrowSerializationOptions()
       Optional. Options specific to the Apache Arrow output format.
      .google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasArrowSerializationOptions in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      Whether the arrowSerializationOptions field is set.

    • getArrowSerializationOptions

      public ArrowSerializationOptions getArrowSerializationOptions()
       Optional. Options specific to the Apache Arrow output format.
      .google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArrowSerializationOptions in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      The arrowSerializationOptions.

    • setArrowSerializationOptions

      public ReadSession.TableReadOptions.Builder setArrowSerializationOptions(ArrowSerializationOptions value)
       Optional. Options specific to the Apache Arrow output format.
      .google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • setArrowSerializationOptions

      public ReadSession.TableReadOptions.Builder setArrowSerializationOptions(ArrowSerializationOptions.Builder builderForValue)
       Optional. Options specific to the Apache Arrow output format.
      .google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • mergeArrowSerializationOptions

      public ReadSession.TableReadOptions.Builder mergeArrowSerializationOptions(ArrowSerializationOptions value)
       Optional. Options specific to the Apache Arrow output format.
      .google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • clearArrowSerializationOptions

      public ReadSession.TableReadOptions.Builder clearArrowSerializationOptions()
       Optional. Options specific to the Apache Arrow output format.
      .google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getArrowSerializationOptionsBuilder

      public ArrowSerializationOptions.Builder getArrowSerializationOptionsBuilder()
       Optional. Options specific to the Apache Arrow output format.
      .google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getArrowSerializationOptionsOrBuilder

      public ArrowSerializationOptionsOrBuilder getArrowSerializationOptionsOrBuilder()
       Optional. Options specific to the Apache Arrow output format.
      .google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArrowSerializationOptionsOrBuilder in interface ReadSession.TableReadOptionsOrBuilder

    • hasAvroSerializationOptions

      public boolean hasAvroSerializationOptions()
       Optional. Options specific to the Apache Avro output format
      .google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAvroSerializationOptions in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      Whether the avroSerializationOptions field is set.

    • getAvroSerializationOptions

      public AvroSerializationOptions getAvroSerializationOptions()
       Optional. Options specific to the Apache Avro output format
      .google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAvroSerializationOptions in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      The avroSerializationOptions.

    • setAvroSerializationOptions

      public ReadSession.TableReadOptions.Builder setAvroSerializationOptions(AvroSerializationOptions value)
       Optional. Options specific to the Apache Avro output format
      .google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setAvroSerializationOptions

      public ReadSession.TableReadOptions.Builder setAvroSerializationOptions(AvroSerializationOptions.Builder builderForValue)
       Optional. Options specific to the Apache Avro output format
      .google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];

    • mergeAvroSerializationOptions

      public ReadSession.TableReadOptions.Builder mergeAvroSerializationOptions(AvroSerializationOptions value)
       Optional. Options specific to the Apache Avro output format
      .google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];

    • clearAvroSerializationOptions

      public ReadSession.TableReadOptions.Builder clearAvroSerializationOptions()
       Optional. Options specific to the Apache Avro output format
      .google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAvroSerializationOptionsBuilder

      public AvroSerializationOptions.Builder getAvroSerializationOptionsBuilder()
       Optional. Options specific to the Apache Avro output format
      .google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAvroSerializationOptionsOrBuilder

      public AvroSerializationOptionsOrBuilder getAvroSerializationOptionsOrBuilder()
       Optional. Options specific to the Apache Avro output format
      .google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAvroSerializationOptionsOrBuilder in interface ReadSession.TableReadOptionsOrBuilder

    • hasSamplePercentage

      public boolean hasSamplePercentage()
       Optional. Specifies a table sampling percentage. Specifically, the query
 planner will use TABLESAMPLE SYSTEM (sample_percentage PERCENT). The
 sampling percentage is applied at the data block granularity. It will
 randomly choose for each data block whether to read the rows in that data
 block. For more details, see
 https://cloud.google.com/bigquery/docs/table-sampling)
      optional double sample_percentage = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSamplePercentage in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      Whether the samplePercentage field is set.

    • getSamplePercentage

      public double getSamplePercentage()
       Optional. Specifies a table sampling percentage. Specifically, the query
 planner will use TABLESAMPLE SYSTEM (sample_percentage PERCENT). The
 sampling percentage is applied at the data block granularity. It will
 randomly choose for each data block whether to read the rows in that data
 block. For more details, see
 https://cloud.google.com/bigquery/docs/table-sampling)
      optional double sample_percentage = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSamplePercentage in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      The samplePercentage.

    • setSamplePercentage

      public ReadSession.TableReadOptions.Builder setSamplePercentage(double value)
       Optional. Specifies a table sampling percentage. Specifically, the query
 planner will use TABLESAMPLE SYSTEM (sample_percentage PERCENT). The
 sampling percentage is applied at the data block granularity. It will
 randomly choose for each data block whether to read the rows in that data
 block. For more details, see
 https://cloud.google.com/bigquery/docs/table-sampling)
      optional double sample_percentage = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The samplePercentage to set.
      Returns:
      This builder for chaining.

    • clearSamplePercentage

      public ReadSession.TableReadOptions.Builder clearSamplePercentage()
       Optional. Specifies a table sampling percentage. Specifically, the query
 planner will use TABLESAMPLE SYSTEM (sample_percentage PERCENT). The
 sampling percentage is applied at the data block granularity. It will
 randomly choose for each data block whether to read the rows in that data
 block. For more details, see
 https://cloud.google.com/bigquery/docs/table-sampling)
      optional double sample_percentage = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasResponseCompressionCodec

      public boolean hasResponseCompressionCodec()
       Optional. Set response_compression_codec when creating a read session to
 enable application-level compression of ReadRows responses.
      optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasResponseCompressionCodec in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      Whether the responseCompressionCodec field is set.

    • getResponseCompressionCodecValue

      public int getResponseCompressionCodecValue()
       Optional. Set response_compression_codec when creating a read session to
 enable application-level compression of ReadRows responses.
      optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResponseCompressionCodecValue in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for responseCompressionCodec.

    • setResponseCompressionCodecValue

      public ReadSession.TableReadOptions.Builder setResponseCompressionCodecValue(int value)
       Optional. Set response_compression_codec when creating a read session to
 enable application-level compression of ReadRows responses.
      optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for responseCompressionCodec to set.
      Returns:
      This builder for chaining.

    • getResponseCompressionCodec

      public ReadSession.TableReadOptions.ResponseCompressionCodec getResponseCompressionCodec()
       Optional. Set response_compression_codec when creating a read session to
 enable application-level compression of ReadRows responses.
      optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResponseCompressionCodec in interface ReadSession.TableReadOptionsOrBuilder
      Returns:
      The responseCompressionCodec.

    • setResponseCompressionCodec

      public ReadSession.TableReadOptions.Builder setResponseCompressionCodec(ReadSession.TableReadOptions.ResponseCompressionCodec value)
       Optional. Set response_compression_codec when creating a read session to
 enable application-level compression of ReadRows responses.
      optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The responseCompressionCodec to set.
      Returns:
      This builder for chaining.

    • clearResponseCompressionCodec

      public ReadSession.TableReadOptions.Builder clearResponseCompressionCodec()
       Optional. Set response_compression_codec when creating a read session to
 enable application-level compression of ReadRows responses.
      optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final ReadSession.TableReadOptions.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.TableReadOptions.Builder>

    • mergeUnknownFields

      public final ReadSession.TableReadOptions.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.TableReadOptions.Builder>