import * as pulumi from "@pulumi/pulumi"; import { input as inputs, output as outputs } from "../../types"; /** * Creates a new data transfer configuration. */ export declare class TransferConfig extends pulumi.CustomResource { /** * Get an existing TransferConfig resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): TransferConfig; /** * Returns true if the given object is an instance of TransferConfig. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is TransferConfig; /** * 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. */ readonly dataRefreshWindowDays: pulumi.Output; /** * Data source id. Cannot be changed once data transfer is created. */ readonly dataSourceId: pulumi.Output; /** * Region in which BigQuery dataset is located. */ readonly datasetRegion: pulumi.Output; /** * The BigQuery target dataset id. */ readonly destinationDatasetId: pulumi.Output; /** * Is this config disabled. When set to true, no runs are scheduled for a given transfer. */ readonly disabled: pulumi.Output; /** * User specified display name for the data transfer. */ readonly displayName: pulumi.Output; /** * Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. */ readonly emailPreferences: pulumi.Output; /** * 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. */ readonly name: pulumi.Output; /** * Next time when data transfer will run. */ readonly nextRunTime: pulumi.Output; /** * Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. */ readonly notificationPubsubTopic: pulumi.Output; /** * 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 */ readonly params: pulumi.Output<{ [key: string]: 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 granularity should be at least 8 hours, or less frequent. */ readonly schedule: pulumi.Output; /** * Options customizing the data transfer schedule. */ readonly scheduleOptions: pulumi.Output; /** * State of the most recently updated transfer run. */ readonly state: pulumi.Output; /** * Data transfer modification time. Ignored by server on input. */ readonly updateTime: pulumi.Output; /** * Create a TransferConfig resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: TransferConfigArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a TransferConfig resource. */ export interface TransferConfigArgs { /** * 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. */ readonly dataRefreshWindowDays?: pulumi.Input; /** * Data source id. Cannot be changed once data transfer is created. */ readonly dataSourceId?: pulumi.Input; /** * The BigQuery target dataset id. */ readonly destinationDatasetId?: pulumi.Input; /** * Is this config disabled. When set to true, no runs are scheduled for a given transfer. */ readonly disabled?: pulumi.Input; /** * User specified display name for the data transfer. */ readonly displayName?: pulumi.Input; /** * Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. */ readonly emailPreferences?: pulumi.Input; /** * 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. */ readonly name?: pulumi.Input; /** * Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. */ readonly notificationPubsubTopic?: pulumi.Input; /** * 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 */ readonly params?: pulumi.Input<{ [key: string]: pulumi.Input; }>; readonly projectsId: pulumi.Input; /** * 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 granularity should be at least 8 hours, or less frequent. */ readonly schedule?: pulumi.Input; /** * Options customizing the data transfer schedule. */ readonly scheduleOptions?: pulumi.Input; readonly transferConfigsId: pulumi.Input; }