GetTransferConfigResult class

Result data returned by getTransferConfig.

Constructors

GetTransferConfigResult({required int dataRefreshWindowDays, required String dataSourceId, required String datasetRegion, required String destinationDatasetId, required bool disabled, required String displayName, required EmailPreferencesResponse emailPreferences, required EncryptionConfigurationResponse encryptionConfiguration, required String name, required String nextRunTime, required String notificationPubsubTopic, required UserInfoResponse ownerInfo, required Map<String, String> params, required String schedule, required ScheduleOptionsResponse scheduleOptions, required String state, required String updateTime, required String userId})
Creates a new GetTransferConfigResult. dataRefreshWindowDays 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 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 datasetRegion Region in which BigQuery dataset is located. destinationDatasetId The BigQuery target dataset id. disabled Is this config disabled. When set to true, no runs are scheduled for a given transfer. displayName User specified display name for the data transfer. emailPreferences Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. encryptionConfiguration The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent. name 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. nextRunTime Next time when data transfer will run. notificationPubsubTopic 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} ownerInfo 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. 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 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. scheduleOptions Options customizing the data transfer schedule. state State of the most recently updated transfer run. updateTime Data transfer modification time. Ignored by server on input. userId Deprecated. Unique ID of the user on whose behalf transfer is done.
const
GetTransferConfigResult.fromMap(Map<String, dynamic> map)
factory

Properties

dataRefreshWindowDays → int
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.
final
datasetRegion → String
Region in which BigQuery dataset is located.
final
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
final
destinationDatasetId → String
The BigQuery target dataset id.
final
disabled → bool
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
final
displayName → String
User specified display name for the data transfer.
final
emailPreferences → EmailPreferencesResponse
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
final
encryptionConfiguration → EncryptionConfigurationResponse
The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
final
hashCode → int
The hash code for this object.
no setterinherited
name → String
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.
final
nextRunTime → String
Next time when data transfer will run.
final
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}/topics/{topic}
final
ownerInfo → UserInfoResponse
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.
final
params → Map<String, String>
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
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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 interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
final
scheduleOptions → ScheduleOptionsResponse
Options customizing the data transfer schedule.
final
state → String
State of the most recently updated transfer run.
final
updateTime → String
Data transfer modification time. Ignored by server on input.
final
userId → String
Deprecated. Unique ID of the user on whose behalf transfer is done.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited