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

Class ReadOptions.TableReadOptions.Builder

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

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

    • mergeFrom

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

    • 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 ReadOptions.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 ReadOptions.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 ReadOptions.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 ReadOptions.TableReadOptionsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedFields at the given index.

    • setSelectedFields

      public ReadOptions.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 ReadOptions.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 ReadOptions.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 ReadOptions.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 ReadOptions.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()
       Optional. SQL text filtering statement, similar to a WHERE clause in
 a SQL 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 ReadOptions.TableReadOptionsOrBuilder
      Returns:
      The rowRestriction.

    • getRowRestrictionBytes

      public com.google.protobuf.ByteString getRowRestrictionBytes()
       Optional. SQL text filtering statement, similar to a WHERE clause in
 a SQL 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 ReadOptions.TableReadOptionsOrBuilder
      Returns:
      The bytes for rowRestriction.

    • setRowRestriction

      public ReadOptions.TableReadOptions.Builder setRowRestriction(String value)
       Optional. SQL text filtering statement, similar to a WHERE clause in
 a SQL 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 ReadOptions.TableReadOptions.Builder clearRowRestriction()
       Optional. SQL text filtering statement, similar to a WHERE clause in
 a SQL 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 ReadOptions.TableReadOptions.Builder setRowRestrictionBytes(com.google.protobuf.ByteString value)
       Optional. SQL text filtering statement, similar to a WHERE clause in
 a SQL 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.

    • setUnknownFields

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

    • mergeUnknownFields

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