Method: googleapis.bigquerydatatransfer.v1.projects.locations.transferConfigs.runs.list

Returns information about running and completed transfer runs.

Arguments

Parameters
parent

string

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

pageSize

integer (int32 format)

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

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 page_token value to request the next page of list results.

runAttempt

enum

Indicates how run attempts are to be pulled.

Enum type. Can be one of the following:
RUN_ATTEMPT_UNSPECIFIED All runs should be returned.
LATEST Only latest run per day should be returned.
states

enum

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

Enum type. Can be one of the following:
TRANSFER_STATE_UNSPECIFIED State placeholder (0).
PENDING Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
RUNNING Data transfer is in progress (3).
SUCCEEDED Data transfer completed successfully (4).
FAILED Data transfer failed (5).
CANCELLED Data transfer is cancelled (6).

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of ListTransferRunsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.bigquerydatatransfer.v1.projects.locations.transferConfigs.runs.list
    args:
        parent: ...
        pageSize: ...
        pageToken: ...
        runAttempt: ...
        states: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.bigquerydatatransfer.v1.projects.locations.transferConfigs.runs.list",
      "args": {
        "parent": "...",
        "pageSize": "...",
        "pageToken": "...",
        "runAttempt": "...",
        "states": "..."
      },
      "result": "listResult"
    }
  }
]