Documentation

Google_Service_RecommendationsAI_Resource_ProjectsLocationsCatalogsCatalogItems extends Google_Service_Resource
in package

The "catalogItems" collection of methods.

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

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_GoogleCloudRecommendationengineV1beta1CatalogItem
Creates a catalog item. (catalogItems.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_RecommendationsAI_GoogleProtobufEmpty
Deletes a catalog item. (catalogItems.delete)
get()  : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1CatalogItem
Gets a specific catalog item. (catalogItems.get)
import()  : Google_Service_RecommendationsAI_GoogleLongrunningOperation
Bulk import of multiple catalog items. Request processing may be synchronous.
listProjectsLocationsCatalogsCatalogItems()  : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse
Gets a list of catalog items.
patch()  : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1CatalogItem
Updates a catalog item. Partial updating is supported. Non-existing items will be created. (catalogItems.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 —

create()

Creates a catalog item. (catalogItems.create)

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

Required. The parent catalog resource name, such as "projects/locations/global/catalogs/default_catalog".

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

Optional parameters.

Return values
Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1CatalogItem —

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()

Deletes a catalog item. (catalogItems.delete)

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

Required. Full resource name of catalog item, such as "pr ojects/locations/global/catalogs/default_catalog/catalogItems/some_catalog_it em_id".

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

Optional parameters.

Return values
Google_Service_RecommendationsAI_GoogleProtobufEmpty —

get()

Gets a specific catalog item. (catalogItems.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1CatalogItem
Parameters
$name : string

Required. Full resource name of catalog item, such as "pr ojects/locations/global/catalogs/default_catalog/catalogitems/some_catalog_it em_id".

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

Optional parameters.

Return values
Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1CatalogItem —

import()

Bulk import of multiple catalog items. Request processing may be synchronous.

public import(string $parent, Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RecommendationsAI_GoogleLongrunningOperation

No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated. (catalogItems.import)

Parameters
$parent : string

Required. "projects/1234/locations/global/catalogs/default_catalog" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission.

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

Optional parameters.

Return values
Google_Service_RecommendationsAI_GoogleLongrunningOperation —

listProjectsLocationsCatalogsCatalogItems()

Gets a list of catalog items.

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

(catalogItems.listProjectsLocationsCatalogsCatalogItems)

Parameters
$parent : string

Required. The parent catalog resource name, such as "projects/locations/global/catalogs/default_catalog".

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

Optional parameters.

Tags
opt_param

string pageToken Optional. The previous ListCatalogItemsResponse.next_page_token.

opt_param

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

opt_param

string filter Optional. A filter to apply on the list results.

Return values
Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse —

patch()

Updates a catalog item. Partial updating is supported. Non-existing items will be created. (catalogItems.patch)

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

Required. Full resource name of catalog item, such as "pr ojects/locations/global/catalogs/default_catalog/catalogItems/some_catalog_it em_id".

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

Optional parameters.

Tags
opt_param

string updateMask Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.

Return values
Google_Service_RecommendationsAI_GoogleCloudRecommendationengineV1beta1CatalogItem —

convertToArrayAndStripNulls()

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

Search results