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 |
|---|
| Type | Description |
int | |
FORCE_FIELD_NUMBER
public static final int FORCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PurgeProductsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PurgeProductsRequest.Builder newBuilder()
newBuilder(PurgeProductsRequest prototype)
public static PurgeProductsRequest.Builder newBuilder(PurgeProductsRequest prototype)
public static PurgeProductsRequest parseDelimitedFrom(InputStream input)
public static PurgeProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PurgeProductsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PurgeProductsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(CodedInputStream input)
public static PurgeProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(InputStream input)
public static PurgeProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PurgeProductsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PurgeProductsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public PurgeProductsRequest getDefaultInstanceForType()
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.
|
getParserForType()
public Parser<PurgeProductsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PurgeProductsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PurgeProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PurgeProductsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
