GetTransferConfigResult

data class GetTransferConfigResult(val dataRefreshWindowDays: Int, val dataSourceId: String, val datasetRegion: String, val destinationDatasetId: String, val disabled: Boolean, val displayName: String, val emailPreferences: EmailPreferencesResponse, val name: String, val nextRunTime: String, val notificationPubsubTopic: String, val ownerInfo: UserInfoResponse, val params: Map<String, String>, val schedule: String, val scheduleOptions: ScheduleOptionsResponse, val state: String, val updateTime: String, val userId: String)

Constructors

Link copied to clipboard
fun GetTransferConfigResult(dataRefreshWindowDays: Int, dataSourceId: String, datasetRegion: String, destinationDatasetId: String, disabled: Boolean, displayName: String, emailPreferences: EmailPreferencesResponse, name: String, nextRunTime: String, notificationPubsubTopic: String, ownerInfo: UserInfoResponse, params: Map<String, String>, schedule: String, scheduleOptions: ScheduleOptionsResponse, state: String, updateTime: String, userId: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Region in which BigQuery dataset is located.

Link copied to clipboard

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

The BigQuery target dataset id.

Link copied to clipboard

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

Link copied to clipboard

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

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

Next time when data transfer will run.

Link copied to clipboard

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

Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

Link copied to clipboard

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

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

State of the most recently updated transfer run.

Link copied to clipboard

Data transfer modification time. Ignored by server on input.

Link copied to clipboard

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