prediction_api_key_registrations

Creates, updates, deletes, gets or lists a prediction_api_key_registrations resource.

Overview

Name	prediction_api_key_registrations
Type	Resource
Id	google.recommendationengine.prediction_api_key_registrations

Fields

The following fields are returned by SELECT queries:

projects_locations_catalogs_event_stores_prediction_api_key_registrations_list

Successful response

Name	Datatype	Description
apiKey	string	The API key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_catalogs_event_stores_prediction_api_key_registrations_list	select	projectsId, locationsId, catalogsId, eventStoresId	pageSize, pageToken	List the registered apiKeys for use with predict method.
projects_locations_catalogs_event_stores_prediction_api_key_registrations_create	insert	projectsId, locationsId, catalogsId, eventStoresId		Register an API key for use with predict method.
projects_locations_catalogs_event_stores_prediction_api_key_registrations_delete	delete	projectsId, locationsId, catalogsId, eventStoresId, predictionApiKeyRegistrationsId		Unregister an apiKey from using for predict method.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
catalogsId	string
eventStoresId	string
locationsId	string
predictionApiKeyRegistrationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_catalogs_event_stores_prediction_api_key_registrations_list

List the registered apiKeys for use with predict method.

SELECT
apiKey
FROM google.recommendationengine.prediction_api_key_registrations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND catalogsId = '{{ catalogsId }}' -- required
AND eventStoresId = '{{ eventStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_catalogs_event_stores_prediction_api_key_registrations_create

Register an API key for use with predict method.

INSERT INTO google.recommendationengine.prediction_api_key_registrations (
data__predictionApiKeyRegistration,
projectsId,
locationsId,
catalogsId,
eventStoresId
)
SELECT 
'{{ predictionApiKeyRegistration }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ catalogsId }}',
'{{ eventStoresId }}'
RETURNING
apiKey
;

Manifest

# Description fields are for documentation purposes
- name: prediction_api_key_registrations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the prediction_api_key_registrations resource.
    - name: locationsId
      value: string
      description: Required parameter for the prediction_api_key_registrations resource.
    - name: catalogsId
      value: string
      description: Required parameter for the prediction_api_key_registrations resource.
    - name: eventStoresId
      value: string
      description: Required parameter for the prediction_api_key_registrations resource.
    - name: predictionApiKeyRegistration
      value: object
      description: >
        Required. The prediction API key registration.
        

DELETE examples

projects_locations_catalogs_event_stores_prediction_api_key_registrations_delete

Unregister an apiKey from using for predict method.

DELETE FROM google.recommendationengine.prediction_api_key_registrations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND catalogsId = '{{ catalogsId }}' --required
AND eventStoresId = '{{ eventStoresId }}' --required
AND predictionApiKeyRegistrationsId = '{{ predictionApiKeyRegistrationsId }}' --required;