- 2.50.0 (latest)
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public final class PurgeProductsRequest extends GeneratedMessageV3 implements PurgeProductsRequestOrBuilder
Request message for PurgeProducts method.
Protobuf type google.cloud.retail.v2alpha.PurgeProductsRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PurgeProductsRequestImplements
PurgeProductsRequestOrBuilderStatic Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Type | Description |
int |
FORCE_FIELD_NUMBER
public static final int FORCE_FIELD_NUMBER
Type | Description |
int |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static PurgeProductsRequest getDefaultInstance()
Type | Description |
PurgeProductsRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static PurgeProductsRequest.Builder newBuilder()
Type | Description |
PurgeProductsRequest.Builder |
newBuilder(PurgeProductsRequest prototype)
public static PurgeProductsRequest.Builder newBuilder(PurgeProductsRequest prototype)
Name | Description |
prototype | PurgeProductsRequest |
Type | Description |
PurgeProductsRequest.Builder |
parseDelimitedFrom(InputStream input)
public static PurgeProductsRequest parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
PurgeProductsRequest |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PurgeProductsRequest |
Type | Description |
IOException |
parseFrom(byte[] data)
public static PurgeProductsRequest parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
PurgeProductsRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PurgeProductsRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static PurgeProductsRequest parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
PurgeProductsRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PurgeProductsRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static PurgeProductsRequest parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
PurgeProductsRequest |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PurgeProductsRequest |
Type | Description |
IOException |
parseFrom(InputStream input)
public static PurgeProductsRequest parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
PurgeProductsRequest |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PurgeProductsRequest |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static PurgeProductsRequest parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
PurgeProductsRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PurgeProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PurgeProductsRequest |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<PurgeProductsRequest> parser()
Type | Description |
Parser<PurgeProductsRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
getDefaultInstanceForType()
public PurgeProductsRequest getDefaultInstanceForType()
Type | Description |
PurgeProductsRequest |
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];
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];
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;
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) = { ... }
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) = { ... }
Type | Description |
ByteString | The bytes for parent. |
getParserForType()
public Parser<PurgeProductsRequest> getParserForType()
Type | Description |
Parser<PurgeProductsRequest> |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public PurgeProductsRequest.Builder newBuilderForType()
Type | Description |
PurgeProductsRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PurgeProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
PurgeProductsRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public PurgeProductsRequest.Builder toBuilder()
Type | Description |
PurgeProductsRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |