google_api_big_query_data_transfer v0.1.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 to: null.
  • dataSourceId (String.t): Data source id. Cannot be changed once data transfer is created. Defaults to: null.
  • datasetRegion (String.t): Output only. Region in which BigQuery dataset is located. Defaults to: null.
  • destinationDatasetId (String.t): The BigQuery target dataset id. Defaults to: null.
  • disabled (boolean()): Is this config disabled. When set to true, no runs are scheduled for a given transfer. Defaults to: null.
  • displayName (String.t): User specified display name for the data transfer. Defaults to: null.
  • name (String.t): The resource name of the transfer config. Transfer config names have the form `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. Defaults to: null.
  • nextRunTime (DateTime.t): Output only. Next time when data transfer will run. Defaults to: null.
  • params (%{optional(String.t) => String.t}): Data transfer specific parameters. Defaults to: null.
  • 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`, 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. Defaults to: null.
  • state (String.t): Output only. State of the most recently updated transfer run. Defaults to: null.

    • Enum - one of [TRANSFER_STATE_UNSPECIFIED, PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED]
  • updateTime (DateTime.t): Output only. Data transfer modification time. Ignored by server on input. Defaults to: null.
  • userId (String.t): Output only. Unique ID of the user on whose behalf transfer is done. Applicable only to data sources that do not support service accounts. When set to 0, the data source service account credentials are used. May be negative. Note, that this identifier is not stable. It may change over time even for the same user. Defaults to: null.

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() :: %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{
  dataRefreshWindowDays: any(),
  dataSourceId: any(),
  datasetRegion: any(),
  destinationDatasetId: any(),
  disabled: any(),
  displayName: any(),
  name: any(),
  nextRunTime: DateTime.t(),
  params: map(),
  schedule: any(),
  state: any(),
  updateTime: DateTime.t(),
  userId: any()
}

Link to this section Functions

Link to this function decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.