@swamp/gcp/bigquerydatatransfer
v2026.04.23.1
Google Cloud bigquerydatatransfer infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudbigquerydatatransfercloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/bigquerydatatransfer@swamp/gcp/bigquerydatatransfer/datasourcesv2026.04.23.1datasources.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a dataSources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataSources |
syncSync dataSources state from GCP
check_valid_credscheck valid creds
Resources
state(infinite)— Defines the properties and custom parameters for a data source.
@swamp/gcp/bigquerydatatransfer/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
syncSync locations state from GCP
enroll_data_sourcesenroll data sources
| Argument | Type | Description |
|---|---|---|
| dataSourceIds? | any |
unenroll_data_sourcesunenroll data sources
| Argument | Type | Description |
|---|---|---|
| dataSourceIds? | any |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/bigquerydatatransfer/transferconfigsv2026.04.23.1transferconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| dataRefreshWindowDays? | number | 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. |
| dataSourceId? | string | 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 |
| destinationDatasetId? | string | The BigQuery target dataset id. |
| disabled? | boolean | Is this config disabled. When set to true, no runs will be scheduled for this transfer config. |
| displayName? | string | User specified display name for the data transfer. |
| emailPreferences? | object | Represents preferences for sending email notifications for transfer run events. |
| encryptionConfiguration? | object | Represents the encryption configuration for a transfer. |
| error? | object | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). |
| managedTableType? | enum | The classification of the destination table. |
| name? | string | Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/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. |
| notificationPubsubTopic? | string | 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_id}/topics/{topic_id}` |
| ownerInfo? | object | Information about a user. |
| params? | record | 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 |
| schedule? | string | 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 |
| scheduleOptions? | object | Options customizing the data transfer schedule. |
| scheduleOptionsV2? | object | V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule. |
| userId? | string | Deprecated. Unique ID of the user on whose behalf transfer is done. |
| serviceAccountName? | string | 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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts). |
| versionInfo? | string | Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * T |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a transferConfigs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a transferConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the transferConfigs |
updateUpdate transferConfigs attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the transferConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the transferConfigs |
syncSync transferConfigs state from GCP
schedule_runsschedule runs
| Argument | Type | Description |
|---|---|---|
| endTime? | any | |
| startTime? | any |
start_manual_runsstart manual runs
| Argument | Type | Description |
|---|---|---|
| requestedRunTime? | any | |
| requestedTimeRange? | any |
Resources
state(infinite)— Represents a data transfer configuration. A transfer configuration contains a...
@swamp/gcp/bigquerydatatransfer/transferconfigs-runsv2026.04.23.1transferconfigs_runs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a runs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the runs |
deleteDelete the runs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the runs |
syncSync runs state from GCP
Resources
state(infinite)— Represents a data transfer run.
@swamp/gcp/bigquerydatatransfer/transferconfigs-runs-transferlogsv2026.04.23.1transferconfigs_runs_transferlogs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a transferLogs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the transferLogs |
syncSync transferLogs state from GCP
Resources
state(infinite)— Represents a user facing message for a particular data transfer run.
@swamp/gcp/bigquerydatatransfer/transferconfigs-transferresourcesv2026.04.23.1transferconfigs_transferresources.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a transferResources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the transferResources |
syncSync transferResources state from GCP
Resources
state(infinite)— Resource (table/partition) that is being transferred.
2026.04.11.129.8 KBApr 11, 2026
Google Cloud bigquerydatatransfer infrastructure models
Release Notes
- Updated: transferconfigs_transferresources
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbigquerydatatransfercloudinfrastructure
2026.04.03.327.9 KBApr 3, 2026
Google Cloud bigquerydatatransfer infrastructure models
Release Notes
- Updated: datasources, locations, transferconfigs, transferconfigs_runs, transferconfigs_runs_transferlogs, transferconfigs_transferresources
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbigquerydatatransfercloudinfrastructure
2026.04.03.127.0 KBApr 3, 2026
Google Cloud bigquerydatatransfer infrastructure models
Release Notes
- Updated: datasources, locations, transferconfigs, transferconfigs_runs, transferconfigs_runs_transferlogs, transferconfigs_transferresources
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbigquerydatatransfercloudinfrastructure
2026.04.02.227.0 KBApr 2, 2026
Google Cloud bigquerydatatransfer infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbigquerydatatransfercloudinfrastructure
2026.03.27.128.6 KBMar 27, 2026
Google Cloud bigquerydatatransfer infrastructure models
Release Notes
- Added: datasources, locations, transferconfigs, transferconfigs_runs, transferconfigs_runs_transferlogs, transferconfigs_transferresources
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbigquerydatatransfercloudinfrastructure