Package com.google.cloud.retail.v2beta
Class Product
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.retail.v2beta.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.v2beta.Product- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classProduct.AvailabilityProduct availability.static classProduct.BuilderProduct captures all metadata information of items to be recommended or searched.static classProduct.ExpirationCasestatic classProduct.TypeThe 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 booleancontainsAttributes(String key)Highly encouraged.booleanequals(Object obj)Map<String,CustomAttribute>getAttributes()Deprecated.intgetAttributesCount()Highly encouraged.Map<String,CustomAttribute>getAttributesMap()Highly encouraged.CustomAttributegetAttributesOrDefault(String key, CustomAttribute defaultValue)Highly encouraged.CustomAttributegetAttributesOrThrow(String key)Highly encouraged.AudiencegetAudience()The target group associated with a given audience (e.g.AudienceOrBuildergetAudienceOrBuilder()The target group associated with a given audience (e.g.Product.AvailabilitygetAvailability()The online availability of the [Product][google.cloud.retail.v2beta.Product].intgetAvailabilityValue()The online availability of the [Product][google.cloud.retail.v2beta.Product].com.google.protobuf.Int32ValuegetAvailableQuantity()The available quantity of the item.com.google.protobuf.Int32ValueOrBuildergetAvailableQuantityOrBuilder()The available quantity of the item.com.google.protobuf.TimestampgetAvailableTime()The timestamp when this [Product][google.cloud.retail.v2beta.Product] becomes available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].com.google.protobuf.TimestampOrBuildergetAvailableTimeOrBuilder()The timestamp when this [Product][google.cloud.retail.v2beta.Product] becomes available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].StringgetBrands(int index)The brands of the product.com.google.protobuf.ByteStringgetBrandsBytes(int index)The brands of the product.intgetBrandsCount()The brands of the product.com.google.protobuf.ProtocolStringListgetBrandsList()The brands of the product.StringgetCategories(int index)Product categories.com.google.protobuf.ByteStringgetCategoriesBytes(int index)Product categories.intgetCategoriesCount()Product categories.com.google.protobuf.ProtocolStringListgetCategoriesList()Product categories.StringgetCollectionMemberIds(int index)The [id][google.cloud.retail.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION].com.google.protobuf.ByteStringgetCollectionMemberIdsBytes(int index)The [id][google.cloud.retail.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION].intgetCollectionMemberIdsCount()The [id][google.cloud.retail.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION].com.google.protobuf.ProtocolStringListgetCollectionMemberIdsList()The [id][google.cloud.retail.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION].ColorInfogetColorInfo()The color of the product.ColorInfoOrBuildergetColorInfoOrBuilder()The color of the product.StringgetConditions(int index)The condition of the product.com.google.protobuf.ByteStringgetConditionsBytes(int index)The condition of the product.intgetConditionsCount()The condition of the product.com.google.protobuf.ProtocolStringListgetConditionsList()The condition of the product.static ProductgetDefaultInstance()ProductgetDefaultInstanceForType()StringgetDescription()Product description.com.google.protobuf.ByteStringgetDescriptionBytes()Product description.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()Product.ExpirationCasegetExpirationCase()com.google.protobuf.TimestampgetExpireTime()The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].com.google.protobuf.TimestampOrBuildergetExpireTimeOrBuilder()The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].FulfillmentInfogetFulfillmentInfo(int index)Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.intgetFulfillmentInfoCount()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.FulfillmentInfoOrBuildergetFulfillmentInfoOrBuilder(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.StringgetGtin()The Global Trade Item Number (GTIN) of the product.com.google.protobuf.ByteStringgetGtinBytes()The Global Trade Item Number (GTIN) of the product.StringgetId()Immutable.com.google.protobuf.ByteStringgetIdBytes()Immutable.ImagegetImages(int index)Product images for the product.intgetImagesCount()Product images for the product.List<Image>getImagesList()Product images for the product.ImageOrBuildergetImagesOrBuilder(int index)Product images for the product.List<? extends ImageOrBuilder>getImagesOrBuilderList()Product images for the product.StringgetLanguageCode()Language of the title/description and other string attributes.com.google.protobuf.ByteStringgetLanguageCodeBytes()Language of the title/description and other string attributes.LocalInventorygetLocalInventories(int index)Output only.intgetLocalInventoriesCount()Output only.List<LocalInventory>getLocalInventoriesList()Output only.LocalInventoryOrBuildergetLocalInventoriesOrBuilder(int index)Output only.List<? extends LocalInventoryOrBuilder>getLocalInventoriesOrBuilderList()Output only.StringgetMaterials(int index)The material of the product.com.google.protobuf.ByteStringgetMaterialsBytes(int index)The material of the product.intgetMaterialsCount()The material of the product.com.google.protobuf.ProtocolStringListgetMaterialsList()The material of the product.StringgetName()Immutable.com.google.protobuf.ByteStringgetNameBytes()Immutable.com.google.protobuf.Parser<Product>getParserForType()StringgetPatterns(int index)The pattern or graphic print of the product.com.google.protobuf.ByteStringgetPatternsBytes(int index)The pattern or graphic print of the product.intgetPatternsCount()The pattern or graphic print of the product.com.google.protobuf.ProtocolStringListgetPatternsList()The pattern or graphic print of the product.PriceInfogetPriceInfo()Product price and cost information.PriceInfoOrBuildergetPriceInfoOrBuilder()Product price and cost information.StringgetPrimaryProductId()Variant group identifier.com.google.protobuf.ByteStringgetPrimaryProductIdBytes()Variant group identifier.PromotiongetPromotions(int index)The promotions applied to the product.intgetPromotionsCount()The promotions applied to the product.List<Promotion>getPromotionsList()The promotions applied to the product.PromotionOrBuildergetPromotionsOrBuilder(int index)The promotions applied to the product.List<? extends PromotionOrBuilder>getPromotionsOrBuilderList()The promotions applied to the product.com.google.protobuf.TimestampgetPublishTime()The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products.com.google.protobuf.TimestampOrBuildergetPublishTimeOrBuilder()The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products.RatinggetRating()The rating of this product.RatingOrBuildergetRatingOrBuilder()The rating of this product.com.google.protobuf.FieldMaskgetRetrievableFields()Deprecated.google.cloud.retail.v2beta.Product.retrievable_fields is deprecated.com.google.protobuf.FieldMaskOrBuildergetRetrievableFieldsOrBuilder()Deprecated.intgetSerializedSize()StringgetSizes(int index)The size of the product.com.google.protobuf.ByteStringgetSizesBytes(int index)The size of the product.intgetSizesCount()The size of the product.com.google.protobuf.ProtocolStringListgetSizesList()The size of the product.StringgetTags(int index)Custom tags associated with the product.com.google.protobuf.ByteStringgetTagsBytes(int index)Custom tags associated with the product.intgetTagsCount()Custom tags associated with the product.com.google.protobuf.ProtocolStringListgetTagsList()Custom tags associated with the product.StringgetTitle()Required.com.google.protobuf.ByteStringgetTitleBytes()Required.com.google.protobuf.DurationgetTtl()Input only.com.google.protobuf.DurationOrBuildergetTtlOrBuilder()Input only.Product.TypegetType()Immutable.intgetTypeValue()Immutable.StringgetUri()Canonical URL directly linking to the product detail page.com.google.protobuf.ByteStringgetUriBytes()Canonical URL directly linking to the product detail page.ProductgetVariants(int index)Output only.intgetVariantsCount()Output only.List<Product>getVariantsList()Output only.ProductOrBuildergetVariantsOrBuilder(int index)Output only.List<? extends ProductOrBuilder>getVariantsOrBuilderList()Output only.booleanhasAudience()The target group associated with a given audience (e.g.booleanhasAvailableQuantity()The available quantity of the item.booleanhasAvailableTime()The timestamp when this [Product][google.cloud.retail.v2beta.Product] becomes available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].booleanhasColorInfo()The color of the product.booleanhasExpireTime()The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].inthashCode()booleanhasPriceInfo()Product price and cost information.booleanhasPublishTime()The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products.booleanhasRating()The rating of this product.booleanhasRetrievableFields()Deprecated.google.cloud.retail.v2beta.Product.retrievable_fields is deprecated.booleanhasTtl()Input only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static Product.BuildernewBuilder()static Product.BuildernewBuilder(Product prototype)Product.BuildernewBuilderForType()protected Product.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static ProductparseDelimitedFrom(InputStream input)static ProductparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ProductparseFrom(byte[] data)static ProductparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ProductparseFrom(com.google.protobuf.ByteString data)static ProductparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ProductparseFrom(com.google.protobuf.CodedInputStream input)static ProductparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ProductparseFrom(InputStream input)static ProductparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ProductparseFrom(ByteBuffer data)static ProductparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Product>parser()Product.BuildertoBuilder()voidwriteTo(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:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getExpirationCase
public Product.ExpirationCase getExpirationCase()
- Specified by:
getExpirationCasein interfaceProductOrBuilder
-
hasExpireTime
public boolean hasExpireTime()
The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.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.v2beta.Product] is not available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] after [expire_time][google.cloud.retail.v2beta.Product.expire_time]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts]. [expire_time][google.cloud.retail.v2beta.Product.expire_time] must be later than [available_time][google.cloud.retail.v2beta.Product.available_time] and [publish_time][google.cloud.retail.v2beta.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:
hasExpireTimein 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.v2beta.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.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.v2beta.Product] is not available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] after [expire_time][google.cloud.retail.v2beta.Product.expire_time]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts]. [expire_time][google.cloud.retail.v2beta.Product.expire_time] must be later than [available_time][google.cloud.retail.v2beta.Product.available_time] and [publish_time][google.cloud.retail.v2beta.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:
getExpireTimein interfaceProductOrBuilder- Returns:
- The expireTime.
-
getExpireTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
The timestamp when this product becomes unavailable for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.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.v2beta.Product] is not available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] after [expire_time][google.cloud.retail.v2beta.Product.expire_time]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts]. [expire_time][google.cloud.retail.v2beta.Product.expire_time] must be later than [available_time][google.cloud.retail.v2beta.Product.available_time] and [publish_time][google.cloud.retail.v2beta.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:
getExpireTimeOrBuilderin 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.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.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.v2beta.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. The derived [expire_time][google.cloud.retail.v2beta.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2beta.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2beta.Product]. If it is set, the product is not available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] after current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
.google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
hasTtlin 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.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.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.v2beta.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. The derived [expire_time][google.cloud.retail.v2beta.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2beta.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2beta.Product]. If it is set, the product is not available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] after current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
.google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
getTtlin 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.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.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.v2beta.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. The derived [expire_time][google.cloud.retail.v2beta.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2beta.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2beta.Product]. If it is set, the product is not available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] after current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
.google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
getTtlOrBuilderin 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:
getNamein 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:
getNameBytesin interfaceProductOrBuilder- Returns:
- The bytes for name.
-
getId
public String getId()
Immutable. [Product][google.cloud.retail.v2beta.Product] identifier, which is the final component of [name][google.cloud.retail.v2beta.Product.name]. For example, this field is "id_1", if [name][google.cloud.retail.v2beta.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:
getIdin interfaceProductOrBuilder- Returns:
- The id.
-
getIdBytes
public com.google.protobuf.ByteString getIdBytes()
Immutable. [Product][google.cloud.retail.v2beta.Product] identifier, which is the final component of [name][google.cloud.retail.v2beta.Product.name]. For example, this field is "id_1", if [name][google.cloud.retail.v2beta.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:
getIdBytesin 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.v2beta.ProductLevelConfig.ingestion_product_type] if unset.
.google.cloud.retail.v2beta.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getTypeValuein 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.v2beta.ProductLevelConfig.ingestion_product_type] if unset.
.google.cloud.retail.v2beta.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getTypein interfaceProductOrBuilder- Returns:
- The type.
-
getPrimaryProductId
public String getPrimaryProductId()
Variant group identifier. Must be an [id][google.cloud.retail.v2beta.Product.id], with the same parent branch with this product. Otherwise, an error is thrown. For [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s, this field can only be empty or set to the same value as [id][google.cloud.retail.v2beta.Product.id]. For VARIANT [Product][google.cloud.retail.v2beta.Product]s, this field cannot be empty. A maximum of 2,000 products are allowed to share the same [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.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:
getPrimaryProductIdin interfaceProductOrBuilder- Returns:
- The primaryProductId.
-
getPrimaryProductIdBytes
public com.google.protobuf.ByteString getPrimaryProductIdBytes()
Variant group identifier. Must be an [id][google.cloud.retail.v2beta.Product.id], with the same parent branch with this product. Otherwise, an error is thrown. For [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s, this field can only be empty or set to the same value as [id][google.cloud.retail.v2beta.Product.id]. For VARIANT [Product][google.cloud.retail.v2beta.Product]s, this field cannot be empty. A maximum of 2,000 products are allowed to share the same [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.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:
getPrimaryProductIdBytesin interfaceProductOrBuilder- Returns:
- The bytes for primaryProductId.
-
getCollectionMemberIdsList
public com.google.protobuf.ProtocolStringList getCollectionMemberIdsList()
The [id][google.cloud.retail.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]. Non-existent product ids are allowed. The [type][google.cloud.retail.v2beta.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2beta.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:
getCollectionMemberIdsListin interfaceProductOrBuilder- Returns:
- A list containing the collectionMemberIds.
-
getCollectionMemberIdsCount
public int getCollectionMemberIdsCount()
The [id][google.cloud.retail.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]. Non-existent product ids are allowed. The [type][google.cloud.retail.v2beta.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2beta.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:
getCollectionMemberIdsCountin interfaceProductOrBuilder- Returns:
- The count of collectionMemberIds.
-
getCollectionMemberIds
public String getCollectionMemberIds(int index)
The [id][google.cloud.retail.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]. Non-existent product ids are allowed. The [type][google.cloud.retail.v2beta.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2beta.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:
getCollectionMemberIdsin 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.v2beta.Product.id] of the collection members when [type][google.cloud.retail.v2beta.Product.type] is [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]. Non-existent product ids are allowed. The [type][google.cloud.retail.v2beta.Product.type] of the members must be either [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] or [Type.VARIANT][google.cloud.retail.v2beta.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:
getCollectionMemberIdsBytesin 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:
getGtinin 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:
getGtinBytesin 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.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per [Product][google.cloud.retail.v2beta.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/6324436repeated string categories = 7;- Specified by:
getCategoriesListin 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.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per [Product][google.cloud.retail.v2beta.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/6324436repeated string categories = 7;- Specified by:
getCategoriesCountin 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.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per [Product][google.cloud.retail.v2beta.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/6324436repeated string categories = 7;- Specified by:
getCategoriesin 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.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per [Product][google.cloud.retail.v2beta.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/6324436repeated string categories = 7;- Specified by:
getCategoriesBytesin 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:
getTitlein 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:
getTitleBytesin 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:
getBrandsListin 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:
getBrandsCountin 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:
getBrandsin 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:
getBrandsBytesin 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:
getDescriptionin 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:
getDescriptionBytesin 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.v2beta.Product] can include text in different languages, but duplicating [Product][google.cloud.retail.v2beta.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:
getLanguageCodein 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.v2beta.Product] can include text in different languages, but duplicating [Product][google.cloud.retail.v2beta.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:
getLanguageCodeBytesin interfaceProductOrBuilder- Returns:
- The bytes for languageCode.
-
getAttributesCount
public int getAttributesCount()
Description copied from interface:ProductOrBuilderHighly 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.v2beta.CustomAttribute> attributes = 12;- Specified by:
getAttributesCountin 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.v2beta.CustomAttribute> attributes = 12;- Specified by:
containsAttributesin interfaceProductOrBuilder
-
getAttributes
@Deprecated public Map<String,CustomAttribute> getAttributes()
Deprecated.UsegetAttributesMap()instead.- Specified by:
getAttributesin 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.v2beta.CustomAttribute> attributes = 12;- Specified by:
getAttributesMapin 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.v2beta.CustomAttribute> attributes = 12;- Specified by:
getAttributesOrDefaultin 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.v2beta.CustomAttribute> attributes = 12;- Specified by:
getAttributesOrThrowin 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.v2beta.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.v2beta.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:
getTagsListin 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.v2beta.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.v2beta.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:
getTagsCountin 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.v2beta.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.v2beta.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:
getTagsin 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.v2beta.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.v2beta.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:
getTagsBytesin 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.v2beta.PriceInfo price_info = 14;- Specified by:
hasPriceInfoin 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.v2beta.PriceInfo price_info = 14;- Specified by:
getPriceInfoin 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.v2beta.PriceInfo price_info = 14;- Specified by:
getPriceInfoOrBuilderin interfaceProductOrBuilder
-
hasRating
public boolean hasRating()
The rating of this product.
.google.cloud.retail.v2beta.Rating rating = 15;- Specified by:
hasRatingin interfaceProductOrBuilder- Returns:
- Whether the rating field is set.
-
getRating
public Rating getRating()
The rating of this product.
.google.cloud.retail.v2beta.Rating rating = 15;- Specified by:
getRatingin interfaceProductOrBuilder- Returns:
- The rating.
-
getRatingOrBuilder
public RatingOrBuilder getRatingOrBuilder()
The rating of this product.
.google.cloud.retail.v2beta.Rating rating = 15;- Specified by:
getRatingOrBuilderin interfaceProductOrBuilder
-
hasAvailableTime
public boolean hasAvailableTime()
The timestamp when this [Product][google.cloud.retail.v2beta.Product] becomes available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT].
.google.protobuf.Timestamp available_time = 18;- Specified by:
hasAvailableTimein interfaceProductOrBuilder- Returns:
- Whether the availableTime field is set.
-
getAvailableTime
public com.google.protobuf.Timestamp getAvailableTime()
The timestamp when this [Product][google.cloud.retail.v2beta.Product] becomes available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT].
.google.protobuf.Timestamp available_time = 18;- Specified by:
getAvailableTimein interfaceProductOrBuilder- Returns:
- The availableTime.
-
getAvailableTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getAvailableTimeOrBuilder()
The timestamp when this [Product][google.cloud.retail.v2beta.Product] becomes available for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT].
.google.protobuf.Timestamp available_time = 18;- Specified by:
getAvailableTimeOrBuilderin interfaceProductOrBuilder
-
getAvailabilityValue
public int getAvailabilityValue()
The online availability of the [Product][google.cloud.retail.v2beta.Product]. Default to [Availability.IN_STOCK][google.cloud.retail.v2beta.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.v2beta.Product.Availability availability = 19;- Specified by:
getAvailabilityValuein 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.v2beta.Product]. Default to [Availability.IN_STOCK][google.cloud.retail.v2beta.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.v2beta.Product.Availability availability = 19;- Specified by:
getAvailabilityin interfaceProductOrBuilder- Returns:
- The availability.
-
hasAvailableQuantity
public boolean hasAvailableQuantity()
The available quantity of the item.
.google.protobuf.Int32Value available_quantity = 20;- Specified by:
hasAvailableQuantityin 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:
getAvailableQuantityin 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:
getAvailableQuantityOrBuilderin 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.v2beta.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.FulfillmentInfo fulfillment_info = 21;- Specified by:
getFulfillmentInfoListin 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.v2beta.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.FulfillmentInfo fulfillment_info = 21;- Specified by:
getFulfillmentInfoOrBuilderListin 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.v2beta.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.FulfillmentInfo fulfillment_info = 21;- Specified by:
getFulfillmentInfoCountin 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.v2beta.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.FulfillmentInfo fulfillment_info = 21;- Specified by:
getFulfillmentInfoin 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.v2beta.FulfillmentInfo.type]. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.FulfillmentInfo fulfillment_info = 21;- Specified by:
getFulfillmentInfoOrBuilderin 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:
getUriin 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:
getUriBytesin 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.v2beta.Image images = 23;- Specified by:
getImagesListin 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.v2beta.Image images = 23;- Specified by:
getImagesOrBuilderListin 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.v2beta.Image images = 23;- Specified by:
getImagesCountin 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.v2beta.Image images = 23;- Specified by:
getImagesin 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.v2beta.Image images = 23;- Specified by:
getImagesOrBuilderin 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.v2beta.Audience audience = 24;- Specified by:
hasAudiencein 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.v2beta.Audience audience = 24;- Specified by:
getAudiencein 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.v2beta.Audience audience = 24;- Specified by:
getAudienceOrBuilderin 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.v2beta.ColorInfo color_info = 25;- Specified by:
hasColorInfoin 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.v2beta.ColorInfo color_info = 25;- Specified by:
getColorInfoin 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.v2beta.ColorInfo color_info = 25;- Specified by:
getColorInfoOrBuilderin 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.v2beta.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:
getSizesListin 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.v2beta.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:
getSizesCountin 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.v2beta.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:
getSizesin 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.v2beta.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:
getSizesBytesin 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:
getMaterialsListin 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:
getMaterialsCountin 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:
getMaterialsin 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:
getMaterialsBytesin 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.v2beta.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:
getPatternsListin 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.v2beta.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:
getPatternsCountin 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.v2beta.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:
getPatternsin 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.v2beta.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:
getPatternsBytesin 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.v2beta.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:
getConditionsListin 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.v2beta.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:
getConditionsCountin 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.v2beta.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:
getConditionsin 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.v2beta.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:
getConditionsBytesin 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.v2beta.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2beta.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2beta.Promotion promotions = 34;- Specified by:
getPromotionsListin 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.v2beta.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2beta.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2beta.Promotion promotions = 34;- Specified by:
getPromotionsOrBuilderListin interfaceProductOrBuilder
-
getPromotionsCount
public int getPromotionsCount()
The promotions applied to the product. A maximum of 10 values are allowed per [Product][google.cloud.retail.v2beta.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2beta.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2beta.Promotion promotions = 34;- Specified by:
getPromotionsCountin 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.v2beta.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2beta.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2beta.Promotion promotions = 34;- Specified by:
getPromotionsin 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.v2beta.Product]. Only [Promotion.promotion_id][google.cloud.retail.v2beta.Promotion.promotion_id] will be used, other fields will be ignored if set.
repeated .google.cloud.retail.v2beta.Promotion promotions = 34;- Specified by:
getPromotionsOrBuilderin 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.v2beta.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:
hasPublishTimein 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.v2beta.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:
getPublishTimein 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.v2beta.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:
getPublishTimeOrBuilderin interfaceProductOrBuilder
-
hasRetrievableFields
@Deprecated public boolean hasRetrievableFields()
Deprecated.google.cloud.retail.v2beta.Product.retrievable_fields is deprecated. See google/cloud/retail/v2beta/product.proto;l=573Indicates which fields in the [Product][google.cloud.retail.v2beta.Product]s are returned in [SearchResponse][google.cloud.retail.v2beta.SearchResponse]. Supported fields for all [type][google.cloud.retail.v2beta.Product.type]s: * [audience][google.cloud.retail.v2beta.Product.audience] * [availability][google.cloud.retail.v2beta.Product.availability] * [brands][google.cloud.retail.v2beta.Product.brands] * [color_info][google.cloud.retail.v2beta.Product.color_info] * [conditions][google.cloud.retail.v2beta.Product.conditions] * [gtin][google.cloud.retail.v2beta.Product.gtin] * [materials][google.cloud.retail.v2beta.Product.materials] * [name][google.cloud.retail.v2beta.Product.name] * [patterns][google.cloud.retail.v2beta.Product.patterns] * [price_info][google.cloud.retail.v2beta.Product.price_info] * [rating][google.cloud.retail.v2beta.Product.rating] * [sizes][google.cloud.retail.v2beta.Product.sizes] * [title][google.cloud.retail.v2beta.Product.title] * [uri][google.cloud.retail.v2beta.Product.uri] Supported fields only for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]: * [categories][google.cloud.retail.v2beta.Product.categories] * [description][google.cloud.retail.v2beta.Product.description] * [images][google.cloud.retail.v2beta.Product.images] Supported fields only for [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]: * Only the first image in [images][google.cloud.retail.v2beta.Product.images] To mark [attributes][google.cloud.retail.v2beta.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.v2beta.Product.attributes]. For [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], the following fields are always returned in [SearchResponse][google.cloud.retail.v2beta.SearchResponse] by default: * [name][google.cloud.retail.v2beta.Product.name] For [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT], the following fields are always returned in by default: * [name][google.cloud.retail.v2beta.Product.name] * [color_info][google.cloud.retail.v2beta.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.v2beta.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:
hasRetrievableFieldsin interfaceProductOrBuilder- Returns:
- Whether the retrievableFields field is set.
-
getRetrievableFields
@Deprecated public com.google.protobuf.FieldMask getRetrievableFields()
Deprecated.google.cloud.retail.v2beta.Product.retrievable_fields is deprecated. See google/cloud/retail/v2beta/product.proto;l=573Indicates which fields in the [Product][google.cloud.retail.v2beta.Product]s are returned in [SearchResponse][google.cloud.retail.v2beta.SearchResponse]. Supported fields for all [type][google.cloud.retail.v2beta.Product.type]s: * [audience][google.cloud.retail.v2beta.Product.audience] * [availability][google.cloud.retail.v2beta.Product.availability] * [brands][google.cloud.retail.v2beta.Product.brands] * [color_info][google.cloud.retail.v2beta.Product.color_info] * [conditions][google.cloud.retail.v2beta.Product.conditions] * [gtin][google.cloud.retail.v2beta.Product.gtin] * [materials][google.cloud.retail.v2beta.Product.materials] * [name][google.cloud.retail.v2beta.Product.name] * [patterns][google.cloud.retail.v2beta.Product.patterns] * [price_info][google.cloud.retail.v2beta.Product.price_info] * [rating][google.cloud.retail.v2beta.Product.rating] * [sizes][google.cloud.retail.v2beta.Product.sizes] * [title][google.cloud.retail.v2beta.Product.title] * [uri][google.cloud.retail.v2beta.Product.uri] Supported fields only for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]: * [categories][google.cloud.retail.v2beta.Product.categories] * [description][google.cloud.retail.v2beta.Product.description] * [images][google.cloud.retail.v2beta.Product.images] Supported fields only for [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]: * Only the first image in [images][google.cloud.retail.v2beta.Product.images] To mark [attributes][google.cloud.retail.v2beta.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.v2beta.Product.attributes]. For [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], the following fields are always returned in [SearchResponse][google.cloud.retail.v2beta.SearchResponse] by default: * [name][google.cloud.retail.v2beta.Product.name] For [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT], the following fields are always returned in by default: * [name][google.cloud.retail.v2beta.Product.name] * [color_info][google.cloud.retail.v2beta.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.v2beta.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:
getRetrievableFieldsin interfaceProductOrBuilder- Returns:
- The retrievableFields.
-
getRetrievableFieldsOrBuilder
@Deprecated public com.google.protobuf.FieldMaskOrBuilder getRetrievableFieldsOrBuilder()
Deprecated.Indicates which fields in the [Product][google.cloud.retail.v2beta.Product]s are returned in [SearchResponse][google.cloud.retail.v2beta.SearchResponse]. Supported fields for all [type][google.cloud.retail.v2beta.Product.type]s: * [audience][google.cloud.retail.v2beta.Product.audience] * [availability][google.cloud.retail.v2beta.Product.availability] * [brands][google.cloud.retail.v2beta.Product.brands] * [color_info][google.cloud.retail.v2beta.Product.color_info] * [conditions][google.cloud.retail.v2beta.Product.conditions] * [gtin][google.cloud.retail.v2beta.Product.gtin] * [materials][google.cloud.retail.v2beta.Product.materials] * [name][google.cloud.retail.v2beta.Product.name] * [patterns][google.cloud.retail.v2beta.Product.patterns] * [price_info][google.cloud.retail.v2beta.Product.price_info] * [rating][google.cloud.retail.v2beta.Product.rating] * [sizes][google.cloud.retail.v2beta.Product.sizes] * [title][google.cloud.retail.v2beta.Product.title] * [uri][google.cloud.retail.v2beta.Product.uri] Supported fields only for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]: * [categories][google.cloud.retail.v2beta.Product.categories] * [description][google.cloud.retail.v2beta.Product.description] * [images][google.cloud.retail.v2beta.Product.images] Supported fields only for [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]: * Only the first image in [images][google.cloud.retail.v2beta.Product.images] To mark [attributes][google.cloud.retail.v2beta.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.v2beta.Product.attributes]. For [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION], the following fields are always returned in [SearchResponse][google.cloud.retail.v2beta.SearchResponse] by default: * [name][google.cloud.retail.v2beta.Product.name] For [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT], the following fields are always returned in by default: * [name][google.cloud.retail.v2beta.Product.name] * [color_info][google.cloud.retail.v2beta.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.v2beta.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:
getRetrievableFieldsOrBuilderin 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.v2beta.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2beta.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getVariantsListin 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.v2beta.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2beta.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getVariantsOrBuilderListin 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.v2beta.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2beta.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getVariantsCountin 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.v2beta.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2beta.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getVariantsin 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.v2beta.Product.primary_product_id] for all the product variants. Only populated for [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product]s. Note: This field is OUTPUT_ONLY for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]. Do not set this field in API requests.
repeated .google.cloud.retail.v2beta.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getVariantsOrBuilderin 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.v2beta.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2beta.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getLocalInventoriesListin 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.v2beta.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2beta.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getLocalInventoriesOrBuilderListin 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.v2beta.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2beta.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getLocalInventoriesCountin 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.v2beta.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2beta.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getLocalInventoriesin 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.v2beta.ProductService.AddLocalInventories] and [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] APIs if fine-grained, high-volume updates are necessary.
repeated .google.cloud.retail.v2beta.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getLocalInventoriesOrBuilderin interfaceProductOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein 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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein 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:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Product.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein 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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Product getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-