Class BigQuerySource.Builder

  • All Implemented Interfaces:
    BigQuerySourceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    BigQuerySource

    public static final class BigQuerySource.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<BigQuerySource.Builder>
    implements BigQuerySourceOrBuilder
     BigQuery source import data from.
     
    Protobuf type google.cloud.retail.v2beta.BigQuerySource
    • 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<BigQuerySource.Builder>
      • clear

        public BigQuerySource.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<BigQuerySource.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<BigQuerySource.Builder>
      • getDefaultInstanceForType

        public BigQuerySource getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public BigQuerySource build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public BigQuerySource buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public BigQuerySource.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<BigQuerySource.Builder>
      • setField

        public BigQuerySource.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<BigQuerySource.Builder>
      • clearField

        public BigQuerySource.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<BigQuerySource.Builder>
      • clearOneof

        public BigQuerySource.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<BigQuerySource.Builder>
      • setRepeatedField

        public BigQuerySource.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<BigQuerySource.Builder>
      • addRepeatedField

        public BigQuerySource.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<BigQuerySource.Builder>
      • mergeFrom

        public BigQuerySource.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<BigQuerySource.Builder>
      • isInitialized

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

        public BigQuerySource.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<BigQuerySource.Builder>
        Throws:
        IOException
      • hasPartitionDate

        public boolean hasPartitionDate()
         BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
        
         Only supported in
         [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
         
        .google.type.Date partition_date = 6;
        Specified by:
        hasPartitionDate in interface BigQuerySourceOrBuilder
        Returns:
        Whether the partitionDate field is set.
      • getPartitionDate

        public com.google.type.Date getPartitionDate()
         BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
        
         Only supported in
         [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
         
        .google.type.Date partition_date = 6;
        Specified by:
        getPartitionDate in interface BigQuerySourceOrBuilder
        Returns:
        The partitionDate.
      • setPartitionDate

        public BigQuerySource.Builder setPartitionDate​(com.google.type.Date value)
         BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
        
         Only supported in
         [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
         
        .google.type.Date partition_date = 6;
      • setPartitionDate

        public BigQuerySource.Builder setPartitionDate​(com.google.type.Date.Builder builderForValue)
         BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
        
         Only supported in
         [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
         
        .google.type.Date partition_date = 6;
      • mergePartitionDate

        public BigQuerySource.Builder mergePartitionDate​(com.google.type.Date value)
         BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
        
         Only supported in
         [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
         
        .google.type.Date partition_date = 6;
      • clearPartitionDate

        public BigQuerySource.Builder clearPartitionDate()
         BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
        
         Only supported in
         [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
         
        .google.type.Date partition_date = 6;
      • getPartitionDateBuilder

        public com.google.type.Date.Builder getPartitionDateBuilder()
         BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
        
         Only supported in
         [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
         
        .google.type.Date partition_date = 6;
      • getPartitionDateOrBuilder

        public com.google.type.DateOrBuilder getPartitionDateOrBuilder()
         BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
        
         Only supported in
         [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
         
        .google.type.Date partition_date = 6;
        Specified by:
        getPartitionDateOrBuilder in interface BigQuerySourceOrBuilder
      • getProjectId

        public String getProjectId()
         The project ID (can be project # or ID) that the BigQuery source is in with
         a length limit of 128 characters. If not specified, inherits the project
         ID from the parent request.
         
        string project_id = 5;
        Specified by:
        getProjectId in interface BigQuerySourceOrBuilder
        Returns:
        The projectId.
      • getProjectIdBytes

        public com.google.protobuf.ByteString getProjectIdBytes()
         The project ID (can be project # or ID) that the BigQuery source is in with
         a length limit of 128 characters. If not specified, inherits the project
         ID from the parent request.
         
        string project_id = 5;
        Specified by:
        getProjectIdBytes in interface BigQuerySourceOrBuilder
        Returns:
        The bytes for projectId.
      • setProjectId

        public BigQuerySource.Builder setProjectId​(String value)
         The project ID (can be project # or ID) that the BigQuery source is in with
         a length limit of 128 characters. If not specified, inherits the project
         ID from the parent request.
         
        string project_id = 5;
        Parameters:
        value - The projectId to set.
        Returns:
        This builder for chaining.
      • clearProjectId

        public BigQuerySource.Builder clearProjectId()
         The project ID (can be project # or ID) that the BigQuery source is in with
         a length limit of 128 characters. If not specified, inherits the project
         ID from the parent request.
         
        string project_id = 5;
        Returns:
        This builder for chaining.
      • setProjectIdBytes

        public BigQuerySource.Builder setProjectIdBytes​(com.google.protobuf.ByteString value)
         The project ID (can be project # or ID) that the BigQuery source is in with
         a length limit of 128 characters. If not specified, inherits the project
         ID from the parent request.
         
        string project_id = 5;
        Parameters:
        value - The bytes for projectId to set.
        Returns:
        This builder for chaining.
      • getDatasetId

        public String getDatasetId()
         Required. The BigQuery data set to copy the data from with a length limit
         of 1,024 characters.
         
        string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDatasetId in interface BigQuerySourceOrBuilder
        Returns:
        The datasetId.
      • getDatasetIdBytes

        public com.google.protobuf.ByteString getDatasetIdBytes()
         Required. The BigQuery data set to copy the data from with a length limit
         of 1,024 characters.
         
        string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDatasetIdBytes in interface BigQuerySourceOrBuilder
        Returns:
        The bytes for datasetId.
      • setDatasetId

        public BigQuerySource.Builder setDatasetId​(String value)
         Required. The BigQuery data set to copy the data from with a length limit
         of 1,024 characters.
         
        string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The datasetId to set.
        Returns:
        This builder for chaining.
      • clearDatasetId

        public BigQuerySource.Builder clearDatasetId()
         Required. The BigQuery data set to copy the data from with a length limit
         of 1,024 characters.
         
        string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.
      • setDatasetIdBytes

        public BigQuerySource.Builder setDatasetIdBytes​(com.google.protobuf.ByteString value)
         Required. The BigQuery data set to copy the data from with a length limit
         of 1,024 characters.
         
        string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for datasetId to set.
        Returns:
        This builder for chaining.
      • getTableId

        public String getTableId()
         Required. The BigQuery table to copy the data from with a length limit of
         1,024 characters.
         
        string table_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTableId in interface BigQuerySourceOrBuilder
        Returns:
        The tableId.
      • getTableIdBytes

        public com.google.protobuf.ByteString getTableIdBytes()
         Required. The BigQuery table to copy the data from with a length limit of
         1,024 characters.
         
        string table_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTableIdBytes in interface BigQuerySourceOrBuilder
        Returns:
        The bytes for tableId.
      • setTableId

        public BigQuerySource.Builder setTableId​(String value)
         Required. The BigQuery table to copy the data from with a length limit of
         1,024 characters.
         
        string table_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The tableId to set.
        Returns:
        This builder for chaining.
      • clearTableId

        public BigQuerySource.Builder clearTableId()
         Required. The BigQuery table to copy the data from with a length limit of
         1,024 characters.
         
        string table_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.
      • setTableIdBytes

        public BigQuerySource.Builder setTableIdBytes​(com.google.protobuf.ByteString value)
         Required. The BigQuery table to copy the data from with a length limit of
         1,024 characters.
         
        string table_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for tableId to set.
        Returns:
        This builder for chaining.
      • getGcsStagingDir

        public String getGcsStagingDir()
         Intermediate Cloud Storage directory used for the import with a length
         limit of 2,000 characters. Can be specified if one wants to have the
         BigQuery export to a specific Cloud Storage directory.
         
        string gcs_staging_dir = 3;
        Specified by:
        getGcsStagingDir in interface BigQuerySourceOrBuilder
        Returns:
        The gcsStagingDir.
      • getGcsStagingDirBytes

        public com.google.protobuf.ByteString getGcsStagingDirBytes()
         Intermediate Cloud Storage directory used for the import with a length
         limit of 2,000 characters. Can be specified if one wants to have the
         BigQuery export to a specific Cloud Storage directory.
         
        string gcs_staging_dir = 3;
        Specified by:
        getGcsStagingDirBytes in interface BigQuerySourceOrBuilder
        Returns:
        The bytes for gcsStagingDir.
      • setGcsStagingDir

        public BigQuerySource.Builder setGcsStagingDir​(String value)
         Intermediate Cloud Storage directory used for the import with a length
         limit of 2,000 characters. Can be specified if one wants to have the
         BigQuery export to a specific Cloud Storage directory.
         
        string gcs_staging_dir = 3;
        Parameters:
        value - The gcsStagingDir to set.
        Returns:
        This builder for chaining.
      • clearGcsStagingDir

        public BigQuerySource.Builder clearGcsStagingDir()
         Intermediate Cloud Storage directory used for the import with a length
         limit of 2,000 characters. Can be specified if one wants to have the
         BigQuery export to a specific Cloud Storage directory.
         
        string gcs_staging_dir = 3;
        Returns:
        This builder for chaining.
      • setGcsStagingDirBytes

        public BigQuerySource.Builder setGcsStagingDirBytes​(com.google.protobuf.ByteString value)
         Intermediate Cloud Storage directory used for the import with a length
         limit of 2,000 characters. Can be specified if one wants to have the
         BigQuery export to a specific Cloud Storage directory.
         
        string gcs_staging_dir = 3;
        Parameters:
        value - The bytes for gcsStagingDir to set.
        Returns:
        This builder for chaining.
      • getDataSchema

        public String getDataSchema()
         The schema to use when parsing the data from the source.
        
         Supported values for product imports:
        
         * `product` (default): One JSON
         [Product][google.cloud.retail.v2beta.Product] per line. Each product must
           have a valid [Product.id][google.cloud.retail.v2beta.Product.id].
         * `product_merchant_center`: See [Importing catalog data from Merchant
           Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
        
         Supported values for user events imports:
        
         * `user_event` (default): One JSON
         [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.
         * `user_event_ga360`:
           The schema is available here:
           https://support.google.com/analytics/answer/3437719.
         * `user_event_ga4`:
           The schema is available here:
           https://support.google.com/analytics/answer/7029846.
        
         Supported values for autocomplete imports:
        
         * `suggestions` (default): One JSON completion suggestion per line.
         * `denylist`:  One JSON deny suggestion per line.
         * `allowlist`:  One JSON allow suggestion per line.
         
        string data_schema = 4;
        Specified by:
        getDataSchema in interface BigQuerySourceOrBuilder
        Returns:
        The dataSchema.
      • getDataSchemaBytes

        public com.google.protobuf.ByteString getDataSchemaBytes()
         The schema to use when parsing the data from the source.
        
         Supported values for product imports:
        
         * `product` (default): One JSON
         [Product][google.cloud.retail.v2beta.Product] per line. Each product must
           have a valid [Product.id][google.cloud.retail.v2beta.Product.id].
         * `product_merchant_center`: See [Importing catalog data from Merchant
           Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
        
         Supported values for user events imports:
        
         * `user_event` (default): One JSON
         [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.
         * `user_event_ga360`:
           The schema is available here:
           https://support.google.com/analytics/answer/3437719.
         * `user_event_ga4`:
           The schema is available here:
           https://support.google.com/analytics/answer/7029846.
        
         Supported values for autocomplete imports:
        
         * `suggestions` (default): One JSON completion suggestion per line.
         * `denylist`:  One JSON deny suggestion per line.
         * `allowlist`:  One JSON allow suggestion per line.
         
        string data_schema = 4;
        Specified by:
        getDataSchemaBytes in interface BigQuerySourceOrBuilder
        Returns:
        The bytes for dataSchema.
      • setDataSchema

        public BigQuerySource.Builder setDataSchema​(String value)
         The schema to use when parsing the data from the source.
        
         Supported values for product imports:
        
         * `product` (default): One JSON
         [Product][google.cloud.retail.v2beta.Product] per line. Each product must
           have a valid [Product.id][google.cloud.retail.v2beta.Product.id].
         * `product_merchant_center`: See [Importing catalog data from Merchant
           Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
        
         Supported values for user events imports:
        
         * `user_event` (default): One JSON
         [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.
         * `user_event_ga360`:
           The schema is available here:
           https://support.google.com/analytics/answer/3437719.
         * `user_event_ga4`:
           The schema is available here:
           https://support.google.com/analytics/answer/7029846.
        
         Supported values for autocomplete imports:
        
         * `suggestions` (default): One JSON completion suggestion per line.
         * `denylist`:  One JSON deny suggestion per line.
         * `allowlist`:  One JSON allow suggestion per line.
         
        string data_schema = 4;
        Parameters:
        value - The dataSchema to set.
        Returns:
        This builder for chaining.
      • clearDataSchema

        public BigQuerySource.Builder clearDataSchema()
         The schema to use when parsing the data from the source.
        
         Supported values for product imports:
        
         * `product` (default): One JSON
         [Product][google.cloud.retail.v2beta.Product] per line. Each product must
           have a valid [Product.id][google.cloud.retail.v2beta.Product.id].
         * `product_merchant_center`: See [Importing catalog data from Merchant
           Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
        
         Supported values for user events imports:
        
         * `user_event` (default): One JSON
         [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.
         * `user_event_ga360`:
           The schema is available here:
           https://support.google.com/analytics/answer/3437719.
         * `user_event_ga4`:
           The schema is available here:
           https://support.google.com/analytics/answer/7029846.
        
         Supported values for autocomplete imports:
        
         * `suggestions` (default): One JSON completion suggestion per line.
         * `denylist`:  One JSON deny suggestion per line.
         * `allowlist`:  One JSON allow suggestion per line.
         
        string data_schema = 4;
        Returns:
        This builder for chaining.
      • setDataSchemaBytes

        public BigQuerySource.Builder setDataSchemaBytes​(com.google.protobuf.ByteString value)
         The schema to use when parsing the data from the source.
        
         Supported values for product imports:
        
         * `product` (default): One JSON
         [Product][google.cloud.retail.v2beta.Product] per line. Each product must
           have a valid [Product.id][google.cloud.retail.v2beta.Product.id].
         * `product_merchant_center`: See [Importing catalog data from Merchant
           Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
        
         Supported values for user events imports:
        
         * `user_event` (default): One JSON
         [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.
         * `user_event_ga360`:
           The schema is available here:
           https://support.google.com/analytics/answer/3437719.
         * `user_event_ga4`:
           The schema is available here:
           https://support.google.com/analytics/answer/7029846.
        
         Supported values for autocomplete imports:
        
         * `suggestions` (default): One JSON completion suggestion per line.
         * `denylist`:  One JSON deny suggestion per line.
         * `allowlist`:  One JSON allow suggestion per line.
         
        string data_schema = 4;
        Parameters:
        value - The bytes for dataSchema to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final BigQuerySource.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<BigQuerySource.Builder>
      • mergeUnknownFields

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