Send feedback
Class PurgeProductsRequest.Builder (2.19.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.19.0 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeProductsRequest . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public PurgeProductsRequest build ()
buildPartial()
public PurgeProductsRequest buildPartial ()
clear()
public PurgeProductsRequest . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public PurgeProductsRequest . Builder clearField ( Descriptors . FieldDescriptor field )
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];
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeProductsRequest . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
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) = { ... }
clone()
public PurgeProductsRequest . Builder clone ()
Overrides
getDefaultInstanceForType()
public PurgeProductsRequest getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
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 Type Description ByteString The bytes for filter.
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 Type Description boolean The force.
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 Type Description ByteString The bytes for parent.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(PurgeProductsRequest other)
public PurgeProductsRequest . Builder mergeFrom ( PurgeProductsRequest other )
public PurgeProductsRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public PurgeProductsRequest . Builder mergeFrom ( Message other )
Parameter Name Description otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeProductsRequest . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeProductsRequest . Builder setField ( Descriptors . FieldDescriptor field , Object value )
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 valueString The filter to set.
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 valueByteString The bytes for filter to set.
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 valueboolean The force to set.
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 valueString The parent to set.
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 valueByteString The bytes for parent to set.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeProductsRequest . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeProductsRequest . Builder setUnknownFields ( UnknownFieldSet unknownFields )
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-27 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-27 UTC."],[],[]]
