list_retired_resources.php

<?php
/*
 * Copyright 2026 Google LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

declare(strict_types=1);

namespace Google\Cloud\Samples\Kms;

// [START kms_list_retired_resources]
use Google\Cloud\Kms\V1\Client\KeyManagementServiceClient;
use Google\Cloud\Kms\V1\ListRetiredResourcesRequest;

function list_retired_resources(
    string $projectId = 'my-project',
    string $locationId = 'us-east1'
): mixed {
    // Create the Cloud KMS client.
    $client = new KeyManagementServiceClient();

    // Build the parent location name.
    $parent = $client->locationName($projectId, $locationId);

    // Call the API.
    $request = (new ListRetiredResourcesRequest())
        ->setParent($parent);
    $response = $client->listRetiredResources($request);

    foreach ($response as $retiredResource) {
        printf('Retired Resource Name: %s' . PHP_EOL, $retiredResource->getName());
        printf('Original Resource: %s' . PHP_EOL, $retiredResource->getOriginalResource());
        printf('Delete Time: %s' . PHP_EOL, $retiredResource->getDeleteTime()->getSeconds());
    }

    return $response;
}
// [END kms_list_retired_resources]

// The following 2 lines are only needed to run the samples
require_once __DIR__ . '/../../testing/sample_helpers.php';
return \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);