Method: transferConfigs.scheduleRuns

Full name: projects.locations.transferConfigs.scheduleRuns

Creates transfer runs for a time range [startTime, endTime]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use transferConfigs.startManualRuns instead.

HTTP request

POST https://bigquerydatatransfer.googleapis.com/v1/{parent=projects/*/locations/*/transferConfigs/*}:scheduleRuns

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Transfer configuration name. If you are using the regionless method, the location must be US and the name should be in the following form:

  • projects/{projectId}/transferConfigs/{configId}

If you are using the regionalized method, the name should be in the following form:

  • projects/{projectId}/locations/{locationId}/transferConfigs/{configId}

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.transfers.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".
endTime

string (Timestamp format)

Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".

Response body

If successful, the response body contains an instance of ScheduleTransferRunsResponse.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.