Package com.google.cloud.bigquery.storage.v1beta2

Class ReadSession.TableReadOptions.Builder

    • Method Detail

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

      • 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

      • 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

      • getSelectedFieldsList

        public com.google.protobuf.ProtocolStringList getSelectedFieldsList()
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        repeated string selected_fields = 1;
        Specified by:
        getSelectedFieldsList in interface ReadSession.TableReadOptionsOrBuilder
        Returns:
        A list containing the selectedFields.

      • getSelectedFieldsCount

        public int getSelectedFieldsCount()
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        repeated string selected_fields = 1;
        Specified by:
        getSelectedFieldsCount in interface ReadSession.TableReadOptionsOrBuilder
        Returns:
        The count of selectedFields.

      • getSelectedFields

        public String getSelectedFields​(int index)
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        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)
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        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)
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        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)
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        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)
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        repeated string selected_fields = 1;
        Parameters:
        values - The selectedFields to add.
        Returns:
        This builder for chaining.

      • clearSelectedFields

        public ReadSession.TableReadOptions.Builder clearSelectedFields()
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        repeated string selected_fields = 1;
        Returns:
        This builder for chaining.

      • addSelectedFieldsBytes

        public ReadSession.TableReadOptions.Builder addSelectedFieldsBytes​(com.google.protobuf.ByteString value)
         Names of the fields in the table that should be read. If empty, all
 fields will be read. If the specified field is a nested field, all
 the sub-fields in the field will be selected. The output field order is
 unrelated to the order of fields in selected_fields.
        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.v1beta2.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasArrowSerializationOptions in interface ReadSession.TableReadOptionsOrBuilder
        Returns:
        Whether the arrowSerializationOptions field is set.

      • setArrowSerializationOptions

        public ReadSession.TableReadOptions.Builder setArrowSerializationOptions​(ArrowSerializationOptions value)
         Optional. Options specific to the Apache Arrow output format.
        .google.cloud.bigquery.storage.v1beta2.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.v1beta2.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.v1beta2.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.v1beta2.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.v1beta2.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];