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

Class BigqueryDataTransferConfig.Builder

    • Method Detail

      • connection

        @Stability(Experimental)
public BigqueryDataTransferConfig.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public BigqueryDataTransferConfig.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public BigqueryDataTransferConfig.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public BigqueryDataTransferConfig.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public BigqueryDataTransferConfig.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public BigqueryDataTransferConfig.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public BigqueryDataTransferConfig.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • dataSourceId

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder dataSourceId​(String dataSourceId)
        The data source id. Cannot be changed once the transfer config is created.

        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}

        Parameters:
        dataSourceId - The data source id. Cannot be changed once the transfer config is created. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder displayName​(String displayName)
        The user specified display name for the transfer config.

        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}

        Parameters:
        displayName - The user specified display name for the transfer config. This parameter is required.
        Returns:
        this

      • params

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder params​(Map<String,​String> params)
        Parameters specific to each data source.

        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}

        Parameters:
        params - Parameters specific to each data source. This parameter is required.
        Returns:
        this

      • dataRefreshWindowDays

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder dataRefreshWindowDays​(Number 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}

        Parameters:
        dataRefreshWindowDays - The number of days to look back to automatically refresh the data. This parameter is required.
        Returns:
        this

      • destinationDatasetId

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder destinationDatasetId​(String 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}

        Parameters:
        destinationDatasetId - The BigQuery target dataset id. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder disabled​(Boolean 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}

        Parameters:
        disabled - When set to true, no runs are scheduled for a given transfer. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder disabled​(com.hashicorp.cdktf.IResolvable 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}

        Parameters:
        disabled - When set to true, no runs are scheduled for a given transfer. This parameter is required.
        Returns:
        this

      • emailPreferences

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder emailPreferences​(BigqueryDataTransferConfigEmailPreferences emailPreferences)
        email_preferences block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#email_preferences BigqueryDataTransferConfig#email_preferences}

        Parameters:
        emailPreferences - email_preferences block. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder id​(String 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.

        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}. This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder location​(String 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}

        Parameters:
        location - The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US. This parameter is required.
        Returns:
        this

      • notificationPubsubTopic

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder notificationPubsubTopic​(String 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}

        Parameters:
        notificationPubsubTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#project BigqueryDataTransferConfig#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#project BigqueryDataTransferConfig#project}. This parameter is required.
        Returns:
        this

      • schedule

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder schedule​(String 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}

        Parameters:
        schedule - Data transfer schedule. This parameter is required.
        Returns:
        this

      • scheduleOptions

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder scheduleOptions​(BigqueryDataTransferConfigScheduleOptions scheduleOptions)
        schedule_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#schedule_options BigqueryDataTransferConfig#schedule_options}

        Parameters:
        scheduleOptions - schedule_options block. This parameter is required.
        Returns:
        this

      • sensitiveParams

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder sensitiveParams​(BigqueryDataTransferConfigSensitiveParams sensitiveParams)
        sensitive_params block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#sensitive_params BigqueryDataTransferConfig#sensitive_params}

        Parameters:
        sensitiveParams - sensitive_params block. This parameter is required.
        Returns:
        this

      • serviceAccountName

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder serviceAccountName​(String 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}

        Parameters:
        serviceAccountName - Service account email. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public BigqueryDataTransferConfig.Builder timeouts​(BigqueryDataTransferConfigTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_data_transfer_config#timeouts BigqueryDataTransferConfig#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this