You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* `pubsubSubscription` (*type:* `String.t`, *default:* `nil`) - Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}
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.
21
+
22
+
## Attributes
23
+
24
+
* `eventDrivenSchedule` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.EventDrivenSchedule.t`, *default:* `nil`) - Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.
25
+
* `manualSchedule` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.ManualSchedule.t`, *default:* `nil`) - Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.
26
+
* `timeBasedSchedule` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.TimeBasedSchedule.t`, *default:* `nil`) - Time based transfer schedule options. This is the default schedule option.
Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
21
+
22
+
## Attributes
23
+
24
+
* `endTime` (*type:* `DateTime.t`, *default:* `nil`) - Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.
25
+
* `schedule` (*type:* `String.t`, *default:* `nil`) - 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.
26
+
* `startTime` (*type:* `DateTime.t`, *default:* `nil`) - Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.
Copy file name to clipboardExpand all lines: clients/big_query_data_transfer/lib/google_api/big_query_data_transfer/v1/model/transfer_config.ex
+7Lines changed: 7 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -29,13 +29,15 @@ defmodule GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig do
29
29
* `displayName` (*type:* `String.t`, *default:* `nil`) - User specified display name for the data transfer.
30
30
* `emailPreferences` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.EmailPreferences.t`, *default:* `nil`) - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
31
31
* `encryptionConfiguration` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.EncryptionConfiguration.t`, *default:* `nil`) - 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.
32
+
* `error` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.Status.t`, *default:* `nil`) - Output only. Error code with detailed information about reason of the latest config failure.
32
33
* `name` (*type:* `String.t`, *default:* `nil`) - 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.
33
34
* `nextRunTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. Next time when data transfer will run.
34
35
* `notificationPubsubTopic` (*type:* `String.t`, *default:* `nil`) - 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}`
35
36
* `ownerInfo` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.UserInfo.t`, *default:* `nil`) - Output only. 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.
36
37
* `params` (*type:* `map()`, *default:* `nil`) - 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
37
38
* `schedule` (*type:* `String.t`, *default:* `nil`) - 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.
38
39
* `scheduleOptions` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleOptions.t`, *default:* `nil`) - Options customizing the data transfer schedule.
40
+
* `scheduleOptionsV2` (*type:* `GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleOptionsV2.t`, *default:* `nil`) - Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
39
41
* `state` (*type:* `String.t`, *default:* `nil`) - Output only. State of the most recently updated transfer run.
40
42
* `updateTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. Data transfer modification time. Ignored by server on input.
41
43
* `userId` (*type:* `String.t`, *default:* `nil`) - Deprecated. Unique ID of the user on whose behalf transfer is done.
@@ -53,13 +55,16 @@ defmodule GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig do
0 commit comments