Collection: projects.transferConfigs.runs

Resource: TransferRun

Represents a data transfer run.

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

string

The resource name of the transfer run. Transfer run names have the form projects/{projectId}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.

destinationDatasetId

string

The BigQuery target dataset id.

scheduleTime

string (Timestamp format)

Minimum time after which a transfer run can be started.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

startTime

string (Timestamp format)

Time when transfer run was started. Parameter ignored by server for input requests.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Note: This field is used in responses only. Any value specified here in a request is ignored.

endTime

string (Timestamp format)

Time when transfer run ended. Parameter ignored by server for input requests.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Note: This field is used in responses only. Any value specified here in a request is ignored.

updateTime

string (Timestamp format)

Last time the data transfer run status was updated.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Note: This field is used in responses only. Any value specified here in a request is ignored.

dataSourceId

string

Data source id.

Note: This field is used in responses only. Any value specified here in a request is ignored.

status

enum(TransferStatus)

Data transfer run status. Ignored for input requests.

Note: This field is used in responses only. Any value specified here in a request is ignored.

params

object (Struct format)

Data transfer specific parameters.

runTime

string (Timestamp format)

For batch transfer runs, specifies the date and time that data should be ingested.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

userId

string (int64 format)

The user id for this transfer run.

Note: This field is used in responses only. Any value specified here in a request is ignored.

schedule

string

Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are directly created, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so scheduleTime doesn't always matches this.

Note: This field is used in responses only. Any value specified here in a request is ignored.

Methods

delete

Deletes the specified transfer run.

get

Returns information about the particular transfer run.

list

Returns information about running and completed jobs.

Send feedback about...