Google Cloud Storage Transfer V1 Client - Class StorageTransferServiceClient (1.5.0)

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);
}

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

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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",...]}`
 *
 *                       Since `jobNames` and `jobStatuses` support multiple values, their values
 *                       must be specified with array notation. `projectId` is required.
 *                       `jobNames` and `jobStatuses` are optional.  The valid values for
 *                       `jobStatuses` are case-insensitive:
 *                       [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED],
 *                       [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], and
 *                       [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
 */
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);
}

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);
}

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);
}

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);
}

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);
}

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);
}