public static final class PurgeProductsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder> implements PurgeProductsRequestOrBuilder
Request message for PurgeProducts method.Protobuf type
google.cloud.retail.v2alpha.PurgeProductsRequest| Modifier and Type | Method and Description |
|---|---|
PurgeProductsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PurgeProductsRequest |
build() |
PurgeProductsRequest |
buildPartial() |
PurgeProductsRequest.Builder |
clear() |
PurgeProductsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
PurgeProductsRequest.Builder |
clearFilter()
Required.
|
PurgeProductsRequest.Builder |
clearForce()
Actually perform the purge.
|
PurgeProductsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
PurgeProductsRequest.Builder |
clearParent()
Required.
|
PurgeProductsRequest.Builder |
clone() |
PurgeProductsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getFilter()
Required.
|
com.google.protobuf.ByteString |
getFilterBytes()
Required.
|
boolean |
getForce()
Actually perform the purge.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
PurgeProductsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PurgeProductsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
PurgeProductsRequest.Builder |
mergeFrom(PurgeProductsRequest other) |
PurgeProductsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
PurgeProductsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PurgeProductsRequest.Builder |
setFilter(String value)
Required.
|
PurgeProductsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Required.
|
PurgeProductsRequest.Builder |
setForce(boolean value)
Actually perform the purge.
|
PurgeProductsRequest.Builder |
setParent(String value)
Required.
|
PurgeProductsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
PurgeProductsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
PurgeProductsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PurgeProductsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PurgeProductsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PurgeProductsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder mergeFrom(PurgeProductsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public PurgeProductsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeProductsRequest.Builder>IOExceptionpublic 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) = { ... }
getParent in interface PurgeProductsRequestOrBuilderpublic com.google.protobuf.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) = { ... }
getParentBytes in interface PurgeProductsRequestOrBuilderpublic 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) = { ... }
value - The parent to set.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) = { ... }
public PurgeProductsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }
value - The bytes for parent to set.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][google.cloud.retail.v2alpha.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];getFilter in interface PurgeProductsRequestOrBuilderpublic com.google.protobuf.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][google.cloud.retail.v2alpha.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];getFilterBytes in interface PurgeProductsRequestOrBuilderpublic 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][google.cloud.retail.v2alpha.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];value - The filter to set.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][google.cloud.retail.v2alpha.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];public PurgeProductsRequest.Builder setFilterBytes(com.google.protobuf.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][google.cloud.retail.v2alpha.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];value - The bytes for filter to set.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;getForce in interface PurgeProductsRequestOrBuilderpublic 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;value - The force to set.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;public final PurgeProductsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>public final PurgeProductsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeProductsRequest.Builder>Copyright © 2024 Google LLC. All rights reserved.