Google Cloud Retail V2 Client - Class PurgeProductsRequest (2.5.1)

Version latest

• 2.5.1 (latest)
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.1
• 2.1.3
• 2.0.0
• 1.7.0
• 1.6.4
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.1

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

Request message for PurgeProducts method.

Generated from protobuf message google.cloud.retail.v2.PurgeProductsRequest

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	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}
↳ filter	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: * * availability: Double quoted Product.availability string. * * create_time : in ISO 8601 "zulu" format. 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	bool Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any products.

getParent

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
Type	Description
string

setParent

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

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:

• availability: Double quoted Product.availability string.
• create_time : in ISO 8601 "zulu" format. 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
Type	Description
string

setFilter

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:

• availability: Double quoted Product.availability string.
• create_time : in ISO 8601 "zulu" format. 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"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getForce

Actually perform the purge.

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

Returns
Type	Description
bool

setForce

Actually perform the purge.

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this