Package com.hashicorp.cdktf.providers.google.bigquery_data_transfer_config

Class BigqueryDataTransferConfigConfig.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • dataSourceId

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder dataSourceId​(String dataSourceId)
        Sets the value of BigqueryDataTransferConfigConfig.getDataSourceId()
        Parameters:
        dataSourceId - The data source id. Cannot be changed once the transfer config is created. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#data_source_id BigqueryDataTransferConfig#data_source_id}
        Returns:
        this

      • displayName

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder displayName​(String displayName)
        Sets the value of BigqueryDataTransferConfigConfig.getDisplayName()
        Parameters:
        displayName - The user specified display name for the transfer config. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#display_name BigqueryDataTransferConfig#display_name}
        Returns:
        this

      • params

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder params​(Map<String,​String> params)
        Sets the value of BigqueryDataTransferConfigConfig.getParams()
        Parameters:
        params - Parameters specific to each data source. This parameter is required. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq **NOTE** : If you are attempting to update a parameter that cannot be updated (due to api limitations) [please force recreation of the resource](https://www.terraform.io/cli/state/taint#forcing-re-creation-of-resources). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#params BigqueryDataTransferConfig#params}
        Returns:
        this

      • dataRefreshWindowDays

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder dataRefreshWindowDays​(Number dataRefreshWindowDays)
        Sets the value of BigqueryDataTransferConfigConfig.getDataRefreshWindowDays()
        Parameters:
        dataRefreshWindowDays - The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#data_refresh_window_days BigqueryDataTransferConfig#data_refresh_window_days}
        Returns:
        this

      • destinationDatasetId

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder destinationDatasetId​(String destinationDatasetId)
        Sets the value of BigqueryDataTransferConfigConfig.getDestinationDatasetId()
        Parameters:
        destinationDatasetId - The BigQuery target dataset id. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#destination_dataset_id BigqueryDataTransferConfig#destination_dataset_id}
        Returns:
        this

      • disabled

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder disabled​(com.hashicorp.cdktf.IResolvable disabled)
        Sets the value of BigqueryDataTransferConfigConfig.getDisabled()
        Parameters:
        disabled - When set to true, no runs are scheduled for a given transfer. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#disabled BigqueryDataTransferConfig#disabled}
        Returns:
        this

      • id

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder id​(String id)
        Sets the value of BigqueryDataTransferConfigConfig.getId()
        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#id BigqueryDataTransferConfig#id}. Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
        Returns:
        this

      • location

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder location​(String location)
        Sets the value of BigqueryDataTransferConfigConfig.getLocation()
        Parameters:
        location - The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#location BigqueryDataTransferConfig#location}
        Returns:
        this

      • notificationPubsubTopic

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder notificationPubsubTopic​(String notificationPubsubTopic)
        Sets the value of BigqueryDataTransferConfigConfig.getNotificationPubsubTopic()
        Parameters:
        notificationPubsubTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#notification_pubsub_topic BigqueryDataTransferConfig#notification_pubsub_topic}
        Returns:
        this

      • schedule

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder schedule​(String schedule)
        Sets the value of BigqueryDataTransferConfigConfig.getSchedule()
        Parameters:
        schedule - Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#schedule BigqueryDataTransferConfig#schedule}
        Returns:
        this

      • serviceAccountName

        @Stability(Stable)
public BigqueryDataTransferConfigConfig.Builder serviceAccountName​(String serviceAccountName)
        Sets the value of BigqueryDataTransferConfigConfig.getServiceAccountName()
        Parameters:
        serviceAccountName - Service account email. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#service_account_name BigqueryDataTransferConfig#service_account_name}
        Returns:
        this

      • connection

        @Stability(Experimental)
public BigqueryDataTransferConfigConfig.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • connection

        @Stability(Experimental)
public BigqueryDataTransferConfigConfig.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public BigqueryDataTransferConfigConfig.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public BigqueryDataTransferConfigConfig.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Sets the value of TerraformMetaArguments.getDependsOn()
        Parameters:
        dependsOn - the value to be set.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public BigqueryDataTransferConfigConfig.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Sets the value of TerraformMetaArguments.getForEach()
        Parameters:
        forEach - the value to be set.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public BigqueryDataTransferConfigConfig.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Sets the value of TerraformMetaArguments.getLifecycle()
        Parameters:
        lifecycle - the value to be set.
        Returns:
        this

      • provider

        @Stability(Experimental)
public BigqueryDataTransferConfigConfig.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Sets the value of TerraformMetaArguments.getProvider()
        Parameters:
        provider - the value to be set.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public BigqueryDataTransferConfigConfig.Builder provisioners​(List<? extends Object> provisioners)
        Sets the value of TerraformMetaArguments.getProvisioners()
        Parameters:
        provisioners - the value to be set.
        Returns:
        this