class ProjectsLocationsTransferConfigs extends Resource (View source)

The "transferConfigs" collection of methods.

Typical usage is:

 $bigquerydatatransferService = new Google\Service\BigQueryDataTransfer(...);
 $transferConfigs = $bigquerydatatransferService->projects_locations_transferConfigs;

Methods

create(string $parent, TransferConfig $postBody, array $optParams = [])

Creates a new data transfer configuration. (transferConfigs.create)

delete(string $name, array $optParams = [])

Deletes a data transfer configuration, including any associated transfer runs and logs. (transferConfigs.delete)

get(string $name, array $optParams = [])

Returns information about a data transfer config. (transferConfigs.get)

listProjectsLocationsTransferConfigs(string $parent, array $optParams = [])

Returns information about all transfer configs owned by a project in the specified location. (transferConfigs.listProjectsLocationsTransferConfigs)

patch(string $name, TransferConfig $postBody, array $optParams = [])

Updates a data transfer configuration. All fields must be set, even if they are not updated. (transferConfigs.patch)

scheduleRuns(string $parent, ScheduleTransferRunsRequest $postBody, array $optParams = [])

Creates transfer runs for a time range [start_time, end_time]. For each date

  • or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

startManualRuns(string $parent, StartManualTransferRunsRequest $postBody, array $optParams = [])

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. (transferConfigs.startManualRuns)

Details

TransferConfig create(string $parent, TransferConfig $postBody, array $optParams = [])

Creates a new data transfer configuration. (transferConfigs.create)

Parameters

string $parent

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

TransferConfig $postBody
array $optParams

Optional parameters.

Return Value

TransferConfig

Exceptions

Exception

BigquerydatatransferEmpty delete(string $name, array $optParams = [])

Deletes a data transfer configuration, including any associated transfer runs and logs. (transferConfigs.delete)

Parameters

string $name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

array $optParams

Optional parameters.

Return Value

BigquerydatatransferEmpty

Exceptions

Exception

TransferConfig get(string $name, array $optParams = [])

Returns information about a data transfer config. (transferConfigs.get)

Parameters

string $name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

array $optParams

Optional parameters.

Return Value

TransferConfig

Exceptions

Exception

ListTransferConfigsResponse listProjectsLocationsTransferConfigs(string $parent, array $optParams = [])

Returns information about all transfer configs owned by a project in the specified location. (transferConfigs.listProjectsLocationsTransferConfigs)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

ListTransferConfigsResponse

Exceptions

Exception

TransferConfig patch(string $name, TransferConfig $postBody, array $optParams = [])

Updates a data transfer configuration. All fields must be set, even if they are not updated. (transferConfigs.patch)

Parameters

string $name

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

TransferConfig $postBody
array $optParams

Optional parameters.

Return Value

TransferConfig

Exceptions

Exception

ScheduleTransferRunsResponse scheduleRuns(string $parent, ScheduleTransferRunsRequest $postBody, array $optParams = [])

Creates transfer runs for a time range [start_time, end_time]. For each date

  • or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

(transferConfigs.scheduleRuns)

Parameters

string $parent

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

ScheduleTransferRunsRequest $postBody
array $optParams

Optional parameters.

Return Value

ScheduleTransferRunsResponse

Exceptions

Exception

StartManualTransferRunsResponse startManualRuns(string $parent, StartManualTransferRunsRequest $postBody, array $optParams = [])

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. (transferConfigs.startManualRuns)

Parameters

string $parent

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

StartManualTransferRunsRequest $postBody
array $optParams

Optional parameters.

Return Value

StartManualTransferRunsResponse

Exceptions

Exception