Google Cloud Recommendation Engine V1beta1 Client - Class UpdateCatalogItemRequest (0.7.5)

Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class UpdateCatalogItemRequest.

Request message for UpdateCatalogItem method.

Generated from protobuf message google.cloud.recommendationengine.v1beta1.UpdateCatalogItemRequest

Namespace

Google \ Cloud \ RecommendationEngine \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id.

↳ catalog_item Google\Cloud\RecommendationEngine\V1beta1\CatalogItem

Required. The catalog item to update/create. The 'catalog_item_id' field has to match that in the 'name'.

↳ update_mask Google\Protobuf\FieldMask

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

getName

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id.

Returns
Type Description
string

setName

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id.

Parameter
Name Description
var string
Returns
Type Description
$this

getCatalogItem

Required. The catalog item to update/create. The 'catalog_item_id' field has to match that in the 'name'.

Returns
Type Description
Google\Cloud\RecommendationEngine\V1beta1\CatalogItem|null

hasCatalogItem

clearCatalogItem

setCatalogItem

Required. The catalog item to update/create. The 'catalog_item_id' field has to match that in the 'name'.

Parameter
Name Description
var Google\Cloud\RecommendationEngine\V1beta1\CatalogItem
Returns
Type Description
$this

getUpdateMask

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

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id. Please see Google\Cloud\RecommendationEngine\V1beta1\CatalogServiceClient::catalogItemPathName() for help formatting this field.

catalogItem Google\Cloud\RecommendationEngine\V1beta1\CatalogItem

Required. The catalog item to update/create. The 'catalog_item_id' field has to match that in the 'name'.

updateMask Google\Protobuf\FieldMask

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

Returns
Type Description
Google\Cloud\RecommendationEngine\V1beta1\UpdateCatalogItemRequest