google_api_big_query_data_transfer v0.8.0 GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig View Source
Represents a data transfer configuration. A transfer configuration
contains all metadata needed to perform a data transfer. For example,
destination_dataset_id
specifies where data should be stored.
When a new transfer configuration is created, the specified
destination_dataset_id
is created when needed and shared with the
appropriate data source service account.
Attributes
- dataRefreshWindowDays (integer()): 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. Defaults tonil
. - dataSourceId (String.t): Data source id. Cannot be changed once data transfer is created. Defaults to
nil
. - datasetRegion (String.t): Output only. Region in which BigQuery dataset is located. Defaults to
nil
. - destinationDatasetId (String.t): The BigQuery target dataset id. Defaults to
nil
. - disabled (boolean()): Is this config disabled. When set to true, no runs are scheduled
for a given transfer. Defaults to
nil
. - displayName (String.t): User specified display name for the data transfer. Defaults to
nil
. - name (String.t): The resource name of the transfer config.
Transfer config names have the form of
projects/{project_id}/locations/{region}/transferConfigs/{config_id}
. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. Defaults tonil
. - nextRunTime (DateTime.t): Output only. Next time when data transfer will run. Defaults to
nil
. - params (map()): Data transfer specific parameters. Defaults to
nil
. - schedule (String.t): 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
, andfirst 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. Defaults tonil
. - scheduleOptions (GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleOptions.t): Options customizing the data transfer schedule. Defaults to
nil
. - state (String.t): Output only. State of the most recently updated transfer run. Defaults to
nil
. - updateTime (DateTime.t): Output only. Data transfer modification time. Ignored by server on input. Defaults to
nil
. - userId (String.t): Deprecated. Unique ID of the user on whose behalf transfer is done. Defaults to
nil
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{
dataRefreshWindowDays: integer(),
dataSourceId: String.t(),
datasetRegion: String.t(),
destinationDatasetId: String.t(),
disabled: boolean(),
displayName: String.t(),
name: String.t(),
nextRunTime: DateTime.t(),
params: map(),
schedule: String.t(),
scheduleOptions: GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleOptions.t(),
state: String.t(),
updateTime: DateTime.t(),
userId: String.t()
}
t() :: %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{ dataRefreshWindowDays: integer(), dataSourceId: String.t(), datasetRegion: String.t(), destinationDatasetId: String.t(), disabled: boolean(), displayName: String.t(), name: String.t(), nextRunTime: DateTime.t(), params: map(), schedule: String.t(), scheduleOptions: GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleOptions.t(), state: String.t(), updateTime: DateTime.t(), userId: String.t() }
Link to this section Functions
Link to this function
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.