- 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 static final class PurgeProductsRequest.Builder extends GeneratedMessageV3.Builder<PurgeProductsRequest.Builder> implements PurgeProductsRequestOrBuilder
Request message for PurgeProducts method.
Protobuf type google.cloud.retail.v2alpha.PurgeProductsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PurgeProductsRequest.BuilderImplements
PurgeProductsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
build()
public PurgeProductsRequest build()
Returns | |
---|---|
Type | Description |
PurgeProductsRequest |
buildPartial()
public PurgeProductsRequest buildPartial()
Returns | |
---|---|
Type | Description |
PurgeProductsRequest |
clear()
public PurgeProductsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public PurgeProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
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 | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
This builder for chaining. |
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 | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
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 | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
This builder for chaining. |
clone()
public PurgeProductsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
getDefaultInstanceForType()
public PurgeProductsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
PurgeProductsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(PurgeProductsRequest other)
public PurgeProductsRequest.Builder mergeFrom(PurgeProductsRequest other)
Parameter | |
---|---|
Name | Description |
other |
PurgeProductsRequest |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PurgeProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public PurgeProductsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
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 | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
This builder for chaining. |
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 | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
This builder for chaining. |
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 | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
This builder for chaining. |
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 | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
This builder for chaining. |
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 | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeProductsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
PurgeProductsRequest.Builder |