Google Cloud Api Keys V2 Client - Class ApiKeysClient (0.3.3)

Reference documentation and code samples for the Google Cloud Api Keys V2 Client class ApiKeysClient.

Service Description: Manages the API keys associated with projects.

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:

$apiKeysClient = new ApiKeysClient();
try {
    $formattedParent = $apiKeysClient->locationName('[PROJECT]', '[LOCATION]');
    $key = new Key();
    $operationResponse = $apiKeysClient->createKey($formattedParent, $key);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $apiKeysClient->createKey($formattedParent, $key);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $apiKeysClient->resumeOperation($operationName, 'createKey');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $apiKeysClient->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\ApiKeys\V2\Client\ApiKeysClient to use the new surface.

Namespace

Google \ Cloud \ ApiKeys \ V2

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.

createKey

Creates a new API key.

NOTE: Key is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`parent`	`string` Required. The project in which the API key is created.
`key`	`Google\Cloud\ApiKeys\V2\Key` Required. The API key fields to set at creation time. You can configure only the `display_name`, `restrictions`, and `annotations` fields.
`optionalArgs`	`array` Optional.
`↳ keyId`	`string` User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\CreateKeyRequest;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The project in which the API key is created. Please see
 *                                {@see ApiKeysClient::locationName()} for help formatting this field.
 */
function create_key_sample(string $formattedParent): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

    // Prepare the request message.
    $key = new Key();
    $request = (new CreateKeyRequest())
        ->setParent($formattedParent)
        ->setKey($key);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $apiKeysClient->createKey($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Key $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 = ApiKeysClient::locationName('[PROJECT]', '[LOCATION]');

    create_key_sample($formattedParent);
}

deleteKey

Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project.

NOTE: Key is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`name`	`string` Required. The resource name of the API key to be deleted.
`optionalArgs`	`array` Optional.
`↳ etag`	`string` Optional. The etag known to the client for the expected state of the key. This is to be used for optimistic concurrency.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\DeleteKeyRequest;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the API key to be deleted. Please see
 *                              {@see ApiKeysClient::keyName()} for help formatting this field.
 */
function delete_key_sample(string $formattedName): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $apiKeysClient->deleteKey($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Key $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 = ApiKeysClient::keyName('[PROJECT]', '[LOCATION]', '[KEY]');

    delete_key_sample($formattedName);
}

getKey

Gets the metadata for an API key. The key string of the API key isn't included in the response.

NOTE: Key is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`name`	`string` Required. The resource name of the API key to get.
`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\ApiKeys\V2\Key`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\GetKeyRequest;
use Google\Cloud\ApiKeys\V2\Key;

/**
 * @param string $formattedName The resource name of the API key to get. Please see
 *                              {@see ApiKeysClient::keyName()} for help formatting this field.
 */
function get_key_sample(string $formattedName): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Key $response */
        $response = $apiKeysClient->getKey($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 = ApiKeysClient::keyName('[PROJECT]', '[LOCATION]', '[KEY]');

    get_key_sample($formattedName);
}

getKeyString

Get the key string for an API key.

NOTE: Key is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`name`	`string` Required. The resource name of the API key to be retrieved.
`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\ApiKeys\V2\GetKeyStringResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\GetKeyStringRequest;
use Google\Cloud\ApiKeys\V2\GetKeyStringResponse;

/**
 * @param string $formattedName The resource name of the API key to be retrieved. Please see
 *                              {@see ApiKeysClient::keyName()} for help formatting this field.
 */
function get_key_string_sample(string $formattedName): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var GetKeyStringResponse $response */
        $response = $apiKeysClient->getKeyString($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 = ApiKeysClient::keyName('[PROJECT]', '[LOCATION]', '[KEY]');

    get_key_string_sample($formattedName);
}

listKeys

Lists the API keys owned by a project. The key string of the API key isn't included in the response.

NOTE: Key is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`parent`	`string` Required. Lists all API keys associated with this project.
`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.
`↳ showDeleted`	`bool` Optional. Indicate that keys deleted in the past 30 days should also be returned.
`↳ 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\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Cloud\ApiKeys\V2\ListKeysRequest;

/**
 * @param string $formattedParent Lists all API keys associated with this project. Please see
 *                                {@see ApiKeysClient::locationName()} for help formatting this field.
 */
function list_keys_sample(string $formattedParent): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

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

        /** @var Key $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 = ApiKeysClient::locationName('[PROJECT]', '[LOCATION]');

    list_keys_sample($formattedParent);
}

lookupKey

Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set.

The service account must have the apikeys.keys.lookup permission on the parent project.

Parameters
Name	Description
`keyString`	`string` Required. Finds the project that owns the key string value.
`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\ApiKeys\V2\LookupKeyResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\LookupKeyRequest;
use Google\Cloud\ApiKeys\V2\LookupKeyResponse;

/**
 * @param string $keyString Finds the project that owns the key string value.
 */
function lookup_key_sample(string $keyString): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

    // Prepare the request message.
    $request = (new LookupKeyRequest())
        ->setKeyString($keyString);

    // Call the API and handle any network failures.
    try {
        /** @var LookupKeyResponse $response */
        $response = $apiKeysClient->lookupKey($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
{
    $keyString = '[KEY_STRING]';

    lookup_key_sample($keyString);
}

undeleteKey

Undeletes an API key which was deleted within 30 days.

NOTE: Key is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`name`	`string` Required. The resource name of the API key to be undeleted.
`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Cloud\ApiKeys\V2\UndeleteKeyRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the API key to be undeleted. Please see
 *                              {@see ApiKeysClient::keyName()} for help formatting this field.
 */
function undelete_key_sample(string $formattedName): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $apiKeysClient->undeleteKey($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Key $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 = ApiKeysClient::keyName('[PROJECT]', '[LOCATION]', '[KEY]');

    undelete_key_sample($formattedName);
}

updateKey

Patches the modifiable fields of an API key.

The key string of the API key isn't included in the response.

NOTE: Key is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`key`	`Google\Cloud\ApiKeys\V2\Key` Required. Set the `name` field to the resource name of the API key to be updated. You can update only the `display_name`, `restrictions`, and `annotations` fields.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: `display_name`, `restrictions`, and `annotations`. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Cloud\ApiKeys\V2\UpdateKeyRequest;
use Google\Rpc\Status;

/**
 * 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_key_sample(): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

    // Prepare the request message.
    $key = new Key();
    $request = (new UpdateKeyRequest())
        ->setKey($key);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $apiKeysClient->updateKey($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Key $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());
    }
}

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\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::keyName

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

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

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

key: projects/{project}/locations/{location}/keys/{key}
location: projects/{project}/locations/{location}

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.api.apikeys.v2.ApiKeys'

The name of the service.

SERVICE_ADDRESS

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