Secret Manager V1 Client - Class SecretManagerServiceClient (1.15.2)

Reference documentation and code samples for the Secret Manager V1 Client class SecretManagerServiceClient.

Service Description: Secret Manager Service

Manages secrets and operations using those secrets. Implements a REST model with the following objects:

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

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` 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`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ 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() .
`↳ 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\|TransportInterface` 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 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() and 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.

accessSecretVersion

Accesses a SecretVersion.

This call returns the secret data.

projects/*/secrets/*/versions/latest is an alias to the most recently created SecretVersion.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::accessSecretVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\AccessSecretVersionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\AccessSecretVersionResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\AccessSecretVersionRequest;
use Google\Cloud\SecretManager\V1\AccessSecretVersionResponse;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;

/**
 * @param string $formattedName The resource name of the
 *                              [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
 *                              `projects/&#42;/secrets/&#42;/versions/*` or
 *                              `projects/&#42;/locations/&#42;/secrets/&#42;/versions/*`.
 *
 *                              `projects/&#42;/secrets/&#42;/versions/latest` or
 *                              `projects/&#42;/locations/&#42;/secrets/&#42;/versions/latest` is an alias to the most
 *                              recently created
 *                              [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Please see
 *                              {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field.
 */
function access_secret_version_sample(string $formattedName): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SecretManagerServiceClient::secretVersionName(
        '[PROJECT]',
        '[SECRET]',
        '[SECRET_VERSION]'
    );

    access_secret_version_sample($formattedName);
}

addSecretVersion

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::addSecretVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\AddSecretVersionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\AddSecretVersionRequest;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\SecretPayload;
use Google\Cloud\SecretManager\V1\SecretVersion;

/**
 * @param string $formattedParent The resource name of the
 *                                [Secret][google.cloud.secretmanager.v1.Secret] to associate with the
 *                                [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
 *                                `projects/&#42;/secrets/*` or `projects/&#42;/locations/&#42;/secrets/*`. Please see
 *                                {@see SecretManagerServiceClient::secretName()} for help formatting this field.
 */
function add_secret_version_sample(string $formattedParent): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

    // Prepare the request message.
    $payload = new SecretPayload();
    $request = (new AddSecretVersionRequest())
        ->setParent($formattedParent)
        ->setPayload($payload);

    // Call the API and handle any network failures.
    try {
        /** @var SecretVersion $response */
        $response = $secretManagerServiceClient->addSecretVersion($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
{
    $formattedParent = SecretManagerServiceClient::secretName('[PROJECT]', '[SECRET]');

    add_secret_version_sample($formattedParent);
}

createSecret

Creates a new Secret containing no SecretVersions.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::createSecretAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\CreateSecretRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\Secret`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Secret;

/**
 * @param string $formattedParent The resource name of the project to associate with the
 *                                [Secret][google.cloud.secretmanager.v1.Secret], in the format `projects/*`
 *                                or `projects/&#42;/locations/*`. Please see
 *                                {@see SecretManagerServiceClient::projectName()} for help formatting this field.
 * @param string $secretId        This must be unique within the project.
 *
 *                                A secret ID is a string with a maximum length of 255 characters and can
 *                                contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and
 *                                underscore (`_`) characters.
 */
function create_secret_sample(string $formattedParent, string $secretId): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

    // Prepare the request message.
    $secret = new Secret();
    $request = (new CreateSecretRequest())
        ->setParent($formattedParent)
        ->setSecretId($secretId)
        ->setSecret($secret);

    // Call the API and handle any network failures.
    try {
        /** @var Secret $response */
        $response = $secretManagerServiceClient->createSecret($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
{
    $formattedParent = SecretManagerServiceClient::projectName('[PROJECT]');
    $secretId = '[SECRET_ID]';

    create_secret_sample($formattedParent, $secretId);
}

deleteSecret

Deletes a Secret.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::deleteSecretAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\DeleteSecretRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\DeleteSecretRequest;

/**
 * @param string $formattedName The resource name of the
 *                              [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format
 *                              `projects/&#42;/secrets/*`. Please see
 *                              {@see SecretManagerServiceClient::secretName()} for help formatting this field.
 */
function delete_secret_sample(string $formattedName): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $secretManagerServiceClient->deleteSecret($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
{
    $formattedName = SecretManagerServiceClient::secretName('[PROJECT]', '[SECRET]');

    delete_secret_sample($formattedName);
}

destroySecretVersion

Destroys a SecretVersion.

Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::destroySecretVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\DestroySecretVersionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\DestroySecretVersionRequest;
use Google\Cloud\SecretManager\V1\SecretVersion;

/**
 * @param string $formattedName The resource name of the
 *                              [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in
 *                              the format `projects/&#42;/secrets/&#42;/versions/*` or
 *                              `projects/&#42;/locations/&#42;/secrets/&#42;/versions/*`. Please see
 *                              {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field.
 */
function destroy_secret_version_sample(string $formattedName): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SecretManagerServiceClient::secretVersionName(
        '[PROJECT]',
        '[SECRET]',
        '[SECRET_VERSION]'
    );

    destroy_secret_version_sample($formattedName);
}

disableSecretVersion

Disables a SecretVersion.

Sets the state of the SecretVersion to DISABLED.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::disableSecretVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\DisableSecretVersionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\DisableSecretVersionRequest;
use Google\Cloud\SecretManager\V1\SecretVersion;

/**
 * @param string $formattedName The resource name of the
 *                              [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in
 *                              the format `projects/&#42;/secrets/&#42;/versions/*` or
 *                              `projects/&#42;/locations/&#42;/secrets/&#42;/versions/*`. Please see
 *                              {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field.
 */
function disable_secret_version_sample(string $formattedName): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SecretManagerServiceClient::secretVersionName(
        '[PROJECT]',
        '[SECRET]',
        '[SECRET_VERSION]'
    );

    disable_secret_version_sample($formattedName);
}

enableSecretVersion

Enables a SecretVersion.

Sets the state of the SecretVersion to ENABLED.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::enableSecretVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\EnableSecretVersionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\EnableSecretVersionRequest;
use Google\Cloud\SecretManager\V1\SecretVersion;

/**
 * @param string $formattedName The resource name of the
 *                              [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in
 *                              the format `projects/&#42;/secrets/&#42;/versions/*` or
 *                              `projects/&#42;/locations/&#42;/secrets/&#42;/versions/*`. Please see
 *                              {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field.
 */
function enable_secret_version_sample(string $formattedName): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SecretManagerServiceClient::secretVersionName(
        '[PROJECT]',
        '[SECRET]',
        '[SECRET_VERSION]'
    );

    enable_secret_version_sample($formattedName);
}

getIamPolicy

Gets the access control policy for a secret.

Returns empty policy if the secret exists and does not have a policy set.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;

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

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

getSecret

Gets metadata for a given Secret.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\GetSecretRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\Secret`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\GetSecretRequest;
use Google\Cloud\SecretManager\V1\Secret;

/**
 * @param string $formattedName The resource name of the
 *                              [Secret][google.cloud.secretmanager.v1.Secret], in the format
 *                              `projects/&#42;/secrets/*` or `projects/&#42;/locations/&#42;/secrets/*`. Please see
 *                              {@see SecretManagerServiceClient::secretName()} for help formatting this field.
 */
function get_secret_sample(string $formattedName): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SecretManagerServiceClient::secretName('[PROJECT]', '[SECRET]');

    get_secret_sample($formattedName);
}

getSecretVersion

Gets metadata for a SecretVersion.

projects/*/secrets/*/versions/latest is an alias to the most recently created SecretVersion.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecretVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\GetSecretVersionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\GetSecretVersionRequest;
use Google\Cloud\SecretManager\V1\SecretVersion;

/**
 * @param string $formattedName The resource name of the
 *                              [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
 *                              `projects/&#42;/secrets/&#42;/versions/*` or
 *                              `projects/&#42;/locations/&#42;/secrets/&#42;/versions/*`.
 *
 *                              `projects/&#42;/secrets/&#42;/versions/latest` or
 *                              `projects/&#42;/locations/&#42;/secrets/&#42;/versions/latest` is an alias to the most
 *                              recently created
 *                              [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Please see
 *                              {@see SecretManagerServiceClient::secretVersionName()} for help formatting this field.
 */
function get_secret_version_sample(string $formattedName): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SecretManagerServiceClient::secretVersionName(
        '[PROJECT]',
        '[SECRET]',
        '[SECRET_VERSION]'
    );

    get_secret_version_sample($formattedName);
}

listSecretVersions

Lists SecretVersions. This call does not return secret data.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretVersionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\ListSecretVersionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\ListSecretVersionsRequest;
use Google\Cloud\SecretManager\V1\SecretVersion;

/**
 * @param string $formattedParent The resource name of the
 *                                [Secret][google.cloud.secretmanager.v1.Secret] associated with the
 *                                [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] to list, in
 *                                the format `projects/&#42;/secrets/*` or `projects/&#42;/locations/&#42;/secrets/*`. Please see
 *                                {@see SecretManagerServiceClient::secretName()} for help formatting this field.
 */
function list_secret_versions_sample(string $formattedParent): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

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

        /** @var SecretVersion $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = SecretManagerServiceClient::secretName('[PROJECT]', '[SECRET]');

    list_secret_versions_sample($formattedParent);
}

listSecrets

Lists Secrets.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecretsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\ListSecretsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\ListSecretsRequest;
use Google\Cloud\SecretManager\V1\Secret;

/**
 * @param string $formattedParent The resource name of the project associated with the
 *                                [Secrets][google.cloud.secretmanager.v1.Secret], in the format `projects/*`
 *                                or `projects/&#42;/locations/*`
 *                                Please see {@see SecretManagerServiceClient::projectName()} for help formatting this field.
 */
function list_secrets_sample(string $formattedParent): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

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

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

        /** @var Secret $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = SecretManagerServiceClient::projectName('[PROJECT]');

    list_secrets_sample($formattedParent);
}

setIamPolicy

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

Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;

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

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

Returns permissions that a caller has for the specified secret.

If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error.

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

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\TestIamPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;

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

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

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

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

updateSecret

Updates metadata of an existing Secret.

The async variant is Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::updateSecretAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\UpdateSecretRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\Secret`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\UpdateSecretRequest;
use Google\Protobuf\FieldMask;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_secret_sample(): void
{
    // Create a client.
    $secretManagerServiceClient = new SecretManagerServiceClient();

    // Prepare the request message.
    $secret = new Secret();
    $updateMask = new FieldMask();
    $request = (new UpdateSecretRequest())
        ->setSecret($secret)
        ->setUpdateMask($updateMask);

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

accessSecretVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\AccessSecretVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

addSecretVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\AddSecretVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createSecretAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\CreateSecretRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteSecretAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\DeleteSecretRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

destroySecretVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\DestroySecretVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

disableSecretVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\DisableSecretVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

enableSecretVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\EnableSecretVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSecretAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\GetSecretRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSecretVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\GetSecretVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSecretVersionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\ListSecretVersionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSecretsAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\ListSecretsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateSecretAsync

Parameters
Name	Description
`request`	`Google\Cloud\SecretManager\V1\UpdateSecretRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::locationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::projectName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::projectLocationSecretName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`secret`	`string`

Returns
Type	Description
`string`	The formatted project_location_secret resource.

static::projectLocationSecretSecretVersionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`secret`	`string`
`secretVersion`	`string`

Returns
Type	Description
`string`	The formatted project_location_secret_secret_version resource.

static::projectSecretName

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

Parameters
Name	Description
`project`	`string`
`secret`	`string`

Returns
Type	Description
`string`	The formatted project_secret resource.

static::projectSecretSecretVersionName

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

Parameters
Name	Description
`project`	`string`
`secret`	`string`
`secretVersion`	`string`

Returns
Type	Description
`string`	The formatted project_secret_secret_version resource.

static::secretName

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

Parameters
Name	Description
`project`	`string`
`secret`	`string`

Returns
Type	Description
`string`	The formatted secret resource.

static::secretVersionName

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

Parameters
Name	Description
`project`	`string`
`secret`	`string`
`secretVersion`	`string`

Returns
Type	Description
`string`	The formatted secret_version resource.

static::topicName

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

Parameters
Name	Description
`project`	`string`
`topic`	`string`

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

location: projects/{project}/locations/{location}
project: projects/{project}
projectLocationSecret: projects/{project}/locations/{location}/secrets/{secret}
projectLocationSecretSecretVersion: projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}
projectSecret: projects/{project}/secrets/{secret}
projectSecretSecretVersion: projects/{project}/secrets/{secret}/versions/{secret_version}
secret: projects/{project}/secrets/{secret}
secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version}
topic: projects/{project}/topics/{topic}

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.