Skip to content

chore(secretmanager): Added code samples for delayed destroy #2148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?php
/*
* Copyright 2025 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.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_create_regional_secret_with_delayed_destroy]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Protobuf\Duration;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $locationId Your Google Cloud Location ID (e.g. 'us-central1')
* @param string $secretId Your secret ID (e.g. 'my-secret')
* @param int $versionDestroyTtl Your Version Destroy Ttl (e.g. 86400)
*/
function create_regional_secret_with_delayed_destroy(string $projectId, string $locationId, string $secretId, int $versionDestroyTtl): void
{
// Specify regional endpoint.
$options = ['apiEndpoint' => "secretmanager.$locationId.rep.googleapis.com"];

// Create the Secret Manager client.
$client = new SecretManagerServiceClient($options);

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

// Build the secret.
$secret = new Secret([
'version_destroy_ttl' => new Duration([
'seconds' => $versionDestroyTtl
])
]);

// Build the request.
$request = CreateSecretRequest::build($parent, $secretId, $secret);

// Create the secret.
$newSecret = $client->createSecret($request);

// Print the new secret name.
printf('Created secret: %s', $newSecret->getName());
}
// [END secretmanager_create_regional_secret_with_delayed_destroy]

// The following 2 lines are only needed to execute the samples on the CLI
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
73 changes: 73 additions & 0 deletions secretmanager/src/create_secret_with_delayed_destroy.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<?php
/*
* Copyright 2025 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.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_create_secret_with_delayed_destroy]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Replication;
use Google\Cloud\SecretManager\V1\Replication\Automatic;
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Protobuf\Duration;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $secretId Your secret ID (e.g. 'my-secret')
* @param int $versionDestroyTtl Your Version Destroy Ttl (e.g. 86400)
*/
function create_secret_with_delayed_destroy(string $projectId, string $secretId, int $versionDestroyTtl): void
{
// Create the Secret Manager client.
$client = new SecretManagerServiceClient();

// Build the resource name of the parent project.
$parent = $client->projectName($projectId);

// Build the secret.
$secret = new Secret([
'replication' => new Replication([
'automatic' => new Automatic(),
]),
'version_destroy_ttl' => new Duration([
'seconds' => $versionDestroyTtl
])
]);

// Build the request.
$request = CreateSecretRequest::build($parent, $secretId, $secret);

// Create the secret.
$newSecret = $client->createSecret($request);

// Print the new secret name.
printf('Created secret: %s', $newSecret->getName());
}
// [END secretmanager_create_secret_with_delayed_destroy]

// The following 2 lines are only needed to execute the samples on the CLI
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
75 changes: 75 additions & 0 deletions secretmanager/src/disable_regional_secret_delayed_destroy.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?php
/*
* Copyright 2025 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.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_disable_regional_secret_delayed_destroy]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\UpdateSecretRequest;
use Google\Protobuf\FieldMask;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $locationId Your Google Cloud Location ID (e.g. 'us-central1')
* @param string $secretId Your secret ID (e.g. 'my-secret')
*/
function disable_regional_secret_delayed_destroy(string $projectId, string $locationId, string $secretId): void
{
// Specify regional endpoint.
$options = ['apiEndpoint' => "secretmanager.$locationId.rep.googleapis.com"];

// Create the Secret Manager client.
$client = new SecretManagerServiceClient($options);

// Build the resource name of the secret.
$name = $client->projectLocationSecretName($projectId, $locationId, $secretId);

// Build the secret.
$secret = new Secret([
'name' => $name,
]);

// Set the field mask.
$fieldMask = new FieldMask();
$fieldMask->setPaths(['version_destroy_ttl']);

// Build the request.
$request = new UpdateSecretRequest();
$request->setSecret($secret);
$request->setUpdateMask($fieldMask);

// Update the secret.
$newSecret = $client->updateSecret($request);

// Print the new secret name.
printf('Updated secret: %s', $newSecret->getName());
}
// [END secretmanager_disable_regional_secret_delayed_destroy]

// The following 2 lines are only needed to execute the samples on the CLI
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
71 changes: 71 additions & 0 deletions secretmanager/src/disable_secret_delayed_destroy.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2025 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.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_disable_secret_delayed_destroy]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\UpdateSecretRequest;
use Google\Protobuf\FieldMask;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $secretId Your secret ID (e.g. 'my-secret')
*/
function disable_secret_delayed_destroy(string $projectId, string $secretId): void
{
// Create the Secret Manager client.
$client = new SecretManagerServiceClient();

// Build the resource name of the secret.
$name = $client->secretName($projectId, $secretId);

// Build the secret.
$secret = new Secret([
'name' => $name
]);

// Set the field mask.
$fieldMask = new FieldMask();
$fieldMask->setPaths(['version_destroy_ttl']);

// Build the request.
$request = new UpdateSecretRequest();
$request->setSecret($secret);
$request->setUpdateMask($fieldMask);

// Update the secret.
$newSecret = $client->updateSecret($request);

// Print the new secret name.
printf('Updated secret: %s', $newSecret->getName());
}
// [END secretmanager_disable_secret_delayed_destroy]

// The following 2 lines are only needed to execute the samples on the CLI
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?php
/*
* Copyright 2025 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.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_update_regional_secret_with_delayed_destroy]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\UpdateSecretRequest;
use Google\Protobuf\Duration;
use Google\Protobuf\FieldMask;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $locationId Your Google Cloud Location ID (e.g. 'us-central1')
* @param string $secretId Your secret ID (e.g. 'my-secret')
* @param int $versionDestroyTtl Your Version Destroy Ttl (e.g. 86400)
*/
function update_regional_secret_with_delayed_destroy(string $projectId, string $locationId, string $secretId, int $versionDestroyTtl): void
{
// Specify regional endpoint.
$options = ['apiEndpoint' => "secretmanager.$locationId.rep.googleapis.com"];

// Create the Secret Manager client.
$client = new SecretManagerServiceClient($options);

// Build the resource name of the secret.
$name = $client->projectLocationSecretName($projectId, $locationId, $secretId);

// Build the secret.
$secret = new Secret([
'name' => $name,
'version_destroy_ttl' => new Duration([
'seconds' => $versionDestroyTtl,
])
]);

// Set the field mask.
$fieldMask = new FieldMask();
$fieldMask->setPaths(['version_destroy_ttl']);

// Build the request.
$request = new UpdateSecretRequest();
$request->setSecret($secret);
$request->setUpdateMask($fieldMask);

// Update the secret.
$newSecret = $client->updateSecret($request);

// Print the new secret name.
printf('Updated secret: %s', $newSecret->getName());
}
// [END secretmanager_update_regional_secret_with_delayed_destroy]

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