Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CmekConfigServiceClient.
Service Description: Service for managing CMEK related tasks
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 \ DiscoveryEngine \ V1 \ ClientMethods
__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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ 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 |
deleteCmekConfig
De-provisions a CmekConfig.
The async variant is CmekConfigServiceClient::deleteCmekConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\DeleteCmekConfigRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\CmekConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DeleteCmekConfigRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the
* [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig] to delete, such as
* `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. Please see
* {@see CmekConfigServiceClient::cmekConfigName()} for help formatting this field.
*/
function delete_cmek_config_sample(string $formattedName): void
{
// Create a client.
$cmekConfigServiceClient = new CmekConfigServiceClient();
// Prepare the request message.
$request = (new DeleteCmekConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cmekConfigServiceClient->deleteCmekConfig($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} 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 = CmekConfigServiceClient::cmekConfigName('[PROJECT]', '[LOCATION]');
delete_cmek_config_sample($formattedName);
}
getCmekConfig
Gets the CmekConfig.
The async variant is CmekConfigServiceClient::getCmekConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\GetCmekConfigRequest
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\DiscoveryEngine\V1\CmekConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\CmekConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CmekConfig;
use Google\Cloud\DiscoveryEngine\V1\GetCmekConfigRequest;
/**
* @param string $formattedName Resource name of
* [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], such as
* `projects/*/locations/*/cmekConfig` or
* `projects/*/locations/*/cmekConfigs/*`.
*
* If the caller does not have permission to access the
* [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], regardless of
* whether or not it exists, a PERMISSION_DENIED error is returned. Please see
* {@see CmekConfigServiceClient::cmekConfigName()} for help formatting this field.
*/
function get_cmek_config_sample(string $formattedName): void
{
// Create a client.
$cmekConfigServiceClient = new CmekConfigServiceClient();
// Prepare the request message.
$request = (new GetCmekConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var CmekConfig $response */
$response = $cmekConfigServiceClient->getCmekConfig($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 = CmekConfigServiceClient::cmekConfigName('[PROJECT]', '[LOCATION]');
get_cmek_config_sample($formattedName);
}
listCmekConfigs
Lists all the CmekConfigs with the project.
The async variant is CmekConfigServiceClient::listCmekConfigsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\ListCmekConfigsRequest
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\DiscoveryEngine\V1\ListCmekConfigsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\CmekConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\ListCmekConfigsRequest;
use Google\Cloud\DiscoveryEngine\V1\ListCmekConfigsResponse;
/**
* @param string $formattedParent The parent location resource name, such as
* `projects/{project}/locations/{location}`.
*
* If the caller does not have permission to list
* [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s under this
* location, regardless of whether or not a CmekConfig exists, a
* PERMISSION_DENIED error is returned. Please see
* {@see CmekConfigServiceClient::locationName()} for help formatting this field.
*/
function list_cmek_configs_sample(string $formattedParent): void
{
// Create a client.
$cmekConfigServiceClient = new CmekConfigServiceClient();
// Prepare the request message.
$request = (new ListCmekConfigsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var ListCmekConfigsResponse $response */
$response = $cmekConfigServiceClient->listCmekConfigs($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 = CmekConfigServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_cmek_configs_sample($formattedParent);
}
updateCmekConfig
Provisions a CMEK key for use in a location of a customer's project.
This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
The async variant is CmekConfigServiceClient::updateCmekConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\UpdateCmekConfigRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\CmekConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CmekConfig;
use Google\Cloud\DiscoveryEngine\V1\UpdateCmekConfigRequest;
use Google\Rpc\Status;
/**
* @param string $configName The name of the CmekConfig of the form
* `projects/{project}/locations/{location}/cmekConfig` or
* `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
*/
function update_cmek_config_sample(string $configName): void
{
// Create a client.
$cmekConfigServiceClient = new CmekConfigServiceClient();
// Prepare the request message.
$config = (new CmekConfig())
->setName($configName);
$request = (new UpdateCmekConfigRequest())
->setConfig($config);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cmekConfigServiceClient->updateCmekConfig($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var CmekConfig $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
{
$configName = '[NAME]';
update_cmek_config_sample($configName);
}
deleteCmekConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\DeleteCmekConfigRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getCmekConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\GetCmekConfigRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\CmekConfig> |
listCmekConfigsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\ListCmekConfigsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\ListCmekConfigsResponse> |
updateCmekConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\UpdateCmekConfigRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
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::cmekConfigName
Formats a string containing the fully-qualified path to represent a cmek_config resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted cmek_config resource. |
static::cryptoKeyVersionsName
Formats a string containing the fully-qualified path to represent a crypto_key_versions resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
cryptoKeyVersion |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted crypto_key_versions resource. |
static::cryptoKeysName
Formats a string containing the fully-qualified path to represent a crypto_keys resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted crypto_keys resource. |
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::projectLocationCmekConfigName
Formats a string containing the fully-qualified path to represent a project_location_cmekConfig resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_cmekConfig 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
- cmekConfig: projects/{project}/locations/{location}/cmekConfig
- cryptoKeyVersions: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
- cryptoKeys: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- location: projects/{project}/locations/{location}
- projectLocationCmekConfig: projects/{project}/locations/{location}/cmekConfig
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. |