Reference documentation and code samples for the Cloud Vision V1 API class Google::Cloud::Vision::V1::PurgeProductsRequest.
Request message for the PurgeProducts method.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#delete_orphan_products
defdelete_orphan_products()->::Boolean
Returns
(::Boolean) — If delete_orphan_products is true, all Products that are not in any
ProductSet will be deleted.
Note: The following fields are mutually exclusive: delete_orphan_products, product_set_purge_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
#delete_orphan_products=
defdelete_orphan_products=(value)->::Boolean
Parameter
value (::Boolean) — If delete_orphan_products is true, all Products that are not in any
ProductSet will be deleted.
Note: The following fields are mutually exclusive: delete_orphan_products, product_set_purge_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::Boolean) — If delete_orphan_products is true, all Products that are not in any
ProductSet will be deleted.
Note: The following fields are mutually exclusive: delete_orphan_products, product_set_purge_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
#force
defforce()->::Boolean
Returns
(::Boolean) — The default value is false. Override this value to true to actually perform
the purge.
#force=
defforce=(value)->::Boolean
Parameter
value (::Boolean) — The default value is false. Override this value to true to actually perform
the purge.
Returns
(::Boolean) — The default value is false. Override this value to true to actually perform
the purge.
#parent
defparent()->::String
Returns
(::String) — Required. The project and location in which the Products should be deleted.
Format is projects/PROJECT_ID/locations/LOC_ID.
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The project and location in which the Products should be deleted.
Format is projects/PROJECT_ID/locations/LOC_ID.
Returns
(::String) — Required. The project and location in which the Products should be deleted.
Note: The following fields are mutually exclusive: product_set_purge_config, delete_orphan_products. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: product_set_purge_config, delete_orphan_products. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: product_set_purge_config, delete_orphan_products. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Vision V1 API - Class Google::Cloud::Vision::V1::PurgeProductsRequest (v1.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.1 (latest)](/ruby/docs/reference/google-cloud-vision-v1/latest/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-vision-v1/1.3.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [1.2.1](/ruby/docs/reference/google-cloud-vision-v1/1.2.1/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision-v1/1.1.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision-v1/1.0.1/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-vision-v1/0.15.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-vision-v1/0.14.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.13.2](/ruby/docs/reference/google-cloud-vision-v1/0.13.2/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-vision-v1/0.12.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.11.1](/ruby/docs/reference/google-cloud-vision-v1/0.11.1/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-vision-v1/0.10.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-vision-v1/0.9.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-vision-v1/0.8.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-vision-v1/0.7.0/Google-Cloud-Vision-V1-PurgeProductsRequest)\n- [0.6.4](/ruby/docs/reference/google-cloud-vision-v1/0.6.4/Google-Cloud-Vision-V1-PurgeProductsRequest) \nReference documentation and code samples for the Cloud Vision V1 API class Google::Cloud::Vision::V1::PurgeProductsRequest.\n\nRequest message for the `PurgeProducts` method. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #delete_orphan_products\n\n def delete_orphan_products() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.\n\n Note: The following fields are mutually exclusive: `delete_orphan_products`, `product_set_purge_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #delete_orphan_products=\n\n def delete_orphan_products=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.\n\n\nNote: The following fields are mutually exclusive: `delete_orphan_products`, `product_set_purge_config`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::Boolean) --- If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.\n\n Note: The following fields are mutually exclusive: `delete_orphan_products`, `product_set_purge_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #force\n\n def force() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- The default value is false. Override this value to true to actually perform the purge.\n\n### #force=\n\n def force=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- The default value is false. Override this value to true to actually perform the purge. \n**Returns**\n\n- (::Boolean) --- The default value is false. Override this value to true to actually perform the purge.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The project and location in which the Products should be deleted.\n\n Format is `projects/PROJECT_ID/locations/LOC_ID`.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The project and location in which the Products should be deleted.\n\n\nFormat is `projects/PROJECT_ID/locations/LOC_ID`. \n**Returns**\n\n- (::String) --- Required. The project and location in which the Products should be deleted.\n\n Format is `projects/PROJECT_ID/locations/LOC_ID`.\n\n### #product_set_purge_config\n\n def product_set_purge_config() -\u003e ::Google::Cloud::Vision::V1::ProductSetPurgeConfig\n\n**Returns**\n\n- ([::Google::Cloud::Vision::V1::ProductSetPurgeConfig](./Google-Cloud-Vision-V1-ProductSetPurgeConfig)) --- Specify which ProductSet contains the Products to be deleted.\n\n\n Note: The following fields are mutually exclusive: `product_set_purge_config`, `delete_orphan_products`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #product_set_purge_config=\n\n def product_set_purge_config=(value) -\u003e ::Google::Cloud::Vision::V1::ProductSetPurgeConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Vision::V1::ProductSetPurgeConfig](./Google-Cloud-Vision-V1-ProductSetPurgeConfig)) --- Specify which ProductSet contains the Products to be deleted.\n\n\nNote: The following fields are mutually exclusive: `product_set_purge_config`, `delete_orphan_products`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Vision::V1::ProductSetPurgeConfig](./Google-Cloud-Vision-V1-ProductSetPurgeConfig)) --- Specify which ProductSet contains the Products to be deleted.\n\n\n Note: The following fields are mutually exclusive: `product_set_purge_config`, `delete_orphan_products`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]
