Retail V2 API - Class Google::Cloud::Retail::V2::DeleteProductRequest (v0.16.1)

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

Request message for ProductService.DeleteProduct method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.