Cloud Vision V1 API - Class Google::Cloud::Vision::V1::PurgeProductsRequest (v1.5.0)

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

def delete_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=

def delete_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

def force() -> ::Boolean
Returns
  • (::Boolean) — The default value is false. Override this value to true to actually perform the purge.

#force=

def force=(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

def parent() -> ::String
Returns
  • (::String) — Required. The project and location in which the Products should be deleted.

    Format is projects/PROJECT_ID/locations/LOC_ID.

#parent=

def parent=(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.

    Format is projects/PROJECT_ID/locations/LOC_ID.

#product_set_purge_config

def product_set_purge_config() -> ::Google::Cloud::Vision::V1::ProductSetPurgeConfig
Returns
  • (::Google::Cloud::Vision::V1::ProductSetPurgeConfig) — Specify which ProductSet contains the Products to 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.

#product_set_purge_config=

def product_set_purge_config=(value) -> ::Google::Cloud::Vision::V1::ProductSetPurgeConfig
Parameter
  • value (::Google::Cloud::Vision::V1::ProductSetPurgeConfig) — Specify which ProductSet contains the Products to 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.

Returns
  • (::Google::Cloud::Vision::V1::ProductSetPurgeConfig) — Specify which ProductSet contains the Products to 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.