Documentation

Google_Service_RecommendationsAI_Resource_ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations extends Google_Service_Resource
in package

The "predictionApiKeyRegistrations" collection of methods.

Typical usage is: $recommendationengineService = new Google_Service_RecommendationsAI(...); $predictionApiKeyRegistrations = $recommendationengineService->predictionApiKeyRegistrations;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration
Register an API key for use with predict method.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_RecommendationsAI_GoogleProtobufEmpty
Unregister an apiKey from using for predict method.
listProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations()  : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse
List the registered apiKeys for use with predict method. (predictionApiKeyReg istrations.listProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrati ons)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Register an API key for use with predict method.

public create(string $parent, Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration

(predictionApiKeyRegistrations.create)

Parameters
$parent : string

Required. The parent resource path. "projects/locations /global/catalogs/default_catalog/eventStores/default_event_store".

$postBody : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Unregister an apiKey from using for predict method.

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RecommendationsAI_GoogleProtobufEmpty

(predictionApiKeyRegistrations.delete)

Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_RecommendationsAI_GoogleProtobufEmpty —

listProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations()

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

public listProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrations(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse
Parameters
$parent : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.

opt_param

string pageToken Optional. The previous ListPredictionApiKeyRegistration.nextPageToken.

Return values
Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results