# Google Cloud Storage Transfer V1 Client - Class StorageTransferServiceClient (2.4.0)

2.4.0 (latest) 2.3.2 2.2.1 2.1.1 2.0.2 1.5.0 1.4.5 1.3.1 1.2.0 1.1.1 1.0.6 Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class StorageTransferServiceClient.

Service Description: Storage Transfer Service and its protos.

Transfers data between between Google Cloud Storage buckets or from a data
source external to Google to a Cloud Storage bucket.

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 \\ StorageTransfer \\ 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\StorageTransfer\V1\StorageTransferServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new StorageTransferServiceClient(['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'. |

### createAgentPool

Creates an agent pool resource.

The async variant is [StorageTransferServiceClient::createAgentPoolAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__createAgentPoolAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.CreateAgentPoolRequest` 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-storage-transfer/latest/V1.AgentPool` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\AgentPool;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\CreateAgentPoolRequest;

    /**
     * @param string $projectId     The ID of the Google Cloud project that owns the
     *                              agent pool.
     * @param string $agentPoolName Specifies a unique string that identifies the agent pool.
     *
     *                              Format: `projects/{project_id}/agentPools/{agent_pool_id}`
     * @param string $agentPoolId   The ID of the agent pool to create.
     *
     *                              The `agent_pool_id` must meet the following requirements:
     *
     *                              *   Length of 128 characters or less.
     *                              *   Not start with the string `goog`.
     *                              *   Start with a lowercase ASCII character, followed by:
     *                              *   Zero or more: lowercase Latin alphabet characters, numerals,
     *                              hyphens (`-`), periods (`.`), underscores (`_`), or tildes (`~`).
     *                              *   One or more numerals or lowercase ASCII characters.
     *
     *                              As expressed by the regular expression:
     *                              `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.
     */
    function create_agent_pool_sample(
        string $projectId,
        string $agentPoolName,
        string $agentPoolId
    ): void {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $agentPool = (new AgentPool())
            ->setName($agentPoolName);
        $request = (new CreateAgentPoolRequest())
            ->setProjectId($projectId)
            ->setAgentPool($agentPool)
            ->setAgentPoolId($agentPoolId);

        // Call the API and handle any network failures.
        try {
            /** @var AgentPool $response */
            $response = $storageTransferServiceClient->createAgentPool($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
    {
        $projectId = '[PROJECT_ID]';
        $agentPoolName = '[NAME]';
        $agentPoolId = '[AGENT_POOL_ID]';

        create_agent_pool_sample($projectId, $agentPoolName, $agentPoolId);
    }

### createTransferJob

Creates a transfer job that runs periodically.

The async variant is
[StorageTransferServiceClient::createTransferJobAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__createTransferJobAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.CreateTransferJobRequest` 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-storage-transfer/latest/V1.TransferJob` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\CreateTransferJobRequest;
    use Google\Cloud\StorageTransfer\V1\TransferJob;

    /**
     * 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 create_transfer_job_sample(): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $transferJob = new TransferJob();
        $request = (new CreateTransferJobRequest())
            ->setTransferJob($transferJob);

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

### deleteAgentPool

Deletes an agent pool.

The async variant is [StorageTransferServiceClient::deleteAgentPoolAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__deleteAgentPoolAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.DeleteAgentPoolRequest` 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. |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\DeleteAgentPoolRequest;

    /**
     * @param string $name The name of the agent pool to delete.
     */
    function delete_agent_pool_sample(string $name): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new DeleteAgentPoolRequest())
            ->setName($name);

        // Call the API and handle any network failures.
        try {
            $storageTransferServiceClient->deleteAgentPool($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
    {
        $name = '[NAME]';

        delete_agent_pool_sample($name);
    }

### deleteTransferJob

Deletes a transfer job. Deleting a transfer job sets its status to
[DELETED](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DELETED).

The async variant is
[StorageTransferServiceClient::deleteTransferJobAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__deleteTransferJobAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.DeleteTransferJobRequest` 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. |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\DeleteTransferJobRequest;

    /**
     * @param string $jobName   The job to delete.
     * @param string $projectId The ID of the Google Cloud project that owns the
     *                          job.
     */
    function delete_transfer_job_sample(string $jobName, string $projectId): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new DeleteTransferJobRequest())
            ->setJobName($jobName)
            ->setProjectId($projectId);

        // Call the API and handle any network failures.
        try {
            $storageTransferServiceClient->deleteTransferJob($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
    {
        $jobName = '[JOB_NAME]';
        $projectId = '[PROJECT_ID]';

        delete_transfer_job_sample($jobName, $projectId);
    }

### getAgentPool

Gets an agent pool.

The async variant is [StorageTransferServiceClient::getAgentPoolAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__getAgentPoolAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GetAgentPoolRequest` 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-storage-transfer/latest/V1.AgentPool` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\AgentPool;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\GetAgentPoolRequest;

    /**
     * @param string $name The name of the agent pool to get.
     */
    function get_agent_pool_sample(string $name): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new GetAgentPoolRequest())
            ->setName($name);

        // Call the API and handle any network failures.
        try {
            /** @var AgentPool $response */
            $response = $storageTransferServiceClient->getAgentPool($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
    {
        $name = '[NAME]';

        get_agent_pool_sample($name);
    }

### getGoogleServiceAccount

Returns the Google service account that is used by Storage Transfer
Service to access buckets in the project where transfers
run or in other projects. Each Google service account is associated
with one Google Cloud project. Users
should add this service account to the Google Cloud Storage bucket
ACLs to grant access to Storage Transfer Service. This service
account is created and owned by Storage Transfer Service and can
only be used by Storage Transfer Service.

The async variant is
[StorageTransferServiceClient::getGoogleServiceAccountAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__getGoogleServiceAccountAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GetGoogleServiceAccountRequest` 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-storage-transfer/latest/V1.GoogleServiceAccount` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\GetGoogleServiceAccountRequest;
    use Google\Cloud\StorageTransfer\V1\GoogleServiceAccount;

    /**
     * @param string $projectId The ID of the Google Cloud project that the Google service
     *                          account is associated with.
     */
    function get_google_service_account_sample(string $projectId): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new GetGoogleServiceAccountRequest())
            ->setProjectId($projectId);

        // Call the API and handle any network failures.
        try {
            /** @var GoogleServiceAccount $response */
            $response = $storageTransferServiceClient->getGoogleServiceAccount($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
    {
        $projectId = '[PROJECT_ID]';

        get_google_service_account_sample($projectId);
    }

### getTransferJob

Gets a transfer job.

The async variant is [StorageTransferServiceClient::getTransferJobAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__getTransferJobAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GetTransferJobRequest` 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-storage-transfer/latest/V1.TransferJob` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\GetTransferJobRequest;
    use Google\Cloud\StorageTransfer\V1\TransferJob;

    /**
     * @param string $jobName   The job to get.
     * @param string $projectId The ID of the Google Cloud project that owns the
     *                          job.
     */
    function get_transfer_job_sample(string $jobName, string $projectId): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new GetTransferJobRequest())
            ->setJobName($jobName)
            ->setProjectId($projectId);

        // Call the API and handle any network failures.
        try {
            /** @var TransferJob $response */
            $response = $storageTransferServiceClient->getTransferJob($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
    {
        $jobName = '[JOB_NAME]';
        $projectId = '[PROJECT_ID]';

        get_transfer_job_sample($jobName, $projectId);
    }

### listAgentPools

Lists agent pools.

The async variant is [StorageTransferServiceClient::listAgentPoolsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__listAgentPoolsAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ListAgentPoolsRequest` 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\StorageTransfer\V1\AgentPool;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\ListAgentPoolsRequest;

    /**
     * @param string $projectId The ID of the Google Cloud project that owns the job.
     */
    function list_agent_pools_sample(string $projectId): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new ListAgentPoolsRequest())
            ->setProjectId($projectId);

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

            /** @var AgentPool $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
    {
        $projectId = '[PROJECT_ID]';

        list_agent_pools_sample($projectId);
    }

### listTransferJobs

Lists transfer jobs.

The async variant is
[StorageTransferServiceClient::listTransferJobsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__listTransferJobsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ListTransferJobsRequest` 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\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\ListTransferJobsRequest;
    use Google\Cloud\StorageTransfer\V1\TransferJob;

    /**
     * @param string $filter A list of query parameters specified as JSON text in the form of:
     *
     *                       ```
     *                       {
     *                       "projectId":"my_project_id",
     *                       "jobNames":["jobid1","jobid2",...],
     *                       "jobStatuses":["status1","status2",...],
     *                       "dataBackend":"QUERY_REPLICATION_CONFIGS",
     *                       "sourceBucket":"source-bucket-name",
     *                       "sinkBucket":"sink-bucket-name",
     *                       }
     *                       ```
     *
     *                       The JSON formatting in the example is for display only; provide the
     *                       query parameters without spaces or line breaks.
     *
     *                       * `projectId` is required.
     *                       * Since `jobNames` and `jobStatuses` support multiple values, their values
     *                       must be specified with array notation. `jobNames` and `jobStatuses` are
     *                       optional. Valid values are case-insensitive:
     *                       * [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED]
     *                       * [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED]
     *                       * [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED]
     *                       * Specify `"dataBackend":"QUERY_REPLICATION_CONFIGS"` to return a list of
     *                       cross-bucket replication jobs.
     *                       * Limit the results to jobs from a particular bucket with `sourceBucket`
     *                       and/or to a particular bucket with `sinkBucket`.
     */
    function list_transfer_jobs_sample(string $filter): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new ListTransferJobsRequest())
            ->setFilter($filter);

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

            /** @var TransferJob $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
    {
        $filter = '[FILTER]';

        list_transfer_jobs_sample($filter);
    }

### pauseTransferOperation

Pauses a transfer operation.

The async variant is
[StorageTransferServiceClient::pauseTransferOperationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__pauseTransferOperationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.PauseTransferOperationRequest` 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. |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\PauseTransferOperationRequest;

    /**
     * @param string $name The name of the transfer operation.
     */
    function pause_transfer_operation_sample(string $name): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new PauseTransferOperationRequest())
            ->setName($name);

        // Call the API and handle any network failures.
        try {
            $storageTransferServiceClient->pauseTransferOperation($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
    {
        $name = '[NAME]';

        pause_transfer_operation_sample($name);
    }

### resumeTransferOperation

Resumes a transfer operation that is paused.

The async variant is
[StorageTransferServiceClient::resumeTransferOperationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__resumeTransferOperationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ResumeTransferOperationRequest` 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. |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\ResumeTransferOperationRequest;

    /**
     * @param string $name The name of the transfer operation.
     */
    function resume_transfer_operation_sample(string $name): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new ResumeTransferOperationRequest())
            ->setName($name);

        // Call the API and handle any network failures.
        try {
            $storageTransferServiceClient->resumeTransferOperation($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
    {
        $name = '[NAME]';

        resume_transfer_operation_sample($name);
    }

### runTransferJob

Starts a new operation for the specified transfer job.

A `TransferJob` has a maximum of one active `TransferOperation`. If this
method is called while a `TransferOperation` is active, an error is
returned.

The async variant is [StorageTransferServiceClient::runTransferJobAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__runTransferJobAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.RunTransferJobRequest` 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\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\RunTransferJobRequest;
    use Google\Rpc\Status;

    /**
     * @param string $jobName   The name of the transfer job.
     * @param string $projectId The ID of the Google Cloud project that owns the transfer
     *                          job.
     */
    function run_transfer_job_sample(string $jobName, string $projectId): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $request = (new RunTransferJobRequest())
            ->setJobName($jobName)
            ->setProjectId($projectId);

        // Call the API and handle any network failures.
        try {
            /** @var OperationResponse $response */
            $response = $storageTransferServiceClient->runTransferJob($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
    {
        $jobName = '[JOB_NAME]';
        $projectId = '[PROJECT_ID]';

        run_transfer_job_sample($jobName, $projectId);
    }

### updateAgentPool

Updates an existing agent pool resource.

The async variant is [StorageTransferServiceClient::updateAgentPoolAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__updateAgentPoolAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.UpdateAgentPoolRequest` 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-storage-transfer/latest/V1.AgentPool` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\AgentPool;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\UpdateAgentPoolRequest;

    /**
     * @param string $agentPoolName Specifies a unique string that identifies the agent pool.
     *
     *                              Format: `projects/{project_id}/agentPools/{agent_pool_id}`
     */
    function update_agent_pool_sample(string $agentPoolName): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $agentPool = (new AgentPool())
            ->setName($agentPoolName);
        $request = (new UpdateAgentPoolRequest())
            ->setAgentPool($agentPool);

        // Call the API and handle any network failures.
        try {
            /** @var AgentPool $response */
            $response = $storageTransferServiceClient->updateAgentPool($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
    {
        $agentPoolName = '[NAME]';

        update_agent_pool_sample($agentPoolName);
    }

### updateTransferJob

Updates a transfer job. Updating a job's transfer spec does not affect
transfer operations that are running already.

**Note:** The job's [status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getStatus__)
field can be modified using this RPC (for example, to set a job's status to
[DELETED](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DELETED),
[DISABLED](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DISABLED), or
[ENABLED](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__ENABLED)).

The async variant is
[StorageTransferServiceClient::updateTransferJobAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.Client.StorageTransferServiceClient#_Google_Cloud_StorageTransfer_V1_Client_StorageTransferServiceClient__updateTransferJobAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.UpdateTransferJobRequest` 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-storage-transfer/latest/V1.TransferJob` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient;
    use Google\Cloud\StorageTransfer\V1\TransferJob;
    use Google\Cloud\StorageTransfer\V1\UpdateTransferJobRequest;

    /**
     * @param string $jobName   The name of job to update.
     * @param string $projectId The ID of the Google Cloud project that owns the
     *                          job.
     */
    function update_transfer_job_sample(string $jobName, string $projectId): void
    {
        // Create a client.
        $storageTransferServiceClient = new StorageTransferServiceClient();

        // Prepare the request message.
        $transferJob = new TransferJob();
        $request = (new UpdateTransferJobRequest())
            ->setJobName($jobName)
            ->setProjectId($projectId)
            ->setTransferJob($transferJob);

        // Call the API and handle any network failures.
        try {
            /** @var TransferJob $response */
            $response = $storageTransferServiceClient->updateTransferJob($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
    {
        $jobName = '[JOB_NAME]';
        $projectId = '[PROJECT_ID]';

        update_transfer_job_sample($jobName, $projectId);
    }

### createAgentPoolAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.CreateAgentPoolRequest` |
| `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-storage-transfer/latest/V1.AgentPool>` |   |

### createTransferJobAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.CreateTransferJobRequest` |
| `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-storage-transfer/latest/V1.TransferJob>` |   |

### deleteAgentPoolAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.DeleteAgentPoolRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<void>` |   |

### deleteTransferJobAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.DeleteTransferJobRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<void>` |   |

### getAgentPoolAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GetAgentPoolRequest` |
| `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-storage-transfer/latest/V1.AgentPool>` |   |

### getGoogleServiceAccountAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GetGoogleServiceAccountRequest` |
| `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-storage-transfer/latest/V1.GoogleServiceAccount>` |   |

### getTransferJobAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GetTransferJobRequest` |
| `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-storage-transfer/latest/V1.TransferJob>` |   |

### listAgentPoolsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ListAgentPoolsRequest` |
| `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>` |   |

### listTransferJobsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ListTransferJobsRequest` |
| `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>` |   |

### pauseTransferOperationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.PauseTransferOperationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<void>` |   |

### resumeTransferOperationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ResumeTransferOperationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<void>` |   |

### runTransferJobAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.RunTransferJobRequest` |
| `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>` |   |

### updateAgentPoolAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.UpdateAgentPoolRequest` |
| `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-storage-transfer/latest/V1.AgentPool>` |   |

### updateTransferJobAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.UpdateTransferJobRequest` |
| `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-storage-transfer/latest/V1.TransferJob>` |   |

### 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::agentPoolsName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `string` |
| `agentPoolId` | `string` |

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

- agentPools: projects/{project_id}/agentPools/{agent_pool_id}

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