Method: projects.transferConfigs.runs.list

Returns information about running and completed jobs.

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
parent

string

Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{projectId}/transferConfigs/{config_id}.

Query parameters

Parameters
statuses

enum(TransferStatus)

When specified, only transfer runs with requested statuses 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

number

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 data with the following structure:

The returned list of pipelines in the project.

JSON representation
{
  "transferRuns": [
    {
      object(TransferRun)
    }
  ],
  "nextPageToken": string,
}
Fields
transferRuns[]

object(TransferRun)

The stored pipeline transfer runs.

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

nextPageToken

string

The next-pagination token. For multiple-page list results, this token can be used as the ListTransferRunsRequest.page_token to request the next page of list results.

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

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/bigquery.readonly

For more information, see the Auth Guide.

RunAttempt

Represents which runs should be pulled.

Enums
RUN_ATTEMPT_UNSPECIFIED All runs should be returned.
LATEST Only latest run per day should be returned.

Send feedback about...