Package com.google.cloud.retail.v2alpha

Interface DeleteProductRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DeleteProductRequest, DeleteProductRequest.Builder
    public interface DeleteProductRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getForce()
      This value only applies to the case when the target product is of type PRIMARY.
      String getName()
      Required.
      com.google.protobuf.ByteString getNameBytes()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getName

        String getName()
         Required. Full resource name of
 [Product][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Product], regardless of whether or
 not it exists, a PERMISSION_DENIED error is returned.

 If the [Product][google.cloud.retail.v2alpha.Product] to delete does not
 exist, a NOT_FOUND error is returned.

 The [Product][google.cloud.retail.v2alpha.Product] to delete can neither be
 a
 [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2alpha.Product] member nor a
 [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2alpha.Product] with more than one
 [variants][google.cloud.retail.v2alpha.Product.Type.VARIANT]. Otherwise, an
 INVALID_ARGUMENT error is returned.

 All inventory information for the named
 [Product][google.cloud.retail.v2alpha.Product] will be deleted.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Required. Full resource name of
 [Product][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Product], regardless of whether or
 not it exists, a PERMISSION_DENIED error is returned.

 If the [Product][google.cloud.retail.v2alpha.Product] to delete does not
 exist, a NOT_FOUND error is returned.

 The [Product][google.cloud.retail.v2alpha.Product] to delete can neither be
 a
 [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]
 [Product][google.cloud.retail.v2alpha.Product] member nor a
 [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
 [Product][google.cloud.retail.v2alpha.Product] with more than one
 [variants][google.cloud.retail.v2alpha.Product.Type.VARIANT]. Otherwise, an
 INVALID_ARGUMENT error is returned.

 All inventory information for the named
 [Product][google.cloud.retail.v2alpha.Product] will be deleted.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for name.

      • getForce

        boolean getForce()
         This value only applies to the case when the target product is of type
 PRIMARY.
 When deleting a product of VARIANT/COLLECTION type, this value
 will be ignored.
 When set to true, the subsequent variant products will be
 deleted.
 When set to false, if the primary product has active variant products, an
 error will be returned.
        bool force = 4;
        Returns:
        The force.