Secret Manager V1beta1 Client - Class SecretManagerServiceClient (1.15.2)

Reference documentation and code samples for the Secret Manager V1beta1 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. Sample code to get started:

$secretManagerServiceClient = new SecretManagerServiceClient();
try {
    $formattedName = $secretManagerServiceClient->secretVersionName('[PROJECT]', '[SECRET]', '[SECRET_VERSION]');
    $response = $secretManagerServiceClient->accessSecretVersion($formattedName);
} finally {
    $secretManagerServiceClient->close();
}

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 \ V1beta1

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

Parameters
Name	Description
`name`	`string` Required. The resource name of the SecretVersion in the format `projects//secrets//versions/*`.
`optionalArgs`	`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\V1beta1\AccessSecretVersionResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\AccessSecretVersionResponse;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;

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

    // Call the API and handle any network failures.
    try {
        /** @var AccessSecretVersionResponse $response */
        $response = $secretManagerServiceClient->accessSecretVersion($formattedName);
        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.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Secret to associate with the SecretVersion in the format `projects//secrets/`.
`payload`	`Google\Cloud\SecretManager\V1beta1\SecretPayload` Required. The secret payload of the SecretVersion.
`optionalArgs`	`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\V1beta1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1beta1\SecretPayload;
use Google\Cloud\SecretManager\V1beta1\SecretVersion;

/**
 * @param string $formattedParent The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret] to associate with the
 *                                [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] in the format `projects/&#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 any non-scalar elements to be passed along with the request.
    $payload = new SecretPayload();

    // Call the API and handle any network failures.
    try {
        /** @var SecretVersion $response */
        $response = $secretManagerServiceClient->addSecretVersion($formattedParent, $payload);
        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.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the project to associate with the Secret, in the format `projects/*`.
`secretId`	`string` Required. 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.
`secret`	`Google\Cloud\SecretManager\V1beta1\Secret` Required. A Secret with initial field values.
`optionalArgs`	`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\V1beta1\Secret`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\Replication;
use Google\Cloud\SecretManager\V1beta1\Secret;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;

/**
 * @param string $formattedParent The resource name of the project to associate with the
 *                                [Secret][google.cloud.secrets.v1beta1.Secret], in the format `projects/*`. 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 any non-scalar elements to be passed along with the request.
    $secretReplication = new Replication();
    $secret = (new Secret())
        ->setReplication($secretReplication);

    // Call the API and handle any network failures.
    try {
        /** @var Secret $response */
        $response = $secretManagerServiceClient->createSecret($formattedParent, $secretId, $secret);
        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.

Parameters
Name	Description
`name`	`string` Required. The resource name of the Secret to delete in the format `projects//secrets/`.
`optionalArgs`	`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\V1beta1\SecretManagerServiceClient;

/**
 * @param string $formattedName The resource name of the [Secret][google.cloud.secrets.v1beta1.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();

    // Call the API and handle any network failures.
    try {
        $secretManagerServiceClient->deleteSecret($formattedName);
        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.

Parameters
Name	Description
`name`	`string` Required. The resource name of the SecretVersion to destroy in the format `projects//secrets//versions/*`.
`optionalArgs`	`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\V1beta1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1beta1\SecretVersion;

/**
 * @param string $formattedName The resource name of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to destroy in the format
 *                              `projects/&#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();

    // Call the API and handle any network failures.
    try {
        /** @var SecretVersion $response */
        $response = $secretManagerServiceClient->destroySecretVersion($formattedName);
        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.

Parameters
Name	Description
`name`	`string` Required. The resource name of the SecretVersion to disable in the format `projects//secrets//versions/*`.
`optionalArgs`	`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\V1beta1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1beta1\SecretVersion;

/**
 * @param string $formattedName The resource name of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to disable in the format
 *                              `projects/&#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();

    // Call the API and handle any network failures.
    try {
        /** @var SecretVersion $response */
        $response = $secretManagerServiceClient->disableSecretVersion($formattedName);
        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.

Parameters
Name	Description
`name`	`string` Required. The resource name of the SecretVersion to enable in the format `projects//secrets//versions/*`.
`optionalArgs`	`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\V1beta1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1beta1\SecretVersion;

/**
 * @param string $formattedName The resource name of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to enable in the format
 *                              `projects/&#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();

    // Call the API and handle any network failures.
    try {
        /** @var SecretVersion $response */
        $response = $secretManagerServiceClient->enableSecretVersion($formattedName);
        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.

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`optionalArgs`	`array` Optional.
`↳ options`	`GetPolicyOptions` OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
`↳ 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\SecretManager\V1beta1\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();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $secretManagerServiceClient->getIamPolicy($resource);
        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.

Parameters
Name	Description
`name`	`string` Required. The resource name of the Secret, in the format `projects//secrets/`.
`optionalArgs`	`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\V1beta1\Secret`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\Secret;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;

/**
 * @param string $formattedName The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret], in the format `projects/&#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();

    // Call the API and handle any network failures.
    try {
        /** @var Secret $response */
        $response = $secretManagerServiceClient->getSecret($formattedName);
        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 latest SecretVersion.

Parameters
Name	Description
`name`	`string` Required. The resource name of the SecretVersion in the format `projects//secrets//versions/`. `projects//secrets/*/versions/latest` is an alias to the `latest` SecretVersion.
`optionalArgs`	`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\V1beta1\SecretVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1beta1\SecretVersion;

/**
 * @param string $formattedName The resource name of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] in the format
 *                              `projects/&#42;/secrets/&#42;/versions/*`.
 *                              `projects/&#42;/secrets/&#42;/versions/latest` is an alias to the `latest`
 *                              [SecretVersion][google.cloud.secrets.v1beta1.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();

    // Call the API and handle any network failures.
    try {
        /** @var SecretVersion $response */
        $response = $secretManagerServiceClient->getSecretVersion($formattedName);
        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.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects//secrets/`.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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\V1beta1\SecretManagerServiceClient;
use Google\Cloud\SecretManager\V1beta1\SecretVersion;

/**
 * @param string $formattedParent The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret] associated with the
 *                                [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] to list, in the format
 *                                `projects/&#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();

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

        /** @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.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the project associated with the Secrets, in the format `projects/*`.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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\V1beta1\Secret;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;

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

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

        /** @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.

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`Google\Cloud\Iam\V1\Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
`↳ 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\SecretManager\V1beta1\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 any non-scalar elements to be passed along with the request.
    $policy = new Policy();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $secretManagerServiceClient->setIamPolicy($resource, $policy);
        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.

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`string[]` 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.
`optionalArgs`	`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\TestIamPermissionsResponse;
use Google\Cloud\SecretManager\V1beta1\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 any non-scalar elements to be passed along with the request.
    $permissions = [$permissionsElement,];

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $secretManagerServiceClient->testIamPermissions($resource, $permissions);
        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.

Parameters
Name	Description
`secret`	`Google\Cloud\SecretManager\V1beta1\Secret` Required. Secret with updated field values.
`updateMask`	`Google\Protobuf\FieldMask` Required. Specifies the fields to be updated.
`optionalArgs`	`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\V1beta1\Secret`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\SecretManager\V1beta1\Replication;
use Google\Cloud\SecretManager\V1beta1\Secret;
use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
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 any non-scalar elements to be passed along with the request.
    $secretReplication = new Replication();
    $secret = (new Secret())
        ->setReplication($secretReplication);
    $updateMask = new FieldMask();

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

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

project: projects/{project}
secret: projects/{project}/secrets/{secret}
secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version}

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.

Constants

SERVICE_NAME

Value: 'google.cloud.secrets.v1beta1.SecretManagerService'

The name of the service.

SERVICE_ADDRESS

Value: 'secretmanager.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.