Class: Google::Cloud::Retail::V2::PurgeProductsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/purge_config.rb

Overview

Request message for PurgeProducts method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Required. The filter string to specify the products to be deleted with a length limit of 5,000 characters.

Empty string filter is not allowed. "*" implies delete all items in a branch.

The eligible fields for filtering are:

Supported syntax:

  • Comparators (">", "<", ">=", "<=", "="). Examples:

    • create_time <= "2015-02-13T17:05:46Z"
    • availability = "IN_STOCK"

  • Conjunctions ("AND") Examples:

    • create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

  • Disjunctions ("OR") Examples:

    • create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

  • Can support nested queries. Examples:

    • (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

  • Filter Limits:

    • Filter should not contain more than 6 conditions.
    • Max nesting depth should not exceed 2 levels.

Examples queries:

  • Delete back order products created before a timestamp. create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER".

Returns:

  • (::String) —

    Required. The filter string to specify the products to be deleted with a length limit of 5,000 characters.

    Empty string filter is not allowed. "*" implies delete all items in a branch.

    The eligible fields for filtering are:

    Supported syntax:

    • Comparators (">", "<", ">=", "<=", "="). Examples:

      • create_time <= "2015-02-13T17:05:46Z"
      • availability = "IN_STOCK"

    • Conjunctions ("AND") Examples:

      • create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER"

    • Disjunctions ("OR") Examples:

      • create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK"

    • Can support nested queries. Examples:

      • (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK")

    • Filter Limits:

      • Filter should not contain more than 6 conditions.
      • Max nesting depth should not exceed 2 levels.

    Examples queries:

    • Delete back order products created before a timestamp. create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"


103
104
105
106
 
# File 'proto_docs/google/cloud/retail/v2/purge_config.rb', line 103

class PurgeProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#force ⇒ ::Boolean

Returns Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any products.

Returns:

  • (::Boolean) —

    Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any products.



103
104
105
106
 
# File 'proto_docs/google/cloud/retail/v2/purge_config.rb', line 103

class PurgeProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The resource name of the branch under which the products are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}.

Returns:

  • (::String) —

    Required. The resource name of the branch under which the products are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}



103
104
105
106
 
# File 'proto_docs/google/cloud/retail/v2/purge_config.rb', line 103

class PurgeProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end