Documentation

Google_Service_RecommendationsAI_Resource_ProjectsLocationsCatalogs extends Google_Service_Resource
in package

The "catalogs" collection of methods.

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

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listProjectsLocationsCatalogs()  : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ListCatalogsResponse
Lists all the catalog configurations associated with the project.
patch()  : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1Catalog
Updates the catalog configuration. (catalogs.patch)
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 —

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

listProjectsLocationsCatalogs()

Lists all the catalog configurations associated with the project.

public listProjectsLocationsCatalogs(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ListCatalogsResponse

(catalogs.listProjectsLocationsCatalogs)

Parameters
$parent : string

Required. The account resource name with an associated location.

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

Optional parameters.

Tags
opt_param

string pageToken Optional. A page token, received from a previous ListCatalogs call. Provide this to retrieve the subsequent page.

opt_param

int pageSize Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

Return values
Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ListCatalogsResponse —

patch()

Updates the catalog configuration. (catalogs.patch)

public patch(string $name, Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1Catalog $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1Catalog
Parameters
$name : string

The fully qualified resource name of the catalog.

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

Optional parameters.

Tags
opt_param

string updateMask Optional. Indicates which fields in the provided 'catalog' to update. If not set, will only update the catalog_item_level_config field. Currently only fields that can be updated are catalog_item_level_config.

Return values
Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1Catalog —

convertToArrayAndStripNulls()

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

Search results