* $bigquerydatatransferService = new Google\Service\BigQueryDataTransfer(...); * $transferConfigs = $bigquerydatatransferService->transferConfigs; * */ class ProjectsLocationsTransferConfigs extends \Google\Service\Resource { /** * Creates a new data transfer configuration. (transferConfigs.create) * * @param 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. * @param TransferConfig $postBody * @param array $optParams Optional parameters. * * @opt_param string authorizationCode Optional OAuth2 authorization code to use * with this transfer configuration. This is required only if * `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are * needed, as indicated by `CheckValidCreds`. In order to obtain * authorization_code, make a request to the following URL: * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? * client_id=client_id=data_source_scopes * _uri=urn:ietf:wg:oauth:2.0:oob_type=authorization_code * The client_id is the * OAuth client_id of the a data source as returned by ListDataSources method. * * data_source_scopes are the scopes returned by ListDataSources method. Note * that this should not be set when `service_account_name` is used to create the * transfer config. * @opt_param string serviceAccountName Optional service account name. If this * field is set, the transfer config will be created with this service account's * credentials. It requires that the requesting user calling this API has * permissions to act as this service account. Note that not all data sources * support service account credentials when creating a transfer config. For the * latest list of data sources, read about [using service * accounts](https://cloud.google.com/bigquery-transfer/docs/use-service- * accounts). * @opt_param string versionInfo Optional version info. This is required only if * `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials * are needed, as indicated by `CheckValidCreds`. In order to obtain version * info, make a request to the following URL: * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? * client_id=client_id=data_source_scopes * _uri=urn:ietf:wg:oauth:2.0:oob_type=version_info * The client_id is the OAuth * client_id of the a data source as returned by ListDataSources method. * * data_source_scopes are the scopes returned by ListDataSources method. Note * that this should not be set when `service_account_name` is used to create the * transfer config. * @return TransferConfig */ public function create($parent, TransferConfig $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], TransferConfig::class); } /** * Deletes a data transfer configuration, including any associated transfer runs * and logs. (transferConfigs.delete) * * @param 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}` * @param array $optParams Optional parameters. * @return BigquerydatatransferEmpty */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], BigquerydatatransferEmpty::class); } /** * Returns information about a data transfer config. (transferConfigs.get) * * @param 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}` * @param array $optParams Optional parameters. * @return TransferConfig */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], TransferConfig::class); } /** * Returns information about all transfer configs owned by a project in the * specified location. (transferConfigs.listProjectsLocationsTransferConfigs) * * @param string $parent Required. The BigQuery project id for which transfer * configs should be returned: `projects/{project_id}` or * `projects/{project_id}/locations/{location_id}` * @param array $optParams Optional parameters. * * @opt_param string dataSourceIds When specified, only configurations of * requested data sources are returned. * @opt_param int pageSize Page size. The default page size is the maximum value * of 1000 results. * @opt_param string pageToken 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. * @return ListTransferConfigsResponse */ public function listProjectsLocationsTransferConfigs($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListTransferConfigsResponse::class); } /** * Updates a data transfer configuration. All fields must be set, even if they * are not updated. (transferConfigs.patch) * * @param string $name The resource name of the transfer config. Transfer config * names have the form * `projects/{project_id}/locations/{region}/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. * @param TransferConfig $postBody * @param array $optParams Optional parameters. * * @opt_param string authorizationCode Optional OAuth2 authorization code to use * with this transfer configuration. This is required only if * `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are * needed, as indicated by `CheckValidCreds`. In order to obtain * authorization_code, make a request to the following URL: * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? * client_id=client_id=data_source_scopes * _uri=urn:ietf:wg:oauth:2.0:oob_type=authorization_code * The client_id is the * OAuth client_id of the a data source as returned by ListDataSources method. * * data_source_scopes are the scopes returned by ListDataSources method. Note * that this should not be set when `service_account_name` is used to update the * transfer config. * @opt_param string serviceAccountName Optional service account name. If this * field is set, the transfer config will be created with this service account's * credentials. It requires that the requesting user calling this API has * permissions to act as this service account. Note that not all data sources * support service account credentials when creating a transfer config. For the * latest list of data sources, read about [using service * accounts](https://cloud.google.com/bigquery-transfer/docs/use-service- * accounts). * @opt_param string updateMask Required. Required list of fields to be updated * in this request. * @opt_param string versionInfo Optional version info. This is required only if * `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials * are needed, as indicated by `CheckValidCreds`. In order to obtain version * info, make a request to the following URL: * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth? * client_id=client_id=data_source_scopes * _uri=urn:ietf:wg:oauth:2.0:oob_type=version_info * The client_id is the OAuth * client_id of the a data source as returned by ListDataSources method. * * data_source_scopes are the scopes returned by ListDataSources method. Note * that this should not be set when `service_account_name` is used to update the * transfer config. * @return TransferConfig */ public function patch($name, TransferConfig $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], TransferConfig::class); } /** * 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) * * @param 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}`. * @param ScheduleTransferRunsRequest $postBody * @param array $optParams Optional parameters. * @return ScheduleTransferRunsResponse */ public function scheduleRuns($parent, ScheduleTransferRunsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('scheduleRuns', [$params], ScheduleTransferRunsResponse::class); } /** * 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) * * @param string $parent Transfer configuration name in the form: * `projects/{project_id}/transferConfigs/{config_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * @param StartManualTransferRunsRequest $postBody * @param array $optParams Optional parameters. * @return StartManualTransferRunsResponse */ public function startManualRuns($parent, StartManualTransferRunsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('startManualRuns', [$params], StartManualTransferRunsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsTransferConfigs::class, 'Google_Service_BigQueryDataTransfer_Resource_ProjectsLocationsTransferConfigs');