# Google Cloud Network Connectivity V1 Client - Class DataTransferServiceClient (2.5.3)

2.5.3 (latest) 2.5.2 2.4.0 2.3.0 2.2.2 2.1.2 2.0.2 1.5.5 1.4.2 1.3.0 1.2.0 1.1.1 1.0.5 Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class DataTransferServiceClient.

Service Description: DataTransferService is the service for the Data Transfer API.

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 \\ NetworkConnectivity \\ V1 \\ Client

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `options` | `array|https://docs.cloud.google.com/php/docs/reference/gax/latest/Options.ClientOptions.html` 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` | `https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html|https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html` This option should only be used with a pre-constructed [Google\\Auth\\FetchAuthTokenInterface](https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html) or [Google\\ApiCore\\CredentialsWrapper](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html) object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important** : If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\NetworkConnectivity\V1\DataTransferServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new DataTransferServiceClient(['credentials' => $creds]);` <https://cloud.google.com/docs/authentication/external/externally-sourced-credentials> |
| `↳ 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html#_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|https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html` 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](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html) 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.GrpcTransport.html#_Google_ApiCore_Transport_GrpcTransport__build__) and [Google\\ApiCore\\Transport\\RestTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_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. |
| `↳ logger` | `false|Psr\Log\LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
| `↳ universeDomain` | `string` The service domain for the client. Defaults to 'googleapis.com'. |

### createDestination

Creates a `Destination` resource in a specified project and location.

The async variant is [DataTransferServiceClient::createDestinationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__createDestinationAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.CreateDestinationRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Destination>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\CreateDestinationRequest;
    use Google\Cloud\NetworkConnectivity\V1\Destination;
    use Google\Cloud\NetworkConnectivity\V1\Destination\DestinationEndpoint;
    use Google\Rpc\Status;

    /**
     * @param string $formattedParent         The name of the parent resource. Please see
     *                                        {@see DataTransferServiceClient::multicloudDataTransferConfigName()} for help formatting this field.
     * @param string $destinationId           The ID to use for the `Destination` resource, which becomes the
     *                                        final component of the `Destination` resource name.
     * @param string $destinationIpPrefix     Immutable. The IP prefix that represents your workload on another
     *                                        CSP.
     * @param int    $destinationEndpointsAsn The ASN of the remote IP prefix.
     * @param string $destinationEndpointsCsp The CSP of the remote IP prefix.
     */
    function create_destination_sample(
        string $formattedParent,
        string $destinationId,
        string $destinationIpPrefix,
        int $destinationEndpointsAsn,
        string $destinationEndpointsCsp
    ): void {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

        // Prepare the request message.
        $destinationEndpoint = (new DestinationEndpoint())
            ->setAsn($destinationEndpointsAsn)
            ->setCsp($destinationEndpointsCsp);
        $destinationEndpoints = [$destinationEndpoint,];
        $destination = (new Destination())
            ->setIpPrefix($destinationIpPrefix)
            ->setEndpoints($destinationEndpoints);
        $request = (new CreateDestinationRequest())
            ->setParent($formattedParent)
            ->setDestinationId($destinationId)
            ->setDestination($destination);

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

            if ($response->operationSucceeded()) {
                /** @var Destination $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->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::multicloudDataTransferConfigName(
            '[PROJECT]',
            '[LOCATION]',
            '[MULTICLOUD_DATA_TRANSFER_CONFIG]'
        );
        $destinationId = '[DESTINATION_ID]';
        $destinationIpPrefix = '[IP_PREFIX]';
        $destinationEndpointsAsn = 0;
        $destinationEndpointsCsp = '[CSP]';

        create_destination_sample(
            $formattedParent,
            $destinationId,
            $destinationIpPrefix,
            $destinationEndpointsAsn,
            $destinationEndpointsCsp
        );
    }

### createMulticloudDataTransferConfig

Creates a `MulticloudDataTransferConfig` resource in a specified project
and location.

The async variant is
[DataTransferServiceClient::createMulticloudDataTransferConfigAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__createMulticloudDataTransferConfigAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.CreateMulticloudDataTransferConfigRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.MulticloudDataTransferConfig>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\CreateMulticloudDataTransferConfigRequest;
    use Google\Cloud\NetworkConnectivity\V1\MulticloudDataTransferConfig;
    use Google\Rpc\Status;

    /**
     * @param string $formattedParent                The name of the parent resource. Please see
     *                                               {@see DataTransferServiceClient::locationName()} for help formatting this field.
     * @param string $multicloudDataTransferConfigId The ID to use for the `MulticloudDataTransferConfig` resource,
     *                                               which becomes the final component of the `MulticloudDataTransferConfig`
     *                                               resource name.
     */
    function create_multicloud_data_transfer_config_sample(
        string $formattedParent,
        string $multicloudDataTransferConfigId
    ): void {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

        // Prepare the request message.
        $multicloudDataTransferConfig = new MulticloudDataTransferConfig();
        $request = (new CreateMulticloudDataTransferConfigRequest())
            ->setParent($formattedParent)
            ->setMulticloudDataTransferConfigId($multicloudDataTransferConfigId)
            ->setMulticloudDataTransferConfig($multicloudDataTransferConfig);

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

            if ($response->operationSucceeded()) {
                /** @var MulticloudDataTransferConfig $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->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::locationName('[PROJECT]', '[LOCATION]');
        $multicloudDataTransferConfigId = '[MULTICLOUD_DATA_TRANSFER_CONFIG_ID]';

        create_multicloud_data_transfer_config_sample($formattedParent, $multicloudDataTransferConfigId);
    }

### deleteDestination

Deletes a `Destination` resource.

The async variant is [DataTransferServiceClient::deleteDestinationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__deleteDestinationAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.DeleteDestinationRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<null>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\DeleteDestinationRequest;
    use Google\Rpc\Status;

    /**
     * @param string $formattedName The name of the `Destination` resource to delete. Please see
     *                              {@see DataTransferServiceClient::destinationName()} for help formatting this field.
     */
    function delete_destination_sample(string $formattedName): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

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

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

            if ($response->operationSucceeded()) {
                printf('Operation completed successfully.' . PHP_EOL);
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->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::destinationName(
            '[PROJECT]',
            '[LOCATION]',
            '[MULTICLOUD_DATA_TRANSFER_CONFIG]',
            '[DESTINATION]'
        );

        delete_destination_sample($formattedName);
    }

### deleteMulticloudDataTransferConfig

Deletes a `MulticloudDataTransferConfig` resource.

The async variant is
[DataTransferServiceClient::deleteMulticloudDataTransferConfigAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__deleteMulticloudDataTransferConfigAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.DeleteMulticloudDataTransferConfigRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<null>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\DeleteMulticloudDataTransferConfigRequest;
    use Google\Rpc\Status;

    /**
     * @param string $formattedName The name of the `MulticloudDataTransferConfig` resource to
     *                              delete. Please see
     *                              {@see DataTransferServiceClient::multicloudDataTransferConfigName()} for help formatting this field.
     */
    function delete_multicloud_data_transfer_config_sample(string $formattedName): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

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

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

            if ($response->operationSucceeded()) {
                printf('Operation completed successfully.' . PHP_EOL);
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->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::multicloudDataTransferConfigName(
            '[PROJECT]',
            '[LOCATION]',
            '[MULTICLOUD_DATA_TRANSFER_CONFIG]'
        );

        delete_multicloud_data_transfer_config_sample($formattedName);
    }

### getDestination

Gets the details of a `Destination` resource.

The async variant is [DataTransferServiceClient::getDestinationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__getDestinationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.GetDestinationRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Destination` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\Destination;
    use Google\Cloud\NetworkConnectivity\V1\GetDestinationRequest;

    /**
     * @param string $formattedName The name of the `Destination` resource to get. Please see
     *                              {@see DataTransferServiceClient::destinationName()} for help formatting this field.
     */
    function get_destination_sample(string $formattedName): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var Destination $response */
            $response = $dataTransferServiceClient->getDestination($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::destinationName(
            '[PROJECT]',
            '[LOCATION]',
            '[MULTICLOUD_DATA_TRANSFER_CONFIG]',
            '[DESTINATION]'
        );

        get_destination_sample($formattedName);
    }

### getMulticloudDataTransferConfig

Gets the details of a `MulticloudDataTransferConfig` resource.

The async variant is
[DataTransferServiceClient::getMulticloudDataTransferConfigAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__getMulticloudDataTransferConfigAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.GetMulticloudDataTransferConfigRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.MulticloudDataTransferConfig` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\GetMulticloudDataTransferConfigRequest;
    use Google\Cloud\NetworkConnectivity\V1\MulticloudDataTransferConfig;

    /**
     * @param string $formattedName The name of the `MulticloudDataTransferConfig` resource to get. Please see
     *                              {@see DataTransferServiceClient::multicloudDataTransferConfigName()} for help formatting this field.
     */
    function get_multicloud_data_transfer_config_sample(string $formattedName): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var MulticloudDataTransferConfig $response */
            $response = $dataTransferServiceClient->getMulticloudDataTransferConfig($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::multicloudDataTransferConfigName(
            '[PROJECT]',
            '[LOCATION]',
            '[MULTICLOUD_DATA_TRANSFER_CONFIG]'
        );

        get_multicloud_data_transfer_config_sample($formattedName);
    }

### getMulticloudDataTransferSupportedService

Gets the details of a service that is supported for Data Transfer
Essentials.

The async variant is
[DataTransferServiceClient::getMulticloudDataTransferSupportedServiceAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__getMulticloudDataTransferSupportedServiceAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.GetMulticloudDataTransferSupportedServiceRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.MulticloudDataTransferSupportedService` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\GetMulticloudDataTransferSupportedServiceRequest;
    use Google\Cloud\NetworkConnectivity\V1\MulticloudDataTransferSupportedService;

    /**
     * @param string $formattedName The name of the service. Please see
     *                              {@see DataTransferServiceClient::multicloudDataTransferSupportedServiceName()} for help formatting this field.
     */
    function get_multicloud_data_transfer_supported_service_sample(string $formattedName): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var MulticloudDataTransferSupportedService $response */
            $response = $dataTransferServiceClient->getMulticloudDataTransferSupportedService($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::multicloudDataTransferSupportedServiceName(
            '[PROJECT]',
            '[LOCATION]',
            '[MULTICLOUD_DATA_TRANSFER_SUPPORTED_SERVICE]'
        );

        get_multicloud_data_transfer_supported_service_sample($formattedName);
    }

### listDestinations

Lists the `Destination` resources in a specified project and location.

The async variant is [DataTransferServiceClient::listDestinationsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__listDestinationsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.ListDestinationsRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\Destination;
    use Google\Cloud\NetworkConnectivity\V1\ListDestinationsRequest;

    /**
     * @param string $formattedParent The name of the parent resource. Please see
     *                                {@see DataTransferServiceClient::multicloudDataTransferConfigName()} for help formatting this field.
     */
    function list_destinations_sample(string $formattedParent): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

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

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

            /** @var Destination $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::multicloudDataTransferConfigName(
            '[PROJECT]',
            '[LOCATION]',
            '[MULTICLOUD_DATA_TRANSFER_CONFIG]'
        );

        list_destinations_sample($formattedParent);
    }

### listMulticloudDataTransferConfigs

Lists the `MulticloudDataTransferConfig` resources in a specified project
and location.

The async variant is
[DataTransferServiceClient::listMulticloudDataTransferConfigsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__listMulticloudDataTransferConfigsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.ListMulticloudDataTransferConfigsRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\ListMulticloudDataTransferConfigsRequest;
    use Google\Cloud\NetworkConnectivity\V1\MulticloudDataTransferConfig;

    /**
     * @param string $formattedParent The name of the parent resource. Please see
     *                                {@see DataTransferServiceClient::locationName()} for help formatting this field.
     */
    function list_multicloud_data_transfer_configs_sample(string $formattedParent): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

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

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

            /** @var MulticloudDataTransferConfig $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::locationName('[PROJECT]', '[LOCATION]');

        list_multicloud_data_transfer_configs_sample($formattedParent);
    }

### listMulticloudDataTransferSupportedServices

Lists the services in the project for a region that are supported for
Data Transfer Essentials.

The async variant is
[DataTransferServiceClient::listMulticloudDataTransferSupportedServicesAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__listMulticloudDataTransferSupportedServicesAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.ListMulticloudDataTransferSupportedServicesRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\ListMulticloudDataTransferSupportedServicesRequest;
    use Google\Cloud\NetworkConnectivity\V1\MulticloudDataTransferSupportedService;

    /**
     * @param string $formattedParent The name of the parent resource. Please see
     *                                {@see DataTransferServiceClient::locationName()} for help formatting this field.
     */
    function list_multicloud_data_transfer_supported_services_sample(string $formattedParent): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

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

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

            /** @var MulticloudDataTransferSupportedService $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::locationName('[PROJECT]', '[LOCATION]');

        list_multicloud_data_transfer_supported_services_sample($formattedParent);
    }

### updateDestination

Updates a `Destination` resource in a specified project and location.

The async variant is [DataTransferServiceClient::updateDestinationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__updateDestinationAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.UpdateDestinationRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Destination>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\Destination;
    use Google\Cloud\NetworkConnectivity\V1\Destination\DestinationEndpoint;
    use Google\Cloud\NetworkConnectivity\V1\UpdateDestinationRequest;
    use Google\Rpc\Status;

    /**
     * @param string $destinationIpPrefix     Immutable. The IP prefix that represents your workload on another
     *                                        CSP.
     * @param int    $destinationEndpointsAsn The ASN of the remote IP prefix.
     * @param string $destinationEndpointsCsp The CSP of the remote IP prefix.
     */
    function update_destination_sample(
        string $destinationIpPrefix,
        int $destinationEndpointsAsn,
        string $destinationEndpointsCsp
    ): void {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

        // Prepare the request message.
        $destinationEndpoint = (new DestinationEndpoint())
            ->setAsn($destinationEndpointsAsn)
            ->setCsp($destinationEndpointsCsp);
        $destinationEndpoints = [$destinationEndpoint,];
        $destination = (new Destination())
            ->setIpPrefix($destinationIpPrefix)
            ->setEndpoints($destinationEndpoints);
        $request = (new UpdateDestinationRequest())
            ->setDestination($destination);

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

            if ($response->operationSucceeded()) {
                /** @var Destination $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->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
    {
        $destinationIpPrefix = '[IP_PREFIX]';
        $destinationEndpointsAsn = 0;
        $destinationEndpointsCsp = '[CSP]';

        update_destination_sample($destinationIpPrefix, $destinationEndpointsAsn, $destinationEndpointsCsp);
    }

### updateMulticloudDataTransferConfig

Updates a `MulticloudDataTransferConfig` resource in a specified project
and location.

The async variant is
[DataTransferServiceClient::updateMulticloudDataTransferConfigAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__updateMulticloudDataTransferConfigAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.UpdateMulticloudDataTransferConfigRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.MulticloudDataTransferConfig>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;
    use Google\Cloud\NetworkConnectivity\V1\MulticloudDataTransferConfig;
    use Google\Cloud\NetworkConnectivity\V1\UpdateMulticloudDataTransferConfigRequest;
    use Google\Rpc\Status;

    /**
     * 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_multicloud_data_transfer_config_sample(): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

        // Prepare the request message.
        $multicloudDataTransferConfig = new MulticloudDataTransferConfig();
        $request = (new UpdateMulticloudDataTransferConfigRequest())
            ->setMulticloudDataTransferConfig($multicloudDataTransferConfig);

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

            if ($response->operationSucceeded()) {
                /** @var MulticloudDataTransferConfig $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

### getLocation

Gets information about a location.

The async variant is [DataTransferServiceClient::getLocationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__getLocationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.GetLocationRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html` |   |

**Example**

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

    /**
     * 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 [DataTransferServiceClient::listLocationsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__listLocationsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.ListLocationsRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

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

    /**
     * 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());
        }
    }

### getIamPolicy

Gets the access control policy for a resource. Returns an empty policy
if the resource exists and does not have a policy set.

The async variant is [DataTransferServiceClient::getIamPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__getIamPolicyAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.GetIamPolicyRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.Policy.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\Iam\V1\GetIamPolicyRequest;
    use Google\Cloud\Iam\V1\Policy;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;

    /**
     * @param string $resource REQUIRED: The resource for which the policy is being requested.
     *                         See the operation documentation for the appropriate value for this field.
     */
    function get_iam_policy_sample(string $resource): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

        // Prepare the request message.
        $request = (new GetIamPolicyRequest())
            ->setResource($resource);

        // Call the API and handle any network failures.
        try {
            /** @var Policy $response */
            $response = $dataTransferServiceClient->getIamPolicy($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
    {
        $resource = '[RESOURCE]';

        get_iam_policy_sample($resource);
    }

### setIamPolicy

Sets the access control policy on the specified resource. Replaces
any existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
errors.

The async variant is [DataTransferServiceClient::setIamPolicyAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__setIamPolicyAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.SetIamPolicyRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.Policy.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\Iam\V1\Policy;
    use Google\Cloud\Iam\V1\SetIamPolicyRequest;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;

    /**
     * @param string $resource REQUIRED: The resource for which the policy is being specified.
     *                         See the operation documentation for the appropriate value for this field.
     */
    function set_iam_policy_sample(string $resource): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

        // Prepare the request message.
        $policy = new Policy();
        $request = (new SetIamPolicyRequest())
            ->setResource($resource)
            ->setPolicy($policy);

        // Call the API and handle any network failures.
        try {
            /** @var Policy $response */
            $response = $dataTransferServiceClient->setIamPolicy($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
    {
        $resource = '[RESOURCE]';

        set_iam_policy_sample($resource);
    }

### testIamPermissions

Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.

The async variant is [DataTransferServiceClient::testIamPermissionsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Client.DataTransferServiceClient#_Google_Cloud_NetworkConnectivity_V1_Client_DataTransferServiceClient__testIamPermissionsAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
    use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
    use Google\Cloud\NetworkConnectivity\V1\Client\DataTransferServiceClient;

    /**
     * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
     *                                   See the operation documentation for the appropriate value for this field.
     * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
     *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
     *                                   information see
     *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
     */
    function test_iam_permissions_sample(string $resource, string $permissionsElement): void
    {
        // Create a client.
        $dataTransferServiceClient = new DataTransferServiceClient();

        // Prepare the request message.
        $permissions = [$permissionsElement,];
        $request = (new TestIamPermissionsRequest())
            ->setResource($resource)
            ->setPermissions($permissions);

        // Call the API and handle any network failures.
        try {
            /** @var TestIamPermissionsResponse $response */
            $response = $dataTransferServiceClient->testIamPermissions($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
    {
        $resource = '[RESOURCE]';
        $permissionsElement = '[PERMISSIONS]';

        test_iam_permissions_sample($resource, $permissionsElement);
    }

### createDestinationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.CreateDestinationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### createMulticloudDataTransferConfigAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.CreateMulticloudDataTransferConfigRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### deleteDestinationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.DeleteDestinationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### deleteMulticloudDataTransferConfigAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.DeleteMulticloudDataTransferConfigRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### getDestinationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.GetDestinationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.Destination>` |   |

### getMulticloudDataTransferConfigAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.GetMulticloudDataTransferConfigRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.MulticloudDataTransferConfig>` |   |

### getMulticloudDataTransferSupportedServiceAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.GetMulticloudDataTransferSupportedServiceRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.MulticloudDataTransferSupportedService>` |   |

### listDestinationsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.ListDestinationsRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### listMulticloudDataTransferConfigsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.ListMulticloudDataTransferConfigsRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### listMulticloudDataTransferSupportedServicesAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.ListMulticloudDataTransferSupportedServicesRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### updateDestinationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.UpdateDestinationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### updateMulticloudDataTransferConfigAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-network-connectivity/latest/V1.UpdateMulticloudDataTransferConfigRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### getLocationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.GetLocationRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html>` |   |

### listLocationsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.ListLocationsRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### getIamPolicyAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.GetIamPolicyRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.Policy.html>` |   |

### setIamPolicyAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.SetIamPolicyRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.Policy.html>` |   |

### testIamPermissionsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Iam.V1.TestIamPermissionsResponse.html>` |   |

### getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\LongRunning\Client\OperationsClient` |   |

### resumeOperation

Resume an existing long running operation that was previously started by a long
running API method. If $methodName is not provided, or does not match a long
running API method, then the operation can still be resumed, but the
OperationResponse object will not deserialize the final response.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `operationName` | `string` The name of the long running operation |
| `methodName` | `string` The name of the method used to start the operation |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html` |   |

### static::destinationName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `multicloudDataTransferConfig` | `string` |
| `destination` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted destination 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::multicloudDataTransferConfigName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `multicloudDataTransferConfig` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted multicloud_data_transfer_config resource. |

### static::multicloudDataTransferSupportedServiceName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `multicloudDataTransferSupportedService` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted multicloud_data_transfer_supported_service 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

- destination: projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}
- location: projects/{project}/locations/{location}
- multicloudDataTransferConfig: projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}
- multicloudDataTransferSupportedService: projects/{project}/locations/{location}/multicloudDataTransferSupportedServices/{multicloud_data_transfer_supported_service}

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