Retail v2 API - Class PurgeProductsRequest (2.11.0) 

public sealed class PurgeProductsRequest : IMessage<PurgeProductsRequest>, IEquatable<PurgeProductsRequest>, IDeepCloneable<PurgeProductsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class PurgeProductsRequest.

Request message for PurgeProducts method.

Inheritance

object > PurgeProductsRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

PurgeProductsRequest()

public PurgeProductsRequest()

PurgeProductsRequest(PurgeProductsRequest)

public PurgeProductsRequest(PurgeProductsRequest other)
Parameter
Name Description
other PurgeProductsRequest

Properties

Filter

public string Filter { get; set; }

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][google.cloud.retail.v2.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"
Property Value
Type Description
string

Force

public bool Force { get; set; }

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

Property Value
Type Description
bool

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsBranchName

public BranchName ParentAsBranchName { get; set; }

BranchName-typed view over the Parent resource name property.

Property Value
Type Description
BranchName