1. class
  2. Google
  3. \
  4. Service
  5. \
  6. RecommendationsAI
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations

ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations

class ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations extends Resource (View source)

The "predictionApiKeyRegistrations" collection of methods.

Typical usage is:

 $recommendationengineService = new Google\Service\RecommendationsAI(...);
 $predictionApiKeyRegistrations = $recommendationengineService->projects_locations_catalogs_eventStores_predictionApiKeyRegistrations;

Methods

GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration
create(string $parent, GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest $postBody, array $optParams = [])

Register an API key for use with predict method.

GoogleProtobufEmpty
delete(string $name, array $optParams = [])

Unregister an apiKey from using for predict method.

GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse
listProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations(string $parent, array $optParams = [])

List the registered apiKeys for use with predict method. (predictionApiKeyReg istrations.listProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrati ons)

Details

at line 46
GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration create(string $parent, GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest $postBody, array $optParams = [])

Register an API key for use with predict method.

(predictionApiKeyRegistrations.create)

Parameters

string $parent

Required. The parent resource path. projects/locations /global/catalogs/default_catalog/eventStores/default_event_store.
GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration

Exceptions

Exception

at line 63
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Unregister an apiKey from using for predict method.

(predictionApiKeyRegistrations.delete)

Parameters

string $name

Required. The API key to unregister including full resource path. projects/locations/global/catalogs/default_catalog/eventStore s/default_event_store/predictionApiKeyRegistrations/
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 86
GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse listProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations(string $parent, array $optParams = [])

List the registered apiKeys for use with predict method. (predictionApiKeyReg istrations.listProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrati ons)

Parameters

string $parent

Required. The parent placement resource name such as p rojects/1234/locations/global/catalogs/default_catalog/eventStores/default_ev ent_store
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse

Exceptions

Exception