DataTransferConfigState class

Input properties used for looking up and filtering DataTransferConfig resources.

Constructors

DataTransferConfigState({Input<int?>? dataRefreshWindowDays, Input<String?>? dataSourceId, Input<String?>? deletionPolicy, Input<String?>? destinationDatasetId, Input<bool?>? disabled, Input<String?>? displayName, Input<DataTransferConfigEmailPreferences?>? emailPreferences, Input<DataTransferConfigEncryptionConfiguration?>? encryptionConfiguration, Input<String?>? location, Input<String?>? name, Input<String?>? notificationPubsubTopic, Input<Map<String, String>?>? params, Input<String?>? project, Input<String?>? schedule, Input<DataTransferConfigScheduleOptions?>? scheduleOptions, Input<DataTransferConfigSensitiveParams?>? sensitiveParams, Input<String?>? serviceAccountName})
Creates a new DataTransferConfigState. dataRefreshWindowDays The number of days to look back to automatically refresh the data. dataSourceId The data source id. Cannot be changed once the transfer config is created. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. destinationDatasetId The BigQuery target dataset id. disabled When set to true, no runs are scheduled for a given transfer. displayName The user specified display name for the transfer config. emailPreferences Email notifications will be sent according to these preferences to the encryptionConfiguration Represents the encryption configuration for a transfer. location The geographic location where the transfer config should reside. name The resource name of the transfer config. Transfer config names have the notificationPubsubTopic Pub/Sub topic where notifications will be sent after transfer runs params Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' project The ID of the project in which the resource belongs. schedule Data transfer schedule. If the data source does not support a custom scheduleOptions Options customizing the data transfer schedule. sensitiveParams Different parameters are configured primarily using the the params field on this serviceAccountName Service account email. If this field is set, transfer config will
const
DataTransferConfigState.fromMap(Map<String, dynamic> map)
factory

Properties

dataRefreshWindowDays → Input<int?>?
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.
final
dataSourceId → Input<String?>?
The data source id. Cannot be changed once the transfer config is created.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
destinationDatasetId → Input<String?>?
The BigQuery target dataset id.
final
disabled → Input<bool?>?
When set to true, no runs are scheduled for a given transfer.
final
displayName → Input<String?>?
The user specified display name for the transfer config.
final
emailPreferences → Input<DataTransferConfigEmailPreferences?>?
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
final
encryptionConfiguration → Input<DataTransferConfigEncryptionConfiguration?>?
Represents the encryption configuration for a transfer. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
location → Input<String?>?
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
final
name → Input<String?>?
The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
final
notificationPubsubTopic → Input<String?>?
Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
final
params → Input<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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedule → Input<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 → Input<DataTransferConfigScheduleOptions?>?
Options customizing the data transfer schedule. Structure is documented below.
final
sensitiveParams → Input<DataTransferConfigSensitiveParams?>?
Different parameters are configured primarily using the the params field on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in the params map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.
final
serviceAccountName → Input<String?>?
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.
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