Method: runs.list

Full name: projects.transferConfigs.runs.list

Returns information about running and completed transfer runs.

HTTP request

GET https://bigquerydatatransfer.googleapis.com/v1/{parent=projects/*/transferConfigs/*}/runs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{projectId}/transferConfigs/{configId} or projects/{projectId}/locations/{locationId}/transferConfigs/{configId}.

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

  • bigquery.transfers.get

Query parameters

Parameters
states[]

enum (TransferState)

When specified, only transfer runs with requested states are returned.
pageToken

string

Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the pageToken value to request the next page of list results.
pageSize

integer

Page size. The default page size is the maximum value of 1000 results.
runAttempt

enum (RunAttempt)

Indicates how run attempts are to be pulled.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.