BigQuery Data Transfer V1 Client - Class ListTransferConfigsRequest (2.1.1)

Reference documentation and code samples for the BigQuery Data Transfer V1 Client class ListTransferConfigsRequest.

A request to list data transfers configured for a BigQuery project.

Generated from protobuf message google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest

Namespace

Google \ Cloud \ BigQuery \ DataTransfer \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}
↳ data_source_ids array

When specified, only configurations of requested data sources are returned.
↳ page_token string

Pagination token, which can be used to request a specific page of ListTransfersRequest list results. For multiple-page results, ListTransfersResponse 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.

getParent

Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

Returns
Type Description
string

setParent

Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDataSourceIds

When specified, only configurations of requested data sources are returned.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDataSourceIds

When specified, only configurations of requested data sources are returned.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getPageToken

Pagination token, which can be used to request a specific page of ListTransfersRequest list results. For multiple-page results, ListTransfersResponse 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 ListTransfersRequest list results. For multiple-page results, ListTransfersResponse 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

static::build

Parameter
Name Description
parent string

Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id} Please see DataTransferServiceClient::projectName() for help formatting this field.
Returns
Type Description
ListTransferConfigsRequest