Send feedback
Class PurgeProductsRequest.Builder (2.2.2)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.2.2 keyboard_arrow_down
public static final class PurgeProductsRequest . Builder extends GeneratedMessageV3 . Builder<PurgeProductsRequest . Builder > implements PurgeProductsRequestOrBuilder
Request message for PurgeProducts method.
Protobuf type google.cloud.retail.v2alpha.PurgeProductsRequest
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeProductsRequest . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
build()
public PurgeProductsRequest build ()
Returns
buildPartial()
public PurgeProductsRequest buildPartial ()
Returns
clear()
public PurgeProductsRequest . Builder clear ()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public PurgeProductsRequest . Builder clearField ( Descriptors . FieldDescriptor field )
Parameter
Returns
Overrides
clearFilter()
public PurgeProductsRequest . Builder clearFilter ()
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];
Returns
clearForce()
public PurgeProductsRequest . Builder clearForce ()
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;
Returns
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeProductsRequest . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Parameter
Returns
Overrides
clearParent()
public PurgeProductsRequest . Builder clearParent ()
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) = { ... }
Returns
clone()
public PurgeProductsRequest . Builder clone ()
Returns
Overrides
getDefaultInstanceForType()
public PurgeProductsRequest getDefaultInstanceForType ()
Returns
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Returns
Overrides
getFilter()
public 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];
Returns
Type Description String The filter.
getFilterBytes()
public 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];
Returns
getForce()
public 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;
Returns
getParent()
public 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) = { ... }
Returns
Type Description String The parent.
getParentBytes()
public 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) = { ... }
Returns
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
mergeFrom(PurgeProductsRequest other)
public PurgeProductsRequest . Builder mergeFrom ( PurgeProductsRequest other )
Parameter
Returns
public PurgeProductsRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public PurgeProductsRequest . Builder mergeFrom ( Message other )
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeProductsRequest . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeProductsRequest . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
setFilter(String value)
public PurgeProductsRequest . Builder setFilter ( String value )
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];
Parameter
Name Description value String The filter to set.
Returns
setFilterBytes(ByteString value)
public PurgeProductsRequest . Builder setFilterBytes ( ByteString value )
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];
Parameter
Name Description value ByteString The bytes for filter to set.
Returns
setForce(boolean value)
public PurgeProductsRequest . Builder setForce ( boolean value )
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;
Parameter
Name Description value boolean The force to set.
Returns
setParent(String value)
public PurgeProductsRequest . Builder setParent ( String value )
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) = { ... }
Parameter
Name Description value String The parent to set.
Returns
setParentBytes(ByteString value)
public PurgeProductsRequest . Builder setParentBytes ( ByteString value )
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) = { ... }
Parameter
Name Description value ByteString The bytes for parent to set.
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeProductsRequest . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeProductsRequest . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-21 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-21 UTC."],[],[]]
