Reference documentation and code samples for the Cloud KMS V1 Client class HsmManagementClient.
Service Description: Google Cloud HSM Management Service
Provides interfaces for managing HSM instances.
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 \ Kms \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array|Google\ApiCore\Options\ClientOptions
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 |
FetchAuthTokenInterface|CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ 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 |
↳ 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 |
↳ 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain |
string
The service domain for the client. Defaults to 'googleapis.com'. |
approveSingleTenantHsmInstanceProposal
Approves a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the PENDING state.
The async variant is HsmManagementClient::approveSingleTenantHsmInstanceProposalAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\ApproveSingleTenantHsmInstanceProposalRequest
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\Kms\V1\ApproveSingleTenantHsmInstanceProposalResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\ApproveSingleTenantHsmInstanceProposalRequest;
use Google\Cloud\Kms\V1\ApproveSingleTenantHsmInstanceProposalRequest\QuorumReply;
use Google\Cloud\Kms\V1\ApproveSingleTenantHsmInstanceProposalResponse;
use Google\Cloud\Kms\V1\ChallengeReply;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
/**
* @param string $formattedName The
* [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the
* [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]
* to approve. Please see
* {@see HsmManagementClient::singleTenantHsmInstanceProposalName()} for help formatting this field.
* @param string $quorumReplyChallengeRepliesSignedChallenge The signed challenge associated with the 2FA key.
* The signature must be RSASSA-PKCS1 v1.5 with a SHA256 digest.
* @param string $quorumReplyChallengeRepliesPublicKeyPem The public key associated with the 2FA key.
*/
function approve_single_tenant_hsm_instance_proposal_sample(
string $formattedName,
string $quorumReplyChallengeRepliesSignedChallenge,
string $quorumReplyChallengeRepliesPublicKeyPem
): void {
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$challengeReply = (new ChallengeReply())
->setSignedChallenge($quorumReplyChallengeRepliesSignedChallenge)
->setPublicKeyPem($quorumReplyChallengeRepliesPublicKeyPem);
$quorumReplyChallengeReplies = [$challengeReply,];
$quorumReply = (new QuorumReply())
->setChallengeReplies($quorumReplyChallengeReplies);
$request = (new ApproveSingleTenantHsmInstanceProposalRequest())
->setName($formattedName)
->setQuorumReply($quorumReply);
// Call the API and handle any network failures.
try {
/** @var ApproveSingleTenantHsmInstanceProposalResponse $response */
$response = $hsmManagementClient->approveSingleTenantHsmInstanceProposal($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 = HsmManagementClient::singleTenantHsmInstanceProposalName(
'[PROJECT]',
'[LOCATION]',
'[SINGLE_TENANT_HSM_INSTANCE]',
'[PROPOSAL]'
);
$quorumReplyChallengeRepliesSignedChallenge = '...';
$quorumReplyChallengeRepliesPublicKeyPem = '[PUBLIC_KEY_PEM]';
approve_single_tenant_hsm_instance_proposal_sample(
$formattedName,
$quorumReplyChallengeRepliesSignedChallenge,
$quorumReplyChallengeRepliesPublicKeyPem
);
}
createSingleTenantHsmInstance
Creates a new SingleTenantHsmInstance in a given Project and Location. User must create a RegisterTwoFactorAuthKeys proposal with this single-tenant HSM instance to finish setup of the instance.
The async variant is HsmManagementClient::createSingleTenantHsmInstanceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\CreateSingleTenantHsmInstanceRequest
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\OperationResponse<Google\Cloud\Kms\V1\SingleTenantHsmInstance> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Kms\V1\CreateSingleTenantHsmInstanceRequest;
use Google\Cloud\Kms\V1\SingleTenantHsmInstance;
use Google\Cloud\Kms\V1\SingleTenantHsmInstance\QuorumAuth;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the location associated with the
* [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance], in
* the format `projects/*/locations/*`. Please see
* {@see HsmManagementClient::locationName()} for help formatting this field.
* @param int $singleTenantHsmInstanceQuorumAuthTotalApproverCount The total number of approvers. This is the N value used
* for M of N quorum auth. Must be greater than or equal to 3 and less than
* or equal to 16.
*/
function create_single_tenant_hsm_instance_sample(
string $formattedParent,
int $singleTenantHsmInstanceQuorumAuthTotalApproverCount
): void {
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$singleTenantHsmInstanceQuorumAuth = (new QuorumAuth())
->setTotalApproverCount($singleTenantHsmInstanceQuorumAuthTotalApproverCount);
$singleTenantHsmInstance = (new SingleTenantHsmInstance())
->setQuorumAuth($singleTenantHsmInstanceQuorumAuth);
$request = (new CreateSingleTenantHsmInstanceRequest())
->setParent($formattedParent)
->setSingleTenantHsmInstance($singleTenantHsmInstance);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hsmManagementClient->createSingleTenantHsmInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var SingleTenantHsmInstance $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = HsmManagementClient::locationName('[PROJECT]', '[LOCATION]');
$singleTenantHsmInstanceQuorumAuthTotalApproverCount = 0;
create_single_tenant_hsm_instance_sample(
$formattedParent,
$singleTenantHsmInstanceQuorumAuthTotalApproverCount
);
}
createSingleTenantHsmInstanceProposal
Creates a new SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance.
The async variant is HsmManagementClient::createSingleTenantHsmInstanceProposalAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\CreateSingleTenantHsmInstanceProposalRequest
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\OperationResponse<Google\Cloud\Kms\V1\SingleTenantHsmInstanceProposal> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Kms\V1\CreateSingleTenantHsmInstanceProposalRequest;
use Google\Cloud\Kms\V1\SingleTenantHsmInstanceProposal;
use Google\Rpc\Status;
/**
* @param string $formattedParent The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of
* the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
* associated with the
* [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]. Please see
* {@see HsmManagementClient::singleTenantHsmInstanceName()} for help formatting this field.
*/
function create_single_tenant_hsm_instance_proposal_sample(string $formattedParent): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$singleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal();
$request = (new CreateSingleTenantHsmInstanceProposalRequest())
->setParent($formattedParent)
->setSingleTenantHsmInstanceProposal($singleTenantHsmInstanceProposal);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hsmManagementClient->createSingleTenantHsmInstanceProposal($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var SingleTenantHsmInstanceProposal $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = HsmManagementClient::singleTenantHsmInstanceName(
'[PROJECT]',
'[LOCATION]',
'[SINGLE_TENANT_HSM_INSTANCE]'
);
create_single_tenant_hsm_instance_proposal_sample($formattedParent);
}
deleteSingleTenantHsmInstanceProposal
Deletes a SingleTenantHsmInstanceProposal.
The async variant is HsmManagementClient::deleteSingleTenantHsmInstanceProposalAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\DeleteSingleTenantHsmInstanceProposalRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Kms\V1\DeleteSingleTenantHsmInstanceProposalRequest;
/**
* @param string $formattedName The
* [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the
* [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]
* to delete. Please see
* {@see HsmManagementClient::singleTenantHsmInstanceProposalName()} for help formatting this field.
*/
function delete_single_tenant_hsm_instance_proposal_sample(string $formattedName): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = (new DeleteSingleTenantHsmInstanceProposalRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$hsmManagementClient->deleteSingleTenantHsmInstanceProposal($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 = HsmManagementClient::singleTenantHsmInstanceProposalName(
'[PROJECT]',
'[LOCATION]',
'[SINGLE_TENANT_HSM_INSTANCE]',
'[PROPOSAL]'
);
delete_single_tenant_hsm_instance_proposal_sample($formattedName);
}
executeSingleTenantHsmInstanceProposal
Executes a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the APPROVED state.
The async variant is HsmManagementClient::executeSingleTenantHsmInstanceProposalAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\ExecuteSingleTenantHsmInstanceProposalRequest
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\OperationResponse<Google\Cloud\Kms\V1\ExecuteSingleTenantHsmInstanceProposalResponse> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Kms\V1\ExecuteSingleTenantHsmInstanceProposalRequest;
use Google\Cloud\Kms\V1\ExecuteSingleTenantHsmInstanceProposalResponse;
use Google\Rpc\Status;
/**
* @param string $formattedName The
* [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the
* [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]
* to execute. Please see
* {@see HsmManagementClient::singleTenantHsmInstanceProposalName()} for help formatting this field.
*/
function execute_single_tenant_hsm_instance_proposal_sample(string $formattedName): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = (new ExecuteSingleTenantHsmInstanceProposalRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hsmManagementClient->executeSingleTenantHsmInstanceProposal($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ExecuteSingleTenantHsmInstanceProposalResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = HsmManagementClient::singleTenantHsmInstanceProposalName(
'[PROJECT]',
'[LOCATION]',
'[SINGLE_TENANT_HSM_INSTANCE]',
'[PROPOSAL]'
);
execute_single_tenant_hsm_instance_proposal_sample($formattedName);
}
getSingleTenantHsmInstance
Returns metadata for a given SingleTenantHsmInstance.
The async variant is HsmManagementClient::getSingleTenantHsmInstanceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\GetSingleTenantHsmInstanceRequest
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\Kms\V1\SingleTenantHsmInstance |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Kms\V1\GetSingleTenantHsmInstanceRequest;
use Google\Cloud\Kms\V1\SingleTenantHsmInstance;
/**
* @param string $formattedName The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of
* the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
* to get. Please see
* {@see HsmManagementClient::singleTenantHsmInstanceName()} for help formatting this field.
*/
function get_single_tenant_hsm_instance_sample(string $formattedName): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = (new GetSingleTenantHsmInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var SingleTenantHsmInstance $response */
$response = $hsmManagementClient->getSingleTenantHsmInstance($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 = HsmManagementClient::singleTenantHsmInstanceName(
'[PROJECT]',
'[LOCATION]',
'[SINGLE_TENANT_HSM_INSTANCE]'
);
get_single_tenant_hsm_instance_sample($formattedName);
}
getSingleTenantHsmInstanceProposal
Returns metadata for a given SingleTenantHsmInstanceProposal.
The async variant is HsmManagementClient::getSingleTenantHsmInstanceProposalAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\GetSingleTenantHsmInstanceProposalRequest
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\Kms\V1\SingleTenantHsmInstanceProposal |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Kms\V1\GetSingleTenantHsmInstanceProposalRequest;
use Google\Cloud\Kms\V1\SingleTenantHsmInstanceProposal;
/**
* @param string $formattedName The
* [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the
* [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]
* to get. Please see
* {@see HsmManagementClient::singleTenantHsmInstanceProposalName()} for help formatting this field.
*/
function get_single_tenant_hsm_instance_proposal_sample(string $formattedName): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = (new GetSingleTenantHsmInstanceProposalRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var SingleTenantHsmInstanceProposal $response */
$response = $hsmManagementClient->getSingleTenantHsmInstanceProposal($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 = HsmManagementClient::singleTenantHsmInstanceProposalName(
'[PROJECT]',
'[LOCATION]',
'[SINGLE_TENANT_HSM_INSTANCE]',
'[PROPOSAL]'
);
get_single_tenant_hsm_instance_proposal_sample($formattedName);
}
listSingleTenantHsmInstanceProposals
Lists SingleTenantHsmInstanceProposals.
The async variant is HsmManagementClient::listSingleTenantHsmInstanceProposalsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\ListSingleTenantHsmInstanceProposalsRequest
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 |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Kms\V1\ListSingleTenantHsmInstanceProposalsRequest;
use Google\Cloud\Kms\V1\SingleTenantHsmInstanceProposal;
/**
* @param string $formattedParent The resource name of the single tenant HSM instance associated
* with the
* [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]
* to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`. Please see
* {@see HsmManagementClient::singleTenantHsmInstanceName()} for help formatting this field.
*/
function list_single_tenant_hsm_instance_proposals_sample(string $formattedParent): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = (new ListSingleTenantHsmInstanceProposalsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hsmManagementClient->listSingleTenantHsmInstanceProposals($request);
/** @var SingleTenantHsmInstanceProposal $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 = HsmManagementClient::singleTenantHsmInstanceName(
'[PROJECT]',
'[LOCATION]',
'[SINGLE_TENANT_HSM_INSTANCE]'
);
list_single_tenant_hsm_instance_proposals_sample($formattedParent);
}
listSingleTenantHsmInstances
Lists SingleTenantHsmInstances.
The async variant is HsmManagementClient::listSingleTenantHsmInstancesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\ListSingleTenantHsmInstancesRequest
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 |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Kms\V1\ListSingleTenantHsmInstancesRequest;
use Google\Cloud\Kms\V1\SingleTenantHsmInstance;
/**
* @param string $formattedParent The resource name of the location associated with the
* [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
* list, in the format `projects/*/locations/*`. Please see
* {@see HsmManagementClient::locationName()} for help formatting this field.
*/
function list_single_tenant_hsm_instances_sample(string $formattedParent): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = (new ListSingleTenantHsmInstancesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hsmManagementClient->listSingleTenantHsmInstances($request);
/** @var SingleTenantHsmInstance $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 = HsmManagementClient::locationName('[PROJECT]', '[LOCATION]');
list_single_tenant_hsm_instances_sample($formattedParent);
}
getLocation
Gets information about a location.
The async variant is HsmManagementClient::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
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\Location\Location |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
/**
* 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 get_location_sample(): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $hsmManagementClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
The async variant is HsmManagementClient::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
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 |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
/**
* 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 list_locations_sample(): void
{
// Create a client.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hsmManagementClient->listLocations($request);
/** @var Location $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());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
The async variant is HsmManagementClient::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 |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
/**
* @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.
$hsmManagementClient = new HsmManagementClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $hsmManagementClient->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);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
errors.
The async variant is HsmManagementClient::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 |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
/**
* @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.
$hsmManagementClient = new HsmManagementClient();
// 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 = $hsmManagementClient->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 on the specified resource. If the
resource does not exist, this will return 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 HsmManagementClient::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 |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Kms\V1\Client\HsmManagementClient;
/**
* @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.
$hsmManagementClient = new HsmManagementClient();
// 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 = $hsmManagementClient->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);
}
approveSingleTenantHsmInstanceProposalAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\ApproveSingleTenantHsmInstanceProposalRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Kms\V1\ApproveSingleTenantHsmInstanceProposalResponse> |
|
createSingleTenantHsmInstanceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\CreateSingleTenantHsmInstanceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
createSingleTenantHsmInstanceProposalAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\CreateSingleTenantHsmInstanceProposalRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteSingleTenantHsmInstanceProposalAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\DeleteSingleTenantHsmInstanceProposalRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
executeSingleTenantHsmInstanceProposalAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\ExecuteSingleTenantHsmInstanceProposalRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
getSingleTenantHsmInstanceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\GetSingleTenantHsmInstanceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Kms\V1\SingleTenantHsmInstance> |
|
getSingleTenantHsmInstanceProposalAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\GetSingleTenantHsmInstanceProposalRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Kms\V1\SingleTenantHsmInstanceProposal> |
|
listSingleTenantHsmInstanceProposalsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\ListSingleTenantHsmInstanceProposalsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listSingleTenantHsmInstancesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Kms\V1\ListSingleTenantHsmInstancesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getLocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
|
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
|
setIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
|
testIamPermissionsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> |
|
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\LongRunning\Client\OperationsClient |
|
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
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::singleTenantHsmInstanceName
Formats a string containing the fully-qualified path to represent a single_tenant_hsm_instance resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
singleTenantHsmInstance |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted single_tenant_hsm_instance resource. |
static::singleTenantHsmInstanceProposalName
Formats a string containing the fully-qualified path to represent a single_tenant_hsm_instance_proposal resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
singleTenantHsmInstance |
string
|
proposal |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted single_tenant_hsm_instance_proposal 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}
- singleTenantHsmInstance: projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}
- singleTenantHsmInstanceProposal: projects/{project}/locations/{location}/singleTenantHsmInstances/{single_tenant_hsm_instance}/proposals/{proposal}
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. |