public interface PurgeProductsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract String 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"
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
String | The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()
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"
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
ByteString | The bytes for filter. |
getForce()
public abstract boolean getForce()
Actually perform the purge.
If force
is set to false, the method will return the expected purge count
without deleting any products.
bool force = 3;
Type | Description |
boolean | The force. |
getParent()
public abstract String 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}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
String | The parent. |
getParentBytes()
public abstract ByteString getParentBytes()
Required. The resource name of the branch under which the products are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
ByteString | The bytes for parent. |