Resource: TransferRun
Represents a data transfer run.
JSON representation |
---|
{ "name" : string , "scheduleTime" : string , "runTime" : string , "errorStatus" : { object ( |
name
string
Identifier. The resource name of the transfer run. Transfer run names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}/runs/{run_id}
. The name is ignored when creating a transfer run.
scheduleTime
string (
Timestamp
format)
Minimum time after which a transfer run can be started.
runTime
string (
Timestamp
format)
For batch transfer runs, specifies the date and time of the data should be ingested.
errorStatus
object (
Status
)
Status of the transfer run.
startTime
string (
Timestamp
format)
Output only. Time when transfer run was started. Parameter ignored by server for input requests.
endTime
string (
Timestamp
format)
Output only. Time when transfer run ended. Parameter ignored by server for input requests.
updateTime
string (
Timestamp
format)
Output only. Last time the data transfer run state was updated.
params
object (
Struct
format)
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
dataSourceId
string
Output only. Data source id.
state
enum (
TransferState
)
Data transfer run state. Ignored for input requests.
userId
string ( int64
format)
Deprecated. Unique ID of the user on whose behalf transfer is done.
schedule
string
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 scheduleTime
doesn't always match this.
notificationPubsubTopic
string
Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes.
The format for specifying a pubsub topic is: projects/{projectId}/topics/{topic_id}
emailPreferences
object (
EmailPreferences
)
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.
destination
. Data transfer destination. destination
can be only one of the following:destinationDatasetId
string
Output only. The BigQuery target dataset id.
Status
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC
. Each Status
message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the API Design Guide .
JSON representation |
---|
{ "code" : integer , "message" : string , "details" : [ { "@type" : string , field1 : ... , ... } ] } |
Fields | |
---|---|
code
|
The status code, which should be an enum value of |
details[]
|
A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field |
Methods |
|
---|---|
|
Deletes the specified transfer run. |
|
Returns information about the particular transfer run. |
|
Returns information about running and completed transfer runs. |