2.4.0 (latest) 2.3.3 2.2.4 2.1.5 2.0.0 1.8.6 1.7.0 1.6.2 1.5.2 1.4.5 1.3.8 Reference documentation and code samples for the BigQuery Data Transfer V1 Client class ListTransferRunsRequest.

A request to list data transfer runs.

Generated from protobuf message `google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest`

## Namespace

Google \\ Cloud \\ BigQuery \\ DataTransfer \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ 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}`. |
| `↳ states` | `int[]` When specified, only transfer runs with requested states are returned. |
| `↳ page_token` | `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. |
| `↳ page_size` | `int` Page size. The default page size is the maximum value of 1000 results. |
| `↳ run_attempt` | `int` Indicates how run attempts are to be pulled. |

### getParent

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}`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setParent

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}`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStates

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\RepeatedField<int>` |   |

### setStates

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageToken

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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPageToken

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageSize

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setPageSize

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRunAttempt

Indicates how run attempts are to be pulled.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [RunAttempt](https://docs.cloud.google.com/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.ListTransferRunsRequest.RunAttempt). |

### setRunAttempt

Indicates how run attempts are to be pulled.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [RunAttempt](https://docs.cloud.google.com/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.ListTransferRunsRequest.RunAttempt). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `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}`. Please see DataTransferServiceClient::transferConfigName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.ListTransferRunsRequest` |   |