BigQuery Data Transfer V1 Client - Class DataTransferServiceClient (2.0.0-RC1)

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

Service Description: This API allows users to manage their data transfers into BigQuery.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ BigQuery \ DataTransfer \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

checkValidCreds

Returns true if valid credentials exist for the given data source and requesting user.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::checkValidCredsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\CheckValidCredsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\CheckValidCredsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\CheckValidCredsRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\CheckValidCredsResponse;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;

/**
 * @param string $formattedName The data source in the form:
 *                              `projects/{project_id}/dataSources/{data_source_id}` or
 *                              `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. Please see
 *                              {@see DataTransferServiceClient::dataSourceName()} for help formatting this field.
 */
function check_valid_creds_sample(string $formattedName): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new CheckValidCredsRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var CheckValidCredsResponse $response */
        $response = $dataTransferServiceClient->checkValidCreds($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DataTransferServiceClient::dataSourceName('[PROJECT]', '[DATA_SOURCE]');

    check_valid_creds_sample($formattedName);
}

createTransferConfig

Creates a new data transfer configuration.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::createTransferConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\CreateTransferConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\CreateTransferConfigRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig;

/**
 * @param string $formattedParent 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. Please see
 *                                {@see DataTransferServiceClient::projectName()} for help formatting this field.
 */
function create_transfer_config_sample(string $formattedParent): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $transferConfig = new TransferConfig();
    $request = (new CreateTransferConfigRequest())
        ->setParent($formattedParent)
        ->setTransferConfig($transferConfig);

    // Call the API and handle any network failures.
    try {
        /** @var TransferConfig $response */
        $response = $dataTransferServiceClient->createTransferConfig($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DataTransferServiceClient::projectName('[PROJECT]');

    create_transfer_config_sample($formattedParent);
}

deleteTransferConfig

Deletes a data transfer configuration, including any associated transfer runs and logs.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::deleteTransferConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\DeleteTransferConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\DeleteTransferConfigRequest;

/**
 * @param string $formattedName 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}`
 *                              Please see {@see DataTransferServiceClient::transferConfigName()} for help formatting this field.
 */
function delete_transfer_config_sample(string $formattedName): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new DeleteTransferConfigRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $dataTransferServiceClient->deleteTransferConfig($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DataTransferServiceClient::transferConfigName('[PROJECT]', '[TRANSFER_CONFIG]');

    delete_transfer_config_sample($formattedName);
}

deleteTransferRun

Deletes the specified transfer run.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::deleteTransferRunAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\DeleteTransferRunRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\DeleteTransferRunRequest;

/**
 * @param string $formattedName The field will contain name of the resource requested, for
 *                              example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
 *                              or
 *                              `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
 *                              Please see {@see DataTransferServiceClient::runName()} for help formatting this field.
 */
function delete_transfer_run_sample(string $formattedName): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new DeleteTransferRunRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $dataTransferServiceClient->deleteTransferRun($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DataTransferServiceClient::runName('[PROJECT]', '[TRANSFER_CONFIG]', '[RUN]');

    delete_transfer_run_sample($formattedName);
}

enrollDataSources

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::enrollDataSourcesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\EnrollDataSourcesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\EnrollDataSourcesRequest;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function enroll_data_sources_sample(): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = new EnrollDataSourcesRequest();

    // Call the API and handle any network failures.
    try {
        $dataTransferServiceClient->enrollDataSources($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getDataSource

Retrieves a supported data source and returns its settings.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::getDataSourceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\GetDataSourceRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\DataSource`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\DataSource;
use Google\Cloud\BigQuery\DataTransfer\V1\GetDataSourceRequest;

/**
 * @param string $formattedName The field will contain name of the resource requested, for
 *                              example: `projects/{project_id}/dataSources/{data_source_id}` or
 *                              `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
 *                              Please see {@see DataTransferServiceClient::dataSourceName()} for help formatting this field.
 */
function get_data_source_sample(string $formattedName): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new GetDataSourceRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var DataSource $response */
        $response = $dataTransferServiceClient->getDataSource($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DataTransferServiceClient::dataSourceName('[PROJECT]', '[DATA_SOURCE]');

    get_data_source_sample($formattedName);
}

getTransferConfig

Returns information about a data transfer config.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::getTransferConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\GetTransferConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\GetTransferConfigRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig;

/**
 * @param string $formattedName 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}`
 *                              Please see {@see DataTransferServiceClient::transferConfigName()} for help formatting this field.
 */
function get_transfer_config_sample(string $formattedName): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new GetTransferConfigRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var TransferConfig $response */
        $response = $dataTransferServiceClient->getTransferConfig($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DataTransferServiceClient::transferConfigName('[PROJECT]', '[TRANSFER_CONFIG]');

    get_transfer_config_sample($formattedName);
}

getTransferRun

Returns information about the particular transfer run.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::getTransferRunAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\GetTransferRunRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\TransferRun`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\GetTransferRunRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\TransferRun;

/**
 * @param string $formattedName The field will contain name of the resource requested, for
 *                              example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
 *                              or
 *                              `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
 *                              Please see {@see DataTransferServiceClient::runName()} for help formatting this field.
 */
function get_transfer_run_sample(string $formattedName): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new GetTransferRunRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var TransferRun $response */
        $response = $dataTransferServiceClient->getTransferRun($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DataTransferServiceClient::runName('[PROJECT]', '[TRANSFER_CONFIG]', '[RUN]');

    get_transfer_run_sample($formattedName);
}

listDataSources

Lists supported data sources and returns their settings.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::listDataSourcesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ListDataSourcesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\DataSource;
use Google\Cloud\BigQuery\DataTransfer\V1\ListDataSourcesRequest;

/**
 * @param string $formattedParent The BigQuery project id for which data sources should be
 *                                returned. Must be in the form: `projects/{project_id}` or
 *                                `projects/{project_id}/locations/{location_id}`
 *                                Please see {@see DataTransferServiceClient::projectName()} for help formatting this field.
 */
function list_data_sources_sample(string $formattedParent): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new ListDataSourcesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $dataTransferServiceClient->listDataSources($request);

        /** @var DataSource $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DataTransferServiceClient::projectName('[PROJECT]');

    list_data_sources_sample($formattedParent);
}

listTransferConfigs

Returns information about all transfer configs owned by a project in the specified location.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::listTransferConfigsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ListTransferConfigsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\ListTransferConfigsRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig;

/**
 * @param string $formattedParent The BigQuery project id for which transfer configs
 *                                should be returned: `projects/{project_id}` or
 *                                `projects/{project_id}/locations/{location_id}`
 *                                Please see {@see DataTransferServiceClient::projectName()} for help formatting this field.
 */
function list_transfer_configs_sample(string $formattedParent): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new ListTransferConfigsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $dataTransferServiceClient->listTransferConfigs($request);

        /** @var TransferConfig $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DataTransferServiceClient::projectName('[PROJECT]');

    list_transfer_configs_sample($formattedParent);
}

listTransferLogs

Returns log messages for the transfer run.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::listTransferLogsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ListTransferLogsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\ListTransferLogsRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\TransferMessage;

/**
 * @param string $formattedParent Transfer run name in the form:
 *                                `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
 *                                `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
 *                                Please see {@see DataTransferServiceClient::runName()} for help formatting this field.
 */
function list_transfer_logs_sample(string $formattedParent): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new ListTransferLogsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $dataTransferServiceClient->listTransferLogs($request);

        /** @var TransferMessage $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DataTransferServiceClient::runName('[PROJECT]', '[TRANSFER_CONFIG]', '[RUN]');

    list_transfer_logs_sample($formattedParent);
}

listTransferRuns

Returns information about running and completed transfer runs.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::listTransferRunsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ListTransferRunsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\ListTransferRunsRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\TransferRun;

/**
 * @param string $formattedParent 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
 *                                {@see DataTransferServiceClient::transferConfigName()} for help formatting this field.
 */
function list_transfer_runs_sample(string $formattedParent): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = (new ListTransferRunsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $dataTransferServiceClient->listTransferRuns($request);

        /** @var TransferRun $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DataTransferServiceClient::transferConfigName('[PROJECT]', '[TRANSFER_CONFIG]');

    list_transfer_runs_sample($formattedParent);
}

scheduleTransferRuns

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.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::scheduleTransferRunsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ScheduleTransferRunsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\ScheduleTransferRunsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\ScheduleTransferRunsRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\ScheduleTransferRunsResponse;
use Google\Protobuf\Timestamp;

/**
 * @param string $formattedParent Transfer configuration name in the form:
 *                                `projects/{project_id}/transferConfigs/{config_id}` or
 *                                `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. Please see
 *                                {@see DataTransferServiceClient::transferConfigName()} for help formatting this field.
 */
function schedule_transfer_runs_sample(string $formattedParent): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $startTime = new Timestamp();
    $endTime = new Timestamp();
    $request = (new ScheduleTransferRunsRequest())
        ->setParent($formattedParent)
        ->setStartTime($startTime)
        ->setEndTime($endTime);

    // Call the API and handle any network failures.
    try {
        /** @var ScheduleTransferRunsResponse $response */
        $response = $dataTransferServiceClient->scheduleTransferRuns($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DataTransferServiceClient::transferConfigName('[PROJECT]', '[TRANSFER_CONFIG]');

    schedule_transfer_runs_sample($formattedParent);
}

startManualTransferRuns

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.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::startManualTransferRunsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\StartManualTransferRunsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\StartManualTransferRunsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\StartManualTransferRunsRequest;
use Google\Cloud\BigQuery\DataTransfer\V1\StartManualTransferRunsResponse;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function start_manual_transfer_runs_sample(): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = new StartManualTransferRunsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var StartManualTransferRunsResponse $response */
        $response = $dataTransferServiceClient->startManualTransferRuns($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

unenrollDataSources

Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI. Data transfers configurations of unenrolled data sources will not be scheduled.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::unenrollDataSourcesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\UnenrollDataSourcesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\UnenrollDataSourcesRequest;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function unenroll_data_sources_sample(): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = new UnenrollDataSourcesRequest();

    // Call the API and handle any network failures.
    try {
        $dataTransferServiceClient->unenrollDataSources($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

updateTransferConfig

Updates a data transfer configuration.

All fields must be set, even if they are not updated.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::updateTransferConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\UpdateTransferConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig;
use Google\Cloud\BigQuery\DataTransfer\V1\UpdateTransferConfigRequest;
use Google\Protobuf\FieldMask;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_transfer_config_sample(): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $transferConfig = new TransferConfig();
    $updateMask = new FieldMask();
    $request = (new UpdateTransferConfigRequest())
        ->setTransferConfig($transferConfig)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var TransferConfig $response */
        $response = $dataTransferServiceClient->updateTransferConfig($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getLocation

Gets information about a location.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $dataTransferServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\DataTransfer\V1\Client\DataTransferServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $dataTransferServiceClient = new DataTransferServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $dataTransferServiceClient->listLocations($request);

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

checkValidCredsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\CheckValidCredsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createTransferConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\CreateTransferConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteTransferConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\DeleteTransferConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteTransferRunAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\DeleteTransferRunRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

enrollDataSourcesAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\EnrollDataSourcesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDataSourceAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\GetDataSourceRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getTransferConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\GetTransferConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getTransferRunAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\GetTransferRunRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDataSourcesAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ListDataSourcesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listTransferConfigsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ListTransferConfigsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listTransferLogsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ListTransferLogsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listTransferRunsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ListTransferRunsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

scheduleTransferRunsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\ScheduleTransferRunsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

startManualTransferRunsAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\StartManualTransferRunsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

unenrollDataSourcesAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\UnenrollDataSourcesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateTransferConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\BigQuery\DataTransfer\V1\UpdateTransferConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::dataSourceName

Formats a string containing the fully-qualified path to represent a data_source resource.

Parameters
Name	Description
`project`	`string`
`dataSource`	`string`

Returns
Type	Description
`string`	The formatted data_source resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::projectDataSourceName

Formats a string containing the fully-qualified path to represent a project_data_source resource.

Parameters
Name	Description
`project`	`string`
`dataSource`	`string`

Returns
Type	Description
`string`	The formatted project_data_source resource.

static::projectLocationDataSourceName

Formats a string containing the fully-qualified path to represent a project_location_data_source resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataSource`	`string`

Returns
Type	Description
`string`	The formatted project_location_data_source resource.

static::projectLocationTransferConfigName

Formats a string containing the fully-qualified path to represent a project_location_transfer_config resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`transferConfig`	`string`

Returns
Type	Description
`string`	The formatted project_location_transfer_config resource.

static::projectLocationTransferConfigRunName

Formats a string containing the fully-qualified path to represent a project_location_transfer_config_run resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`transferConfig`	`string`
`run`	`string`

Returns
Type	Description
`string`	The formatted project_location_transfer_config_run resource.

static::projectTransferConfigName

Formats a string containing the fully-qualified path to represent a project_transfer_config resource.

Parameters
Name	Description
`project`	`string`
`transferConfig`	`string`

Returns
Type	Description
`string`	The formatted project_transfer_config resource.

static::projectTransferConfigRunName

Formats a string containing the fully-qualified path to represent a project_transfer_config_run resource.

Parameters
Name	Description
`project`	`string`
`transferConfig`	`string`
`run`	`string`

Returns
Type	Description
`string`	The formatted project_transfer_config_run resource.

static::runName

Formats a string containing the fully-qualified path to represent a run resource.

Parameters
Name	Description
`project`	`string`
`transferConfig`	`string`
`run`	`string`

Returns
Type	Description
`string`	The formatted run resource.

static::transferConfigName

Formats a string containing the fully-qualified path to represent a transfer_config resource.

Parameters
Name	Description
`project`	`string`
`transferConfig`	`string`

Returns
Type	Description
`string`	The formatted transfer_config resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

dataSource: projects/{project}/dataSources/{data_source}
location: projects/{project}/locations/{location}
project: projects/{project}
projectDataSource: projects/{project}/dataSources/{data_source}
projectLocationDataSource: projects/{project}/locations/{location}/dataSources/{data_source}
projectLocationTransferConfig: projects/{project}/locations/{location}/transferConfigs/{transfer_config}
projectLocationTransferConfigRun: projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}
projectTransferConfig: projects/{project}/transferConfigs/{transfer_config}
projectTransferConfigRun: projects/{project}/transferConfigs/{transfer_config}/runs/{run}
run: projects/{project}/transferConfigs/{transfer_config}/runs/{run}
transferConfig: projects/{project}/transferConfigs/{transfer_config}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.