Google Cloud KMS Inventory V1 Client - Class KeyTrackingServiceClient (0.2.3)

Reference documentation and code samples for the Google Cloud KMS Inventory V1 Client class KeyTrackingServiceClient.

Service Description: Returns information about the resources in an org that are protected by a given Cloud KMS key via CMEK.

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:

$keyTrackingServiceClient = new KeyTrackingServiceClient();
try {
    $formattedName = $keyTrackingServiceClient->protectedResourcesSummaryName('[PROJECT]', '[LOCATION]', '[KEY_RING]', '[CRYPTO_KEY]');
    $response = $keyTrackingServiceClient->getProtectedResourcesSummary($formattedName);
} finally {
    $keyTrackingServiceClient->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.

This service has a new (beta) implementation. See Google\Cloud\Kms\Inventory\V1\Client\KeyTrackingServiceClient to use the new surface.

Namespace

Google \ Cloud \ Kms \ Inventory \ V1

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.

getProtectedResourcesSummary

Returns aggregate information about the resources protected by the given Cloud KMS CryptoKey. Only resources within the same Cloud organization as the key will be returned. The project that holds the key must be part of an organization in order for this call to succeed.

Parameters
Name	Description
`name`	`string` Required. The resource name of the CryptoKey.
`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\Kms\Inventory\V1\ProtectedResourcesSummary`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Kms\Inventory\V1\Client\KeyTrackingServiceClient;
use Google\Cloud\Kms\Inventory\V1\GetProtectedResourcesSummaryRequest;
use Google\Cloud\Kms\Inventory\V1\ProtectedResourcesSummary;

/**
 * @param string $formattedName The resource name of the
 *                              [CryptoKey][google.cloud.kms.v1.CryptoKey]. Please see
 *                              {@see KeyTrackingServiceClient::protectedResourcesSummaryName()} for help formatting this field.
 */
function get_protected_resources_summary_sample(string $formattedName): void
{
    // Create a client.
    $keyTrackingServiceClient = new KeyTrackingServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ProtectedResourcesSummary $response */
        $response = $keyTrackingServiceClient->getProtectedResourcesSummary($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 = KeyTrackingServiceClient::protectedResourcesSummaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[KEY_RING]',
        '[CRYPTO_KEY]'
    );

    get_protected_resources_summary_sample($formattedName);
}

searchProtectedResources

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Parameters
Name	Description
`scope`	`string` Required. Resource name of the organization. Example: organizations/123
`cryptoKey`	`string` Required. The resource name of the CryptoKey.
`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\Kms\Inventory\V1\Client\KeyTrackingServiceClient;
use Google\Cloud\Kms\Inventory\V1\ProtectedResource;
use Google\Cloud\Kms\Inventory\V1\SearchProtectedResourcesRequest;

/**
 * @param string $formattedScope Resource name of the organization.
 *                               Example: organizations/123
 *                               Please see {@see KeyTrackingServiceClient::organizationName()} for help formatting this field.
 * @param string $cryptoKey      The resource name of the
 *                               [CryptoKey][google.cloud.kms.v1.CryptoKey].
 */
function search_protected_resources_sample(string $formattedScope, string $cryptoKey): void
{
    // Create a client.
    $keyTrackingServiceClient = new KeyTrackingServiceClient();

    // Prepare the request message.
    $request = (new SearchProtectedResourcesRequest())
        ->setScope($formattedScope)
        ->setCryptoKey($cryptoKey);

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

        /** @var ProtectedResource $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
{
    $formattedScope = KeyTrackingServiceClient::organizationName('[ORGANIZATION]');
    $cryptoKey = '[CRYPTO_KEY]';

    search_protected_resources_sample($formattedScope, $cryptoKey);
}

static::organizationName

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

Parameter
Name	Description
`organization`	`string`

Returns
Type	Description
`string`	The formatted organization resource.

static::projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`
`cryptoKeyVersion`	`string`

Returns
Type	Description
`string`	The formatted project_location_key_ring_crypto_key_crypto_key_version_protectedResourcesSummary resource.

static::projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`

Returns
Type	Description
`string`	The formatted project_location_key_ring_crypto_key_protectedResourcesSummary resource.

static::protectedResourcesSummaryName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`

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

organization: organizations/{organization}
projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummary: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}/protectedResourcesSummary
projectLocationKeyRingCryptoKeyProtectedResourcesSummary: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/protectedResourcesSummary
protectedResourcesSummary: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/protectedResourcesSummary

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.kms.inventory.v1.KeyTrackingService'

The name of the service.

SERVICE_ADDRESS

Value: 'kmsinventory.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.