Send feedback
Class PurgeProductsRequest (2.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.10.0 keyboard_arrow_down
public final class PurgeProductsRequest extends GeneratedMessageV3 implements PurgeProductsRequestOrBuilder
Request message for PurgeProducts method.
Protobuf type google.cloud.retail.v2alpha.PurgeProductsRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
FORCE_FIELD_NUMBER
public static final int FORCE_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PurgeProductsRequest getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static PurgeProductsRequest . Builder newBuilder ()
Returns
newBuilder(PurgeProductsRequest prototype)
public static PurgeProductsRequest . Builder newBuilder ( PurgeProductsRequest prototype )
Parameter
Returns
public static PurgeProductsRequest parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static PurgeProductsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PurgeProductsRequest parseFrom ( byte [] data )
Parameter
Name Description data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PurgeProductsRequest parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static PurgeProductsRequest parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static PurgeProductsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static PurgeProductsRequest parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static PurgeProductsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PurgeProductsRequest parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<PurgeProductsRequest> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public PurgeProductsRequest getDefaultInstanceForType ()
Returns
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
getParserForType()
public Parser<PurgeProductsRequest> getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public PurgeProductsRequest . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PurgeProductsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public PurgeProductsRequest . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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."],[],[]]
