TransferConfigArgs

data class TransferConfigArgs(val authorizationCode: Output<String>? = null, val dataRefreshWindowDays: Output<Int>? = null, val dataSourceId: Output<String>? = null, val destinationDatasetId: Output<String>? = null, val disabled: Output<Boolean>? = null, val displayName: Output<String>? = null, val emailPreferences: Output<EmailPreferencesArgs>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val notificationPubsubTopic: Output<String>? = null, val params: Output<Map<String, String>>? = null, val project: Output<String>? = null, val schedule: Output<String>? = null, val scheduleOptions: Output<ScheduleOptionsArgs>? = null, val serviceAccountName: Output<String>? = null, val userId: Output<String>? = null, val versionInfo: Output<String>? = null) : ConvertibleToJava<TransferConfigArgs>

Creates a new data transfer configuration.

Constructors

Link copied to clipboard
fun TransferConfigArgs(authorizationCode: Output<String>? = null, dataRefreshWindowDays: Output<Int>? = null, dataSourceId: Output<String>? = null, destinationDatasetId: Output<String>? = null, disabled: Output<Boolean>? = null, displayName: Output<String>? = null, emailPreferences: Output<EmailPreferencesArgs>? = null, location: Output<String>? = null, name: Output<String>? = null, notificationPubsubTopic: Output<String>? = null, params: Output<Map<String, String>>? = null, project: Output<String>? = null, schedule: Output<String>? = null, scheduleOptions: Output<ScheduleOptionsArgs>? = null, serviceAccountName: Output<String>? = null, userId: Output<String>? = null, versionInfo: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): TransferConfigArgs

Properties

Link copied to clipboard
val authorizationCode: Output<String>? = null

Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.

Link copied to clipboard
val dataRefreshWindowDays: Output<Int>? = null

The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 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.

Link copied to clipboard
val dataSourceId: Output<String>? = null

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

Link copied to clipboard
val destinationDatasetId: Output<String>? = null

The BigQuery target dataset id.

Link copied to clipboard
val disabled: Output<Boolean>? = null

Is this config disabled. When set to true, no runs are scheduled for a given transfer.

Link copied to clipboard
val displayName: Output<String>? = null

User specified display name for the data transfer.

Link copied to clipboard

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val name: Output<String>? = null

The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/transferConfigs/{config_id}. Where config_id is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

Link copied to clipboard
val notificationPubsubTopic: Output<String>? = null

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project}/topics/{topic}

Link copied to clipboard
val params: Output<Map<String, String>>? = null

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

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val schedule: Output<String>? = null

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.

Link copied to clipboard

Options customizing the data transfer schedule.

Link copied to clipboard
val serviceAccountName: Output<String>? = null

Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.

Link copied to clipboard
val userId: Output<String>? = null

Deprecated. Unique ID of the user on whose behalf transfer is done.

Link copied to clipboard
val versionInfo: Output<String>? = null

Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.