Package com.google.cloud.retail.v2alpha
Class Product
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.retail.v2alpha.Product
-
- All Implemented Interfaces:
ProductOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class Product extends com.google.protobuf.GeneratedMessageV3 implements ProductOrBuilder
Product captures all metadata information of items to be recommended or searched.
Protobuf typegoogle.cloud.retail.v2alpha.Product
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Product.Availability
Product availability.static class
Product.Builder
Product captures all metadata information of items to be recommended or searched.static class
Product.ExpirationCase
static class
Product.Type
The type of this product.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsAttributes(String key)
Highly encouraged.boolean
equals(Object obj)
Map<String,CustomAttribute>
getAttributes()
Deprecated.int
getAttributesCount()
Highly encouraged.Map<String,CustomAttribute>
getAttributesMap()
Highly encouraged.CustomAttribute
getAttributesOrDefault(String key, CustomAttribute defaultValue)
Highly encouraged.CustomAttribute
getAttributesOrThrow(String key)
Highly encouraged.Audience
getAudience()
The target group associated with a given audience (e.g.AudienceOrBuilder
getAudienceOrBuilder()
The target group associated with a given audience (e.g.Product.Availability
getAvailability()
The online availability of the [Product][google.cloud.retail.v2alpha.Product].int
getAvailabilityValue()
The online availability of the [Product][google.cloud.retail.v2alpha.Product].com.google.protobuf.Int32Value
getAvailableQuantity()
The available quantity of the item.com.google.protobuf.Int32ValueOrBuilder
getAvailableQuantityOrBuilder()
The available quantity of the item.com.google.protobuf.Timestamp
getAvailableTime()
The timestamp when this [Product][google.cloud.retail.v2alpha.Product] becomes available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].com.google.protobuf.TimestampOrBuilder
getAvailableTimeOrBuilder()
The timestamp when this [Product][google.cloud.retail.v2alpha.Product] becomes available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].String
getBrands(int index)
The brands of the product.com.google.protobuf.ByteString
getBrandsBytes(int index)
The brands of the product.int
getBrandsCount()
The brands of the product.com.google.protobuf.ProtocolStringList
getBrandsList()
The brands of the product.String
getCategories(int index)
Product categories.com.google.protobuf.ByteString
getCategoriesBytes(int index)
Product categories.int
getCategoriesCount()
Product categories.com.google.protobuf.ProtocolStringList
getCategoriesList()
Product categories.String
getCollectionMemberIds(int index)
The [id][google.cloud.retail.v2alpha.Product.id] of the collection members when [type][google.cloud.retail.v2alpha.Product.type] is [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION].com.google.protobuf.ByteString
getCollectionMemberIdsBytes(int index)
The [id][google.cloud.retail.v2alpha.Product.id] of the collection members when [type][google.cloud.retail.v2alpha.Product.type] is [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION].int
getCollectionMemberIdsCount()
The [id][google.cloud.retail.v2alpha.Product.id] of the collection members when [type][google.cloud.retail.v2alpha.Product.type] is [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION].com.google.protobuf.ProtocolStringList
getCollectionMemberIdsList()
The [id][google.cloud.retail.v2alpha.Product.id] of the collection members when [type][google.cloud.retail.v2alpha.Product.type] is [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION].ColorInfo
getColorInfo()
The color of the product.ColorInfoOrBuilder
getColorInfoOrBuilder()
The color of the product.String
getConditions(int index)
The condition of the product.com.google.protobuf.ByteString
getConditionsBytes(int index)
The condition of the product.int
getConditionsCount()
The condition of the product.com.google.protobuf.ProtocolStringList
getConditionsList()
The condition of the product.static Product
getDefaultInstance()
Product
getDefaultInstanceForType()
String
getDescription()
Product description.com.google.protobuf.ByteString
getDescriptionBytes()
Product description.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
Product.ExpirationCase
getExpirationCase()
com.google.protobuf.Timestamp
getExpireTime()
The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].com.google.protobuf.TimestampOrBuilder
getExpireTimeOrBuilder()
The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].FulfillmentInfo
getFulfillmentInfo(int index)
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.int
getFulfillmentInfoCount()
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.List<FulfillmentInfo>
getFulfillmentInfoList()
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.FulfillmentInfoOrBuilder
getFulfillmentInfoOrBuilder(int index)
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.List<? extends FulfillmentInfoOrBuilder>
getFulfillmentInfoOrBuilderList()
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.String
getGtin()
The Global Trade Item Number (GTIN) of the product.com.google.protobuf.ByteString
getGtinBytes()
The Global Trade Item Number (GTIN) of the product.String
getId()
Immutable.com.google.protobuf.ByteString
getIdBytes()
Immutable.Image
getImages(int index)
Product images for the product.int
getImagesCount()
Product images for the product.List<Image>
getImagesList()
Product images for the product.ImageOrBuilder
getImagesOrBuilder(int index)
Product images for the product.List<? extends ImageOrBuilder>
getImagesOrBuilderList()
Product images for the product.String
getLanguageCode()
Language of the title/description and other string attributes.com.google.protobuf.ByteString
getLanguageCodeBytes()
Language of the title/description and other string attributes.LocalInventory
getLocalInventories(int index)
Output only.int
getLocalInventoriesCount()
Output only.List<LocalInventory>
getLocalInventoriesList()
Output only.LocalInventoryOrBuilder
getLocalInventoriesOrBuilder(int index)
Output only.List<? extends LocalInventoryOrBuilder>
getLocalInventoriesOrBuilderList()
Output only.String
getMaterials(int index)
The material of the product.com.google.protobuf.ByteString
getMaterialsBytes(int index)
The material of the product.int
getMaterialsCount()
The material of the product.com.google.protobuf.ProtocolStringList
getMaterialsList()
The material of the product.String
getName()
Immutable.com.google.protobuf.ByteString
getNameBytes()
Immutable.com.google.protobuf.Parser<Product>
getParserForType()
String
getPatterns(int index)
The pattern or graphic print of the product.com.google.protobuf.ByteString
getPatternsBytes(int index)
The pattern or graphic print of the product.int
getPatternsCount()
The pattern or graphic print of the product.com.google.protobuf.ProtocolStringList
getPatternsList()
The pattern or graphic print of the product.PriceInfo
getPriceInfo()
Product price and cost information.PriceInfoOrBuilder
getPriceInfoOrBuilder()
Product price and cost information.String
getPrimaryProductId()
Variant group identifier.com.google.protobuf.ByteString
getPrimaryProductIdBytes()
Variant group identifier.Promotion
getPromotions(int index)
The promotions applied to the product.int
getPromotionsCount()
The promotions applied to the product.List<Promotion>
getPromotionsList()
The promotions applied to the product.PromotionOrBuilder
getPromotionsOrBuilder(int index)
The promotions applied to the product.List<? extends PromotionOrBuilder>
getPromotionsOrBuilderList()
The promotions applied to the product.com.google.protobuf.Timestamp
getPublishTime()
The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products.com.google.protobuf.TimestampOrBuilder
getPublishTimeOrBuilder()
The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products.Rating
getRating()
The rating of this product.RatingOrBuilder
getRatingOrBuilder()
The rating of this product.com.google.protobuf.FieldMask
getRetrievableFields()
Deprecated.google.cloud.retail.v2alpha.Product.retrievable_fields is deprecated.com.google.protobuf.FieldMaskOrBuilder
getRetrievableFieldsOrBuilder()
Deprecated.int
getSerializedSize()
String
getSizes(int index)
The size of the product.com.google.protobuf.ByteString
getSizesBytes(int index)
The size of the product.int
getSizesCount()
The size of the product.com.google.protobuf.ProtocolStringList
getSizesList()
The size of the product.String
getTags(int index)
Custom tags associated with the product.com.google.protobuf.ByteString
getTagsBytes(int index)
Custom tags associated with the product.int
getTagsCount()
Custom tags associated with the product.com.google.protobuf.ProtocolStringList
getTagsList()
Custom tags associated with the product.String
getTitle()
Required.com.google.protobuf.ByteString
getTitleBytes()
Required.com.google.protobuf.Duration
getTtl()
Input only.com.google.protobuf.DurationOrBuilder
getTtlOrBuilder()
Input only.Product.Type
getType()
Immutable.int
getTypeValue()
Immutable.String
getUri()
Canonical URL directly linking to the product detail page.com.google.protobuf.ByteString
getUriBytes()
Canonical URL directly linking to the product detail page.Product
getVariants(int index)
Output only.int
getVariantsCount()
Output only.List<Product>
getVariantsList()
Output only.ProductOrBuilder
getVariantsOrBuilder(int index)
Output only.List<? extends ProductOrBuilder>
getVariantsOrBuilderList()
Output only.boolean
hasAudience()
The target group associated with a given audience (e.g.boolean
hasAvailableQuantity()
The available quantity of the item.boolean
hasAvailableTime()
The timestamp when this [Product][google.cloud.retail.v2alpha.Product] becomes available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].boolean
hasColorInfo()
The color of the product.boolean
hasExpireTime()
The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].int
hashCode()
boolean
hasPriceInfo()
Product price and cost information.boolean
hasPublishTime()
The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products.boolean
hasRating()
The rating of this product.boolean
hasRetrievableFields()
Deprecated.google.cloud.retail.v2alpha.Product.retrievable_fields is deprecated.boolean
hasTtl()
Input only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static Product.Builder
newBuilder()
static Product.Builder
newBuilder(Product prototype)
Product.Builder
newBuilderForType()
protected Product.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Product
parseDelimitedFrom(InputStream input)
static Product
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Product
parseFrom(byte[] data)
static Product
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Product
parseFrom(com.google.protobuf.ByteString data)
static Product
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Product
parseFrom(com.google.protobuf.CodedInputStream input)
static Product
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Product
parseFrom(InputStream input)
static Product
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Product
parseFrom(ByteBuffer data)
static Product
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Product>
parser()
Product.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TTL_FIELD_NUMBER
public static final int TTL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PRIMARY_PRODUCT_ID_FIELD_NUMBER
public static final int PRIMARY_PRODUCT_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COLLECTION_MEMBER_IDS_FIELD_NUMBER
public static final int COLLECTION_MEMBER_IDS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
GTIN_FIELD_NUMBER
public static final int GTIN_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CATEGORIES_FIELD_NUMBER
public static final int CATEGORIES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BRANDS_FIELD_NUMBER
public static final int BRANDS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PRICE_INFO_FIELD_NUMBER
public static final int PRICE_INFO_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RATING_FIELD_NUMBER
public static final int RATING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AVAILABLE_TIME_FIELD_NUMBER
public static final int AVAILABLE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AVAILABILITY_FIELD_NUMBER
public static final int AVAILABILITY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AVAILABLE_QUANTITY_FIELD_NUMBER
public static final int AVAILABLE_QUANTITY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FULFILLMENT_INFO_FIELD_NUMBER
public static final int FULFILLMENT_INFO_FIELD_NUMBER
- See Also:
- Constant Field Values
-
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IMAGES_FIELD_NUMBER
public static final int IMAGES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AUDIENCE_FIELD_NUMBER
public static final int AUDIENCE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COLOR_INFO_FIELD_NUMBER
public static final int COLOR_INFO_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SIZES_FIELD_NUMBER
public static final int SIZES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MATERIALS_FIELD_NUMBER
public static final int MATERIALS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PATTERNS_FIELD_NUMBER
public static final int PATTERNS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PROMOTIONS_FIELD_NUMBER
public static final int PROMOTIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PUBLISH_TIME_FIELD_NUMBER
public static final int PUBLISH_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RETRIEVABLE_FIELDS_FIELD_NUMBER
public static final int RETRIEVABLE_FIELDS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
VARIANTS_FIELD_NUMBER
public static final int VARIANTS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOCAL_INVENTORIES_FIELD_NUMBER
public static final int LOCAL_INVENTORIES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getExpirationCase
public Product.ExpirationCase getExpirationCase()
- Specified by:
getExpirationCase
in interfaceProductOrBuilder
-
hasExpireTime
public boolean hasExpireTime()
The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, the [Product][google.cloud.retail.v2alpha.Product] is not available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search] after [expire_time][google.cloud.retail.v2alpha.Product.expire_time]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]. [expire_time][google.cloud.retail.v2alpha.Product.expire_time] must be later than [available_time][google.cloud.retail.v2alpha.Product.available_time] and [publish_time][google.cloud.retail.v2alpha.Product.publish_time], otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property [expiration_date](https://support.google.com/merchants/answer/6324499).
.google.protobuf.Timestamp expire_time = 16;
- Specified by:
hasExpireTime
in interfaceProductOrBuilder
- Returns:
- Whether the expireTime field is set.
-
getExpireTime
public com.google.protobuf.Timestamp getExpireTime()
The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, the [Product][google.cloud.retail.v2alpha.Product] is not available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search] after [expire_time][google.cloud.retail.v2alpha.Product.expire_time]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]. [expire_time][google.cloud.retail.v2alpha.Product.expire_time] must be later than [available_time][google.cloud.retail.v2alpha.Product.available_time] and [publish_time][google.cloud.retail.v2alpha.Product.publish_time], otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property [expiration_date](https://support.google.com/merchants/answer/6324499).
.google.protobuf.Timestamp expire_time = 16;
- Specified by:
getExpireTime
in interfaceProductOrBuilder
- Returns:
- The expireTime.
-
getExpireTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, the [Product][google.cloud.retail.v2alpha.Product] is not available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search] after [expire_time][google.cloud.retail.v2alpha.Product.expire_time]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts]. [expire_time][google.cloud.retail.v2alpha.Product.expire_time] must be later than [available_time][google.cloud.retail.v2alpha.Product.available_time] and [publish_time][google.cloud.retail.v2alpha.Product.publish_time], otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property [expiration_date](https://support.google.com/merchants/answer/6324499).
.google.protobuf.Timestamp expire_time = 16;
- Specified by:
getExpireTimeOrBuilder
in interfaceProductOrBuilder
-
hasTtl
public boolean hasTtl()
Input only. The TTL (time to live) of the product. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl]. The derived [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2alpha.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2alpha.Product]. If it is set, the product is not available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search] after current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
.google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];
- Specified by:
hasTtl
in interfaceProductOrBuilder
- Returns:
- Whether the ttl field is set.
-
getTtl
public com.google.protobuf.Duration getTtl()
Input only. The TTL (time to live) of the product. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl]. The derived [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2alpha.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2alpha.Product]. If it is set, the product is not available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search] after current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
.google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];
- Specified by:
getTtl
in interfaceProductOrBuilder
- Returns:
- The ttl.
-
getTtlOrBuilder
public com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
Input only. The TTL (time to live) of the product. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl]. The derived [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2alpha.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2alpha.Product]. If it is set, the product is not available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search] after current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
.google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];
- Specified by:
getTtlOrBuilder
in interfaceProductOrBuilder
-
getName
public String getName()
Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
getName
in interfaceProductOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
getNameBytes
in interfaceProductOrBuilder
- Returns:
- The bytes for name.
-
getId
public String getId()
Immutable. [Product][google.cloud.retail.v2alpha.Product] identifier, which is the final component of [name][google.cloud.retail.v2alpha.Product.name]. For example, this field is "id_1", if [name][google.cloud.retail.v2alpha.Product.name] is `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [id](https://support.google.com/merchants/answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
getId
in interfaceProductOrBuilder
- Returns:
- The id.
-
getIdBytes
public com.google.protobuf.ByteString getIdBytes()
Immutable. [Product][google.cloud.retail.v2alpha.Product] identifier, which is the final component of [name][google.cloud.retail.v2alpha.Product.name]. For example, this field is "id_1", if [name][google.cloud.retail.v2alpha.Product.name] is `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [id](https://support.google.com/merchants/answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
getIdBytes
in interfaceProductOrBuilder
- Returns:
- The bytes for id.
-
getTypeValue
public int getTypeValue()
Immutable. The type of the product. Default to [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2alpha.ProductLevelConfig.ingestion_product_type] if unset.
.google.cloud.retail.v2alpha.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
getTypeValue
in interfaceProductOrBuilder
- Returns:
- The enum numeric value on the wire for type.
-
getType
public Product.Type getType()
Immutable. The type of the product. Default to [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2alpha.ProductLevelConfig.ingestion_product_type] if unset.
.google.cloud.retail.v2alpha.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
getType
in interfaceProductOrBuilder
- Returns:
- The type.
-
getPrimaryProductId
public String getPrimaryProductId()
Variant group identifier. Must be an [id][google.cloud.retail.v2alpha.Product.id], with the same parent branch with this product. Otherwise, an error is thrown. For [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]s, this field can only be empty or set to the same value as [id][google.cloud.retail.v2alpha.Product.id]. For VARIANT [Product][google.cloud.retail.v2alpha.Product]s, this field cannot be empty. A maximum of 2,000 products are allowed to share the same [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [item_group_id](https://support.google.com/merchants/answer/6324507). Schema.org property [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
string primary_product_id = 4;
- Specified by:
getPrimaryProductId
in interfaceProductOrBuilder
- Returns:
- The primaryProductId.
-
getPrimaryProductIdBytes
public com.google.protobuf.ByteString getPrimaryProductIdBytes()
Variant group identifier. Must be an [id][google.cloud.retail.v2alpha.Product.id], with the same parent branch with this product. Otherwise, an error is thrown. For [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]s, this field can only be empty or set to the same value as [id][google.cloud.retail.v2alpha.Product.id]. For VARIANT [Product][google.cloud.retail.v2alpha.Product]s, this field cannot be empty. A maximum of 2,000 products are allowed to share the same [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [item_group_id](https://support.google.com/merchants/answer/6324507). Schema.org property [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
string primary_product_id = 4;
- Specified by:
getPrimaryProductIdBytes
in interfaceProductOrBuilder
- Returns:
- The bytes for primaryProductId.
-
getCollectionMemberIdsList
public com.google.protobuf.ProtocolStringList getCollectionMemberIdsList()
The [id][google.cloud.retail.v2alpha.Product.id] of the collection members when [type][google.cloud.retail.v2alpha.Product.type] is [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]. Non-existent product ids are allowed. The [type][google.cloud.retail.v2alpha.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT] otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.
repeated string collection_member_ids = 5;
- Specified by:
getCollectionMemberIdsList
in interfaceProductOrBuilder
- Returns:
- A list containing the collectionMemberIds.
-
getCollectionMemberIdsCount
public int getCollectionMemberIdsCount()
The [id][google.cloud.retail.v2alpha.Product.id] of the collection members when [type][google.cloud.retail.v2alpha.Product.type] is [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]. Non-existent product ids are allowed. The [type][google.cloud.retail.v2alpha.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT] otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.
repeated string collection_member_ids = 5;
- Specified by:
getCollectionMemberIdsCount
in interfaceProductOrBuilder
- Returns:
- The count of collectionMemberIds.
-
getCollectionMemberIds
public String getCollectionMemberIds(int index)
The [id][google.cloud.retail.v2alpha.Product.id] of the collection members when [type][google.cloud.retail.v2alpha.Product.type] is [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]. Non-existent product ids are allowed. The [type][google.cloud.retail.v2alpha.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT] otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.
repeated string collection_member_ids = 5;
- Specified by:
getCollectionMemberIds
in interfaceProductOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The collectionMemberIds at the given index.
-
getCollectionMemberIdsBytes
public com.google.protobuf.ByteString getCollectionMemberIdsBytes(int index)
The [id][google.cloud.retail.v2alpha.Product.id] of the collection members when [type][google.cloud.retail.v2alpha.Product.type] is [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]. Non-existent product ids are allowed. The [type][google.cloud.retail.v2alpha.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT] otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.
repeated string collection_member_ids = 5;
- Specified by:
getCollectionMemberIdsBytes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the collectionMemberIds at the given index.
-
getGtin
public String getGtin()
The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
string gtin = 6;
- Specified by:
getGtin
in interfaceProductOrBuilder
- Returns:
- The gtin.
-
getGtinBytes
public com.google.protobuf.ByteString getGtinBytes()
The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
string gtin = 6;
- Specified by:
getGtinBytes
in interfaceProductOrBuilder
- Returns:
- The bytes for gtin.
-
getCategoriesList
public com.google.protobuf.ProtocolStringList getCategoriesList()
Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product] otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [google_product_category][mc_google_product_category]. Schema.org property [Product.category] (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436
repeated string categories = 7;
- Specified by:
getCategoriesList
in interfaceProductOrBuilder
- Returns:
- A list containing the categories.
-
getCategoriesCount
public int getCategoriesCount()
Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product] otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [google_product_category][mc_google_product_category]. Schema.org property [Product.category] (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436
repeated string categories = 7;
- Specified by:
getCategoriesCount
in interfaceProductOrBuilder
- Returns:
- The count of categories.
-
getCategories
public String getCategories(int index)
Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product] otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [google_product_category][mc_google_product_category]. Schema.org property [Product.category] (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436
repeated string categories = 7;
- Specified by:
getCategories
in interfaceProductOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The categories at the given index.
-
getCategoriesBytes
public com.google.protobuf.ByteString getCategoriesBytes(int index)
Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product] otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [google_product_category][mc_google_product_category]. Schema.org property [Product.category] (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436
repeated string categories = 7;
- Specified by:
getCategoriesBytes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the categories at the given index.
-
getTitle
public String getTitle()
Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [title](https://support.google.com/merchants/answer/6324415). Schema.org property [Product.name](https://schema.org/name).
string title = 8 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getTitle
in interfaceProductOrBuilder
- Returns:
- The title.
-
getTitleBytes
public com.google.protobuf.ByteString getTitleBytes()
Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [title](https://support.google.com/merchants/answer/6324415). Schema.org property [Product.name](https://schema.org/name).
string title = 8 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getTitleBytes
in interfaceProductOrBuilder
- Returns:
- The bytes for title.
-
getBrandsList
public com.google.protobuf.ProtocolStringList getBrandsList()
The brands of the product. A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property [Product.brand](https://schema.org/brand).
repeated string brands = 9;
- Specified by:
getBrandsList
in interfaceProductOrBuilder
- Returns:
- A list containing the brands.
-
getBrandsCount
public int getBrandsCount()
The brands of the product. A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property [Product.brand](https://schema.org/brand).
repeated string brands = 9;
- Specified by:
getBrandsCount
in interfaceProductOrBuilder
- Returns:
- The count of brands.
-
getBrands
public String getBrands(int index)
The brands of the product. A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property [Product.brand](https://schema.org/brand).
repeated string brands = 9;
- Specified by:
getBrands
in interfaceProductOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The brands at the given index.
-
getBrandsBytes
public com.google.protobuf.ByteString getBrandsBytes(int index)
The brands of the product. A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property [Product.brand](https://schema.org/brand).
repeated string brands = 9;
- Specified by:
getBrandsBytes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the brands at the given index.
-
getDescription
public String getDescription()
Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [description](https://support.google.com/merchants/answer/6324468). Schema.org property [Product.description](https://schema.org/description).
string description = 10;
- Specified by:
getDescription
in interfaceProductOrBuilder
- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [description](https://support.google.com/merchants/answer/6324468). Schema.org property [Product.description](https://schema.org/description).
string description = 10;
- Specified by:
getDescriptionBytes
in interfaceProductOrBuilder
- Returns:
- The bytes for description.
-
getLanguageCode
public String getLanguageCode()
Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For product prediction, this field is ignored and the model automatically detects the text language. The [Product][google.cloud.retail.v2alpha.Product] can include text in different languages, but duplicating [Product][google.cloud.retail.v2alpha.Product]s to provide text in multiple languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset.
string language_code = 11;
- Specified by:
getLanguageCode
in interfaceProductOrBuilder
- Returns:
- The languageCode.
-
getLanguageCodeBytes
public com.google.protobuf.ByteString getLanguageCodeBytes()
Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For product prediction, this field is ignored and the model automatically detects the text language. The [Product][google.cloud.retail.v2alpha.Product] can include text in different languages, but duplicating [Product][google.cloud.retail.v2alpha.Product]s to provide text in multiple languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset.
string language_code = 11;
- Specified by:
getLanguageCodeBytes
in interfaceProductOrBuilder
- Returns:
- The bytes for languageCode.
-
getAttributesCount
public int getAttributesCount()
Description copied from interface:ProductOrBuilder
Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 12;
- Specified by:
getAttributesCount
in interfaceProductOrBuilder
-
containsAttributes
public boolean containsAttributes(String key)
Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 12;
- Specified by:
containsAttributes
in interfaceProductOrBuilder
-
getAttributes
@Deprecated public Map<String,CustomAttribute> getAttributes()
Deprecated.UsegetAttributesMap()
instead.- Specified by:
getAttributes
in interfaceProductOrBuilder
-
getAttributesMap
public Map<String,CustomAttribute> getAttributesMap()
Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 12;
- Specified by:
getAttributesMap
in interfaceProductOrBuilder
-
getAttributesOrDefault
public CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)
Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 12;
- Specified by:
getAttributesOrDefault
in interfaceProductOrBuilder
-
getAttributesOrThrow
public CustomAttribute getAttributesOrThrow(String key)
Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 12;
- Specified by:
getAttributesOrThrow
in interfaceProductOrBuilder
-
getTagsList
public com.google.protobuf.ProtocolStringList getTagsList()
Custom tags associated with the product. At most 250 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the [PredictRequest.filter][google.cloud.retail.v2alpha.PredictRequest.filter]. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473).
repeated string tags = 13;
- Specified by:
getTagsList
in interfaceProductOrBuilder
- Returns:
- A list containing the tags.
-
getTagsCount
public int getTagsCount()
Custom tags associated with the product. At most 250 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the [PredictRequest.filter][google.cloud.retail.v2alpha.PredictRequest.filter]. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473).
repeated string tags = 13;
- Specified by:
getTagsCount
in interfaceProductOrBuilder
- Returns:
- The count of tags.
-
getTags
public String getTags(int index)
Custom tags associated with the product. At most 250 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the [PredictRequest.filter][google.cloud.retail.v2alpha.PredictRequest.filter]. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473).
repeated string tags = 13;
- Specified by:
getTags
in interfaceProductOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The tags at the given index.
-
getTagsBytes
public com.google.protobuf.ByteString getTagsBytes(int index)
Custom tags associated with the product. At most 250 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the [PredictRequest.filter][google.cloud.retail.v2alpha.PredictRequest.filter]. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473).
repeated string tags = 13;
- Specified by:
getTagsBytes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the tags at the given index.
-
hasPriceInfo
public boolean hasPriceInfo()
Product price and cost information. Corresponding properties: Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371).
.google.cloud.retail.v2alpha.PriceInfo price_info = 14;
- Specified by:
hasPriceInfo
in interfaceProductOrBuilder
- Returns:
- Whether the priceInfo field is set.
-
getPriceInfo
public PriceInfo getPriceInfo()
Product price and cost information. Corresponding properties: Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371).
.google.cloud.retail.v2alpha.PriceInfo price_info = 14;
- Specified by:
getPriceInfo
in interfaceProductOrBuilder
- Returns:
- The priceInfo.
-
getPriceInfoOrBuilder
public PriceInfoOrBuilder getPriceInfoOrBuilder()
Product price and cost information. Corresponding properties: Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371).
.google.cloud.retail.v2alpha.PriceInfo price_info = 14;
- Specified by:
getPriceInfoOrBuilder
in interfaceProductOrBuilder
-
hasRating
public boolean hasRating()
The rating of this product.
.google.cloud.retail.v2alpha.Rating rating = 15;
- Specified by:
hasRating
in interfaceProductOrBuilder
- Returns:
- Whether the rating field is set.
-
getRating
public Rating getRating()
The rating of this product.
.google.cloud.retail.v2alpha.Rating rating = 15;
- Specified by:
getRating
in interfaceProductOrBuilder
- Returns:
- The rating.
-
getRatingOrBuilder
public RatingOrBuilder getRatingOrBuilder()
The rating of this product.
.google.cloud.retail.v2alpha.Rating rating = 15;
- Specified by:
getRatingOrBuilder
in interfaceProductOrBuilder
-
hasAvailableTime
public boolean hasAvailableTime()
The timestamp when this [Product][google.cloud.retail.v2alpha.Product] becomes available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT].
.google.protobuf.Timestamp available_time = 18;
- Specified by:
hasAvailableTime
in interfaceProductOrBuilder
- Returns:
- Whether the availableTime field is set.
-
getAvailableTime
public com.google.protobuf.Timestamp getAvailableTime()
The timestamp when this [Product][google.cloud.retail.v2alpha.Product] becomes available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT].
.google.protobuf.Timestamp available_time = 18;
- Specified by:
getAvailableTime
in interfaceProductOrBuilder
- Returns:
- The availableTime.
-
getAvailableTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getAvailableTimeOrBuilder()
The timestamp when this [Product][google.cloud.retail.v2alpha.Product] becomes available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT].
.google.protobuf.Timestamp available_time = 18;
- Specified by:
getAvailableTimeOrBuilder
in interfaceProductOrBuilder
-
getAvailabilityValue
public int getAvailabilityValue()
The online availability of the [Product][google.cloud.retail.v2alpha.Product]. Default to [Availability.IN_STOCK][google.cloud.retail.v2alpha.Product.Availability.IN_STOCK]. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).
.google.cloud.retail.v2alpha.Product.Availability availability = 19;
- Specified by:
getAvailabilityValue
in interfaceProductOrBuilder
- Returns:
- The enum numeric value on the wire for availability.
-
getAvailability
public Product.Availability getAvailability()
The online availability of the [Product][google.cloud.retail.v2alpha.Product]. Default to [Availability.IN_STOCK][google.cloud.retail.v2alpha.Product.Availability.IN_STOCK]. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).
.google.cloud.retail.v2alpha.Product.Availability availability = 19;
- Specified by:
getAvailability
in interfaceProductOrBuilder
- Returns:
- The availability.
-
hasAvailableQuantity
public boolean hasAvailableQuantity()
The available quantity of the item.
.google.protobuf.Int32Value available_quantity = 20;
- Specified by:
hasAvailableQuantity
in interfaceProductOrBuilder
- Returns:
- Whether the availableQuantity field is set.
-
getAvailableQuantity
public com.google.protobuf.Int32Value getAvailableQuantity()
The available quantity of the item.
.google.protobuf.Int32Value available_quantity = 20;
- Specified by:
getAvailableQuantity
in interfaceProductOrBuilder
- Returns:
- The availableQuantity.
-
getAvailableQuantityOrBuilder
public com.google.protobuf.Int32ValueOrBuilder getAvailableQuantityOrBuilder()
The available quantity of the item.
.google.protobuf.Int32Value available_quantity = 20;
- Specified by:
getAvailableQuantityOrBuilder
in interfaceProductOrBuilder
-
getFulfillmentInfoList
public List<FulfillmentInfo> getFulfillmentInfoList()
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2alpha.FulfillmentInfo fulfillment_info = 21;
- Specified by:
getFulfillmentInfoList
in interfaceProductOrBuilder
-
getFulfillmentInfoOrBuilderList
public List<? extends FulfillmentInfoOrBuilder> getFulfillmentInfoOrBuilderList()
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2alpha.FulfillmentInfo fulfillment_info = 21;
- Specified by:
getFulfillmentInfoOrBuilderList
in interfaceProductOrBuilder
-
getFulfillmentInfoCount
public int getFulfillmentInfoCount()
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2alpha.FulfillmentInfo fulfillment_info = 21;
- Specified by:
getFulfillmentInfoCount
in interfaceProductOrBuilder
-
getFulfillmentInfo
public FulfillmentInfo getFulfillmentInfo(int index)
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2alpha.FulfillmentInfo fulfillment_info = 21;
- Specified by:
getFulfillmentInfo
in interfaceProductOrBuilder
-
getFulfillmentInfoOrBuilder
public FulfillmentInfoOrBuilder getFulfillmentInfoOrBuilder(int index)
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2alpha.FulfillmentInfo fulfillment_info = 21;
- Specified by:
getFulfillmentInfoOrBuilder
in interfaceProductOrBuilder
-
getUri
public String getUri()
Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [link](https://support.google.com/merchants/answer/6324416). Schema.org property [Offer.url](https://schema.org/url).
string uri = 22;
- Specified by:
getUri
in interfaceProductOrBuilder
- Returns:
- The uri.
-
getUriBytes
public com.google.protobuf.ByteString getUriBytes()
Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [link](https://support.google.com/merchants/answer/6324416). Schema.org property [Offer.url](https://schema.org/url).
string uri = 22;
- Specified by:
getUriBytes
in interfaceProductOrBuilder
- Returns:
- The bytes for uri.
-
getImagesList
public List<Image> getImagesList()
Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).
repeated .google.cloud.retail.v2alpha.Image images = 23;
- Specified by:
getImagesList
in interfaceProductOrBuilder
-
getImagesOrBuilderList
public List<? extends ImageOrBuilder> getImagesOrBuilderList()
Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).
repeated .google.cloud.retail.v2alpha.Image images = 23;
- Specified by:
getImagesOrBuilderList
in interfaceProductOrBuilder
-
getImagesCount
public int getImagesCount()
Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).
repeated .google.cloud.retail.v2alpha.Image images = 23;
- Specified by:
getImagesCount
in interfaceProductOrBuilder
-
getImages
public Image getImages(int index)
Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).
repeated .google.cloud.retail.v2alpha.Image images = 23;
- Specified by:
getImages
in interfaceProductOrBuilder
-
getImagesOrBuilder
public ImageOrBuilder getImagesOrBuilder(int index)
Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).
repeated .google.cloud.retail.v2alpha.Image images = 23;
- Specified by:
getImagesOrBuilder
in interfaceProductOrBuilder
-
hasAudience
public boolean hasAudience()
The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.
.google.cloud.retail.v2alpha.Audience audience = 24;
- Specified by:
hasAudience
in interfaceProductOrBuilder
- Returns:
- Whether the audience field is set.
-
getAudience
public Audience getAudience()
The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.
.google.cloud.retail.v2alpha.Audience audience = 24;
- Specified by:
getAudience
in interfaceProductOrBuilder
- Returns:
- The audience.
-
getAudienceOrBuilder
public AudienceOrBuilder getAudienceOrBuilder()
The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.
.google.cloud.retail.v2alpha.Audience audience = 24;
- Specified by:
getAudienceOrBuilder
in interfaceProductOrBuilder
-
hasColorInfo
public boolean hasColorInfo()
The color of the product. Corresponding properties: Google Merchant Center property [color](https://support.google.com/merchants/answer/6324487). Schema.org property [Product.color](https://schema.org/color).
.google.cloud.retail.v2alpha.ColorInfo color_info = 25;
- Specified by:
hasColorInfo
in interfaceProductOrBuilder
- Returns:
- Whether the colorInfo field is set.
-
getColorInfo
public ColorInfo getColorInfo()
The color of the product. Corresponding properties: Google Merchant Center property [color](https://support.google.com/merchants/answer/6324487). Schema.org property [Product.color](https://schema.org/color).
.google.cloud.retail.v2alpha.ColorInfo color_info = 25;
- Specified by:
getColorInfo
in interfaceProductOrBuilder
- Returns:
- The colorInfo.
-
getColorInfoOrBuilder
public ColorInfoOrBuilder getColorInfoOrBuilder()
The color of the product. Corresponding properties: Google Merchant Center property [color](https://support.google.com/merchants/answer/6324487). Schema.org property [Product.color](https://schema.org/color).
.google.cloud.retail.v2alpha.ColorInfo color_info = 25;
- Specified by:
getColorInfoOrBuilder
in interfaceProductOrBuilder
-
getSizesList
public com.google.protobuf.ProtocolStringList getSizesList()
The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).
repeated string sizes = 26;
- Specified by:
getSizesList
in interfaceProductOrBuilder
- Returns:
- A list containing the sizes.
-
getSizesCount
public int getSizesCount()
The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).
repeated string sizes = 26;
- Specified by:
getSizesCount
in interfaceProductOrBuilder
- Returns:
- The count of sizes.
-
getSizes
public String getSizes(int index)
The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).
repeated string sizes = 26;
- Specified by:
getSizes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The sizes at the given index.
-
getSizesBytes
public com.google.protobuf.ByteString getSizesBytes(int index)
The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).
repeated string sizes = 26;
- Specified by:
getSizesBytes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the sizes at the given index.
-
getMaterialsList
public com.google.protobuf.ProtocolStringList getMaterialsList()
The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material).
repeated string materials = 27;
- Specified by:
getMaterialsList
in interfaceProductOrBuilder
- Returns:
- A list containing the materials.
-
getMaterialsCount
public int getMaterialsCount()
The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material).
repeated string materials = 27;
- Specified by:
getMaterialsCount
in interfaceProductOrBuilder
- Returns:
- The count of materials.
-
getMaterials
public String getMaterials(int index)
The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material).
repeated string materials = 27;
- Specified by:
getMaterials
in interfaceProductOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The materials at the given index.
-
getMaterialsBytes
public com.google.protobuf.ByteString getMaterialsBytes(int index)
The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material).
repeated string materials = 27;
- Specified by:
getMaterialsBytes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the materials at the given index.
-
getPatternsList
public com.google.protobuf.ProtocolStringList getPatternsList()
The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern).
repeated string patterns = 28;
- Specified by:
getPatternsList
in interfaceProductOrBuilder
- Returns:
- A list containing the patterns.
-
getPatternsCount
public int getPatternsCount()
The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern).
repeated string patterns = 28;
- Specified by:
getPatternsCount
in interfaceProductOrBuilder
- Returns:
- The count of patterns.
-
getPatterns
public String getPatterns(int index)
The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern).
repeated string patterns = 28;
- Specified by:
getPatterns
in interfaceProductOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The patterns at the given index.
-
getPatternsBytes
public com.google.protobuf.ByteString getPatternsBytes(int index)
The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern).
repeated string patterns = 28;
- Specified by:
getPatternsBytes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the patterns at the given index.
-
getConditionsList
public com.google.protobuf.ProtocolStringList getConditionsList()
The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition).
repeated string conditions = 29;
- Specified by:
getConditionsList
in interfaceProductOrBuilder
- Returns:
- A list containing the conditions.
-
getConditionsCount
public int getConditionsCount()
The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition).
repeated string conditions = 29;
- Specified by:
getConditionsCount
in interfaceProductOrBuilder
- Returns:
- The count of conditions.
-
getConditions
public String getConditions(int index)
The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition).
repeated string conditions = 29;
- Specified by:
getConditions
in interfaceProductOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The conditions at the given index.
-
getConditionsBytes
public com.google.protobuf.ByteString getConditionsBytes(int index)
The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition).
repeated string conditions = 29;
- Specified by:
getConditionsBytes
in interfaceProductOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the conditions at the given index.
-
getPromotionsList
public List<Promotion> getPromotionsList()
The promotions applied to the product. A maximum of 10 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2alpha.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2alpha.Promotion promotions = 34;
- Specified by:
getPromotionsList
in interfaceProductOrBuilder
-
getPromotionsOrBuilderList
public List<? extends PromotionOrBuilder> getPromotionsOrBuilderList()
The promotions applied to the product. A maximum of 10 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2alpha.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2alpha.Promotion promotions = 34;
- Specified by:
getPromotionsOrBuilderList
in interfaceProductOrBuilder
-
getPromotionsCount
public int getPromotionsCount()
The promotions applied to the product. A maximum of 10 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2alpha.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2alpha.Promotion promotions = 34;
- Specified by:
getPromotionsCount
in interfaceProductOrBuilder
-
getPromotions
public Promotion getPromotions(int index)
The promotions applied to the product. A maximum of 10 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2alpha.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2alpha.Promotion promotions = 34;
- Specified by:
getPromotions
in interfaceProductOrBuilder
-
getPromotionsOrBuilder
public PromotionOrBuilder getPromotionsOrBuilder(int index)
The promotions applied to the product. A maximum of 10 values are allowed per [Product][google.cloud.retail.v2alpha.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2alpha.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2alpha.Promotion promotions = 34;
- Specified by:
getPromotionsOrBuilder
in interfaceProductOrBuilder
-
hasPublishTime
public boolean hasPublishTime()
The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from [available_time][google.cloud.retail.v2alpha.Product.available_time], given it purely describes product freshness regardless of when it is available on search and recommendation.
.google.protobuf.Timestamp publish_time = 33;
- Specified by:
hasPublishTime
in interfaceProductOrBuilder
- Returns:
- Whether the publishTime field is set.
-
getPublishTime
public com.google.protobuf.Timestamp getPublishTime()
The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from [available_time][google.cloud.retail.v2alpha.Product.available_time], given it purely describes product freshness regardless of when it is available on search and recommendation.
.google.protobuf.Timestamp publish_time = 33;
- Specified by:
getPublishTime
in interfaceProductOrBuilder
- Returns:
- The publishTime.
-
getPublishTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getPublishTimeOrBuilder()
The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from [available_time][google.cloud.retail.v2alpha.Product.available_time], given it purely describes product freshness regardless of when it is available on search and recommendation.
.google.protobuf.Timestamp publish_time = 33;
- Specified by:
getPublishTimeOrBuilder
in interfaceProductOrBuilder
-
hasRetrievableFields
@Deprecated public boolean hasRetrievableFields()
Deprecated.google.cloud.retail.v2alpha.Product.retrievable_fields is deprecated. See google/cloud/retail/v2alpha/product.proto;l=574Indicates which fields in the [Product][google.cloud.retail.v2alpha.Product]s are returned in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse]. Supported fields for all [type][google.cloud.retail.v2alpha.Product.type]s: * [audience][google.cloud.retail.v2alpha.Product.audience] * [availability][google.cloud.retail.v2alpha.Product.availability] * [brands][google.cloud.retail.v2alpha.Product.brands] * [color_info][google.cloud.retail.v2alpha.Product.color_info] * [conditions][google.cloud.retail.v2alpha.Product.conditions] * [gtin][google.cloud.retail.v2alpha.Product.gtin] * [materials][google.cloud.retail.v2alpha.Product.materials] * [name][google.cloud.retail.v2alpha.Product.name] * [patterns][google.cloud.retail.v2alpha.Product.patterns] * [price_info][google.cloud.retail.v2alpha.Product.price_info] * [rating][google.cloud.retail.v2alpha.Product.rating] * [sizes][google.cloud.retail.v2alpha.Product.sizes] * [title][google.cloud.retail.v2alpha.Product.title] * [uri][google.cloud.retail.v2alpha.Product.uri] Supported fields only for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]: * [categories][google.cloud.retail.v2alpha.Product.categories] * [description][google.cloud.retail.v2alpha.Product.description] * [images][google.cloud.retail.v2alpha.Product.images] Supported fields only for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]: * Only the first image in [images][google.cloud.retail.v2alpha.Product.images] To mark [attributes][google.cloud.retail.v2alpha.Product.attributes] as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in [attributes][google.cloud.retail.v2alpha.Product.attributes]. For [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], the following fields are always returned in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] by default: * [name][google.cloud.retail.v2alpha.Product.name] For [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT], the following fields are always returned in by default: * [name][google.cloud.retail.v2alpha.Product.name] * [color_info][google.cloud.retail.v2alpha.Product.color_info] The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
.google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true];
- Specified by:
hasRetrievableFields
in interfaceProductOrBuilder
- Returns:
- Whether the retrievableFields field is set.
-
getRetrievableFields
@Deprecated public com.google.protobuf.FieldMask getRetrievableFields()
Deprecated.google.cloud.retail.v2alpha.Product.retrievable_fields is deprecated. See google/cloud/retail/v2alpha/product.proto;l=574Indicates which fields in the [Product][google.cloud.retail.v2alpha.Product]s are returned in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse]. Supported fields for all [type][google.cloud.retail.v2alpha.Product.type]s: * [audience][google.cloud.retail.v2alpha.Product.audience] * [availability][google.cloud.retail.v2alpha.Product.availability] * [brands][google.cloud.retail.v2alpha.Product.brands] * [color_info][google.cloud.retail.v2alpha.Product.color_info] * [conditions][google.cloud.retail.v2alpha.Product.conditions] * [gtin][google.cloud.retail.v2alpha.Product.gtin] * [materials][google.cloud.retail.v2alpha.Product.materials] * [name][google.cloud.retail.v2alpha.Product.name] * [patterns][google.cloud.retail.v2alpha.Product.patterns] * [price_info][google.cloud.retail.v2alpha.Product.price_info] * [rating][google.cloud.retail.v2alpha.Product.rating] * [sizes][google.cloud.retail.v2alpha.Product.sizes] * [title][google.cloud.retail.v2alpha.Product.title] * [uri][google.cloud.retail.v2alpha.Product.uri] Supported fields only for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]: * [categories][google.cloud.retail.v2alpha.Product.categories] * [description][google.cloud.retail.v2alpha.Product.description] * [images][google.cloud.retail.v2alpha.Product.images] Supported fields only for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]: * Only the first image in [images][google.cloud.retail.v2alpha.Product.images] To mark [attributes][google.cloud.retail.v2alpha.Product.attributes] as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in [attributes][google.cloud.retail.v2alpha.Product.attributes]. For [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], the following fields are always returned in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] by default: * [name][google.cloud.retail.v2alpha.Product.name] For [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT], the following fields are always returned in by default: * [name][google.cloud.retail.v2alpha.Product.name] * [color_info][google.cloud.retail.v2alpha.Product.color_info] The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
.google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true];
- Specified by:
getRetrievableFields
in interfaceProductOrBuilder
- Returns:
- The retrievableFields.
-
getRetrievableFieldsOrBuilder
@Deprecated public com.google.protobuf.FieldMaskOrBuilder getRetrievableFieldsOrBuilder()
Deprecated.Indicates which fields in the [Product][google.cloud.retail.v2alpha.Product]s are returned in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse]. Supported fields for all [type][google.cloud.retail.v2alpha.Product.type]s: * [audience][google.cloud.retail.v2alpha.Product.audience] * [availability][google.cloud.retail.v2alpha.Product.availability] * [brands][google.cloud.retail.v2alpha.Product.brands] * [color_info][google.cloud.retail.v2alpha.Product.color_info] * [conditions][google.cloud.retail.v2alpha.Product.conditions] * [gtin][google.cloud.retail.v2alpha.Product.gtin] * [materials][google.cloud.retail.v2alpha.Product.materials] * [name][google.cloud.retail.v2alpha.Product.name] * [patterns][google.cloud.retail.v2alpha.Product.patterns] * [price_info][google.cloud.retail.v2alpha.Product.price_info] * [rating][google.cloud.retail.v2alpha.Product.rating] * [sizes][google.cloud.retail.v2alpha.Product.sizes] * [title][google.cloud.retail.v2alpha.Product.title] * [uri][google.cloud.retail.v2alpha.Product.uri] Supported fields only for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]: * [categories][google.cloud.retail.v2alpha.Product.categories] * [description][google.cloud.retail.v2alpha.Product.description] * [images][google.cloud.retail.v2alpha.Product.images] Supported fields only for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]: * Only the first image in [images][google.cloud.retail.v2alpha.Product.images] To mark [attributes][google.cloud.retail.v2alpha.Product.attributes] as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in [attributes][google.cloud.retail.v2alpha.Product.attributes]. For [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], the following fields are always returned in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] by default: * [name][google.cloud.retail.v2alpha.Product.name] For [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT], the following fields are always returned in by default: * [name][google.cloud.retail.v2alpha.Product.name] * [color_info][google.cloud.retail.v2alpha.Product.color_info] The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
.google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true];
- Specified by:
getRetrievableFieldsOrBuilder
in interfaceProductOrBuilder
-
getVariantsList
public List<Product> getVariantsList()
Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by [primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2alpha.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getVariantsList
in interfaceProductOrBuilder
-
getVariantsOrBuilderList
public List<? extends ProductOrBuilder> getVariantsOrBuilderList()
Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by [primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2alpha.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getVariantsOrBuilderList
in interfaceProductOrBuilder
-
getVariantsCount
public int getVariantsCount()
Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by [primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2alpha.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getVariantsCount
in interfaceProductOrBuilder
-
getVariants
public Product getVariants(int index)
Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by [primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2alpha.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getVariants
in interfaceProductOrBuilder
-
getVariantsOrBuilder
public ProductOrBuilder getVariantsOrBuilder(int index)
Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by [primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2alpha.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getVariantsOrBuilder
in interfaceProductOrBuilder
-
getLocalInventoriesList
public List<LocalInventory> getLocalInventoriesList()
Output only. A list of local inventories specific to different places. This field can be managed by [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getLocalInventoriesList
in interfaceProductOrBuilder
-
getLocalInventoriesOrBuilderList
public List<? extends LocalInventoryOrBuilder> getLocalInventoriesOrBuilderList()
Output only. A list of local inventories specific to different places. This field can be managed by [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getLocalInventoriesOrBuilderList
in interfaceProductOrBuilder
-
getLocalInventoriesCount
public int getLocalInventoriesCount()
Output only. A list of local inventories specific to different places. This field can be managed by [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getLocalInventoriesCount
in interfaceProductOrBuilder
-
getLocalInventories
public LocalInventory getLocalInventories(int index)
Output only. A list of local inventories specific to different places. This field can be managed by [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getLocalInventories
in interfaceProductOrBuilder
-
getLocalInventoriesOrBuilder
public LocalInventoryOrBuilder getLocalInventoriesOrBuilder(int index)
Output only. A list of local inventories specific to different places. This field can be managed by [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getLocalInventoriesOrBuilder
in interfaceProductOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Product parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Product parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Product parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Product parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Product parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Product parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Product parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Product parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Product parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Product parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Product parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Product parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Product.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Product.Builder newBuilder()
-
newBuilder
public static Product.Builder newBuilder(Product prototype)
-
toBuilder
public Product.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Product.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Product getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Product> parser()
-
getParserForType
public com.google.protobuf.Parser<Product> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Product getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-