Retail V2 API - Class Google::Cloud::Retail::V2::PurgeProductsRequest (v0.21.0)

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

Request message for PurgeProducts method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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"

#filter=

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

#force

def force() -> ::Boolean
Returns
  • (::Boolean) — Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any products.

#force=

def force=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

#parent

def parent() -> ::String
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}

#parent=

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