Google Cloud Recommendation Engine V1beta1 Client - Class PredictionApiKeyRegistryClient (0.7.5)

Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class PredictionApiKeyRegistryClient.

Service Description: Service for registering API keys for use with the predict method. If you use an API key to request predictions, you must first register the API key.

Otherwise, your prediction request is rejected. If you use OAuth to authenticate your predict method call, you do not need to register an API key. You can register up to 20 API keys per project.

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:

$predictionApiKeyRegistryClient = new PredictionApiKeyRegistryClient();
try {
    $formattedParent = $predictionApiKeyRegistryClient->eventStoreName('[PROJECT]', '[LOCATION]', '[CATALOG]', '[EVENT_STORE]');
    $predictionApiKeyRegistration = new PredictionApiKeyRegistration();
    $response = $predictionApiKeyRegistryClient->createPredictionApiKeyRegistration($formattedParent, $predictionApiKeyRegistration);
} finally {
    $predictionApiKeyRegistryClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ RecommendationEngine \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createPredictionApiKeyRegistration

Register an API key for use with predict method.

Parameters
Name Description
parent string

Required. The parent resource path. projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store.
predictionApiKeyRegistration Google\Cloud\RecommendationEngine\V1beta1\PredictionApiKeyRegistration

Required. The prediction API key registration.
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\RecommendationEngine\V1beta1\PredictionApiKeyRegistration
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecommendationEngine\V1beta1\Client\PredictionApiKeyRegistryClient;
use Google\Cloud\RecommendationEngine\V1beta1\CreatePredictionApiKeyRegistrationRequest;
use Google\Cloud\RecommendationEngine\V1beta1\PredictionApiKeyRegistration;

/**
 * @param string $formattedParent The parent resource path.
 *                                `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`. Please see
 *                                {@see PredictionApiKeyRegistryClient::eventStoreName()} for help formatting this field.
 */
function create_prediction_api_key_registration_sample(string $formattedParent): void
{
    // Create a client.
    $predictionApiKeyRegistryClient = new PredictionApiKeyRegistryClient();

    // Prepare the request message.
    $predictionApiKeyRegistration = new PredictionApiKeyRegistration();
    $request = (new CreatePredictionApiKeyRegistrationRequest())
        ->setParent($formattedParent)
        ->setPredictionApiKeyRegistration($predictionApiKeyRegistration);

    // Call the API and handle any network failures.
    try {
        /** @var PredictionApiKeyRegistration $response */
        $response = $predictionApiKeyRegistryClient->createPredictionApiKeyRegistration($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 = PredictionApiKeyRegistryClient::eventStoreName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[EVENT_STORE]'
    );

    create_prediction_api_key_registration_sample($formattedParent);
}

deletePredictionApiKeyRegistration

Unregister an apiKey from using for predict method.

Parameters
Name Description
name string

Required. The API key to unregister including full resource path. projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>
optionalArgs array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecommendationEngine\V1beta1\Client\PredictionApiKeyRegistryClient;
use Google\Cloud\RecommendationEngine\V1beta1\DeletePredictionApiKeyRegistrationRequest;

/**
 * @param string $formattedName The API key to unregister including full resource path.
 *                              `projects/&#42;/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>`
 *                              Please see {@see PredictionApiKeyRegistryClient::predictionApiKeyRegistrationName()} for help formatting this field.
 */
function delete_prediction_api_key_registration_sample(string $formattedName): void
{
    // Create a client.
    $predictionApiKeyRegistryClient = new PredictionApiKeyRegistryClient();

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

    // Call the API and handle any network failures.
    try {
        $predictionApiKeyRegistryClient->deletePredictionApiKeyRegistration($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 = PredictionApiKeyRegistryClient::predictionApiKeyRegistrationName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[EVENT_STORE]',
        '[PREDICTION_API_KEY_REGISTRATION]'
    );

    delete_prediction_api_key_registration_sample($formattedName);
}

listPredictionApiKeyRegistrations

List the registered apiKeys for use with predict method.

Parameters
Name Description
parent string

Required. The parent placement resource name such as projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store
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\RecommendationEngine\V1beta1\Client\PredictionApiKeyRegistryClient;
use Google\Cloud\RecommendationEngine\V1beta1\ListPredictionApiKeyRegistrationsRequest;
use Google\Cloud\RecommendationEngine\V1beta1\PredictionApiKeyRegistration;

/**
 * @param string $formattedParent The parent placement resource name such as
 *                                `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
 *                                Please see {@see PredictionApiKeyRegistryClient::eventStoreName()} for help formatting this field.
 */
function list_prediction_api_key_registrations_sample(string $formattedParent): void
{
    // Create a client.
    $predictionApiKeyRegistryClient = new PredictionApiKeyRegistryClient();

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

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

        /** @var PredictionApiKeyRegistration $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 = PredictionApiKeyRegistryClient::eventStoreName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[EVENT_STORE]'
    );

    list_prediction_api_key_registrations_sample($formattedParent);
}

static::eventStoreName

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

Parameters
Name Description
project string
location string
catalog string
eventStore string
Returns
Type Description
string The formatted event_store resource.

static::predictionApiKeyRegistrationName

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

Parameters
Name Description
project string
location string
catalog string
eventStore string
predictionApiKeyRegistration string
Returns
Type Description
string The formatted prediction_api_key_registration 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

  • eventStore: projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}
  • predictionApiKeyRegistration: projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}

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.recommendationengine.v1beta1.PredictionApiKeyRegistry'

The name of the service.

SERVICE_ADDRESS

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