Google Cloud Retail V2 Client - Class DeleteProductRequest (2.2.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class DeleteProductRequest.

Request message for ProductService.DeleteProduct method.

Generated from protobuf message google.cloud.retail.v2.DeleteProductRequest

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Required. Full resource name of Product , such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id . If the caller does not have permission to delete the Product , regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants . Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.

getName

Required. Full resource name of Product , such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id .

If the caller does not have permission to delete the Product , regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants . Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.

Returns
Type
Description
string

setName

Required. Full resource name of Product , such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id .

If the caller does not have permission to delete the Product , regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants . Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameter
Name
Description
name
string

Required. Full resource name of Product , such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id .

If the caller does not have permission to delete the Product , regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Product to delete does not exist, a NOT_FOUND error is returned.

The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants . Otherwise, an INVALID_ARGUMENT error is returned.

All inventory information for the named Product will be deleted. Please see ProductServiceClient::productName() for help formatting this field.

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: