GoogleApi.BigQueryDataTransfer.V1.Model.TransferRun (google_api_big_query_data_transfer v0.23.0) View Source

Represents a data transfer run.

Attributes

dataSourceId (type: String.t, default: nil) - Output only. Data source id.
destinationDatasetId (type: String.t, default: nil) - Output only. The BigQuery target dataset id.
emailPreferences (type: GoogleApi.BigQueryDataTransfer.V1.Model.EmailPreferences.t, default: nil) - Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
endTime (type: DateTime.t, default: nil) - Output only. Time when transfer run ended. Parameter ignored by server for input requests.
errorStatus (type: GoogleApi.BigQueryDataTransfer.V1.Model.Status.t, default: nil) - Status of the transfer run.
name (type: String.t, default: nil) - The resource name of the transfer run. Transfer run names have the form projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.
notificationPubsubTopic (type: String.t, default: nil) - Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
params (type: map(), default: nil) - Output only. 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
runTime (type: DateTime.t, default: nil) - For batch transfer runs, specifies the date and time of the data should be ingested.
schedule (type: String.t, default: nil) - Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so schedule_time doesn't always match this.
scheduleTime (type: DateTime.t, default: nil) - Minimum time after which a transfer run can be started.
startTime (type: DateTime.t, default: nil) - Output only. Time when transfer run was started. Parameter ignored by server for input requests.
state (type: String.t, default: nil) - Data transfer run state. Ignored for input requests.
updateTime (type: DateTime.t, default: nil) - Output only. Last time the data transfer run state was updated.
userId (type: String.t, default: nil) - Deprecated. Unique ID of the user on whose behalf transfer is done.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

Specs

t() :: %GoogleApi.BigQueryDataTransfer.V1.Model.TransferRun{
  dataSourceId: String.t() | nil,
  destinationDatasetId: String.t() | nil,
  emailPreferences:
    GoogleApi.BigQueryDataTransfer.V1.Model.EmailPreferences.t() | nil,
  endTime: DateTime.t() | nil,
  errorStatus: GoogleApi.BigQueryDataTransfer.V1.Model.Status.t() | nil,
  name: String.t() | nil,
  notificationPubsubTopic: String.t() | nil,
  params: map() | nil,
  runTime: DateTime.t() | nil,
  schedule: String.t() | nil,
  scheduleTime: DateTime.t() | nil,
  startTime: DateTime.t() | nil,
  state: String.t() | nil,
  updateTime: DateTime.t() | nil,
  userId: String.t() | nil
}

Link to this section Functions

decode(value, options)

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.