REST Resource: projects.transferConfigs.runs

Resource: TransferRun

Represents a data transfer run.

JSON representation
{
  "name": string,
  "scheduleTime": string,
  "runTime": string,
  "errorStatus": {
    object(Status)
  },
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "params": {
    object
  },
  "destinationDatasetId": string,
  "dataSourceId": string,
  "state": enum(TransferState),
  "userId": string,
  "schedule": string
}
Fields
name

string

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 that 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. Data transfer specific parameters.

destinationDatasetId

string

Output only. The BigQuery target dataset id.

dataSourceId

string

Output only. Data source id.

state

enum(TransferState)

Data transfer run state. Ignored for input requests.

userId

string (int64 format)

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.

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 matches this.

Methods

delete

Deletes the specified transfer run.

get

Returns information about the particular transfer run.

list

Returns information about running and completed jobs.
Was this page helpful? Let us know how we did:

Send feedback about...