Interface ProductCatalogItemOrBuilder (0.62.0) 

public interface ProductCatalogItemOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCosts(String key)

public abstract boolean containsCosts(String key)

Optional. A map to pass the costs associated with the product.

For example: {"manufacturing": 45.5} The profit of selling this item is computed like so:

  • If 'exactPrice' is provided, profit = displayPrice - sum(costs)
  • If 'priceRange' is provided, profit = minPrice - sum(costs)

map<string, float> costs = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAvailableQuantity()

public abstract long getAvailableQuantity()

Optional. The available quantity of the item.

int64 available_quantity = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The availableQuantity.

getCanonicalProductUri()

public abstract String getCanonicalProductUri()

Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..

string canonical_product_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The canonicalProductUri.

getCanonicalProductUriBytes()

public abstract ByteString getCanonicalProductUriBytes()

Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..

string canonical_product_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for canonicalProductUri.

getCosts() (deprecated)

public abstract Map<String,Float> getCosts()

Use #getCostsMap() instead.

Returns
Type Description
Map<String,Float>

getCostsCount()

public abstract int getCostsCount()

Optional. A map to pass the costs associated with the product.

For example: {"manufacturing": 45.5} The profit of selling this item is computed like so:

  • If 'exactPrice' is provided, profit = displayPrice - sum(costs)
  • If 'priceRange' is provided, profit = minPrice - sum(costs)

map<string, float> costs = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCostsMap()

public abstract Map<String,Float> getCostsMap()

Optional. A map to pass the costs associated with the product.

For example: {"manufacturing": 45.5} The profit of selling this item is computed like so:

  • If 'exactPrice' is provided, profit = displayPrice - sum(costs)
  • If 'priceRange' is provided, profit = minPrice - sum(costs)

map<string, float> costs = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,Float>

getCostsOrDefault(String key, float defaultValue)

public abstract float getCostsOrDefault(String key, float defaultValue)

Optional. A map to pass the costs associated with the product.

For example: {"manufacturing": 45.5} The profit of selling this item is computed like so:

  • If 'exactPrice' is provided, profit = displayPrice - sum(costs)
  • If 'priceRange' is provided, profit = minPrice - sum(costs)

map<string, float> costs = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue float
Returns
Type Description
float

getCostsOrThrow(String key)

public abstract float getCostsOrThrow(String key)

Optional. A map to pass the costs associated with the product.

For example: {"manufacturing": 45.5} The profit of selling this item is computed like so:

  • If 'exactPrice' is provided, profit = displayPrice - sum(costs)
  • If 'priceRange' is provided, profit = minPrice - sum(costs)

map<string, float> costs = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
float

getCurrencyCode()

public abstract String getCurrencyCode()

Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.

string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public abstract ByteString getCurrencyCodeBytes()

Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.

string currency_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getExactPrice()

public abstract ProductCatalogItem.ExactPrice getExactPrice()

Optional. The exact product price.

.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.ExactPrice exact_price = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProductCatalogItem.ExactPrice

The exactPrice.

getExactPriceOrBuilder()

public abstract ProductCatalogItem.ExactPriceOrBuilder getExactPriceOrBuilder()

Optional. The exact product price.

.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.ExactPrice exact_price = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProductCatalogItem.ExactPriceOrBuilder

getImages(int index)

public abstract Image getImages(int index)

Optional. Product images for the catalog item.

repeated .google.cloud.recommendationengine.v1beta1.Image images = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Image

getImagesCount()

public abstract int getImagesCount()

Optional. Product images for the catalog item.

repeated .google.cloud.recommendationengine.v1beta1.Image images = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getImagesList()

public abstract List<Image> getImagesList()

Optional. Product images for the catalog item.

repeated .google.cloud.recommendationengine.v1beta1.Image images = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Image>

getImagesOrBuilder(int index)

public abstract ImageOrBuilder getImagesOrBuilder(int index)

Optional. Product images for the catalog item.

repeated .google.cloud.recommendationengine.v1beta1.Image images = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ImageOrBuilder

getImagesOrBuilderList()

public abstract List<? extends ImageOrBuilder> getImagesOrBuilderList()

Optional. Product images for the catalog item.

repeated .google.cloud.recommendationengine.v1beta1.Image images = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.recommendationengine.v1beta1.ImageOrBuilder>

getPriceCase()

public abstract ProductCatalogItem.PriceCase getPriceCase()
Returns
Type Description
ProductCatalogItem.PriceCase

getPriceRange()

public abstract ProductCatalogItem.PriceRange getPriceRange()

Optional. The product price range.

.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.PriceRange price_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProductCatalogItem.PriceRange

The priceRange.

getPriceRangeOrBuilder()

public abstract ProductCatalogItem.PriceRangeOrBuilder getPriceRangeOrBuilder()

Optional. The product price range.

.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.PriceRange price_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProductCatalogItem.PriceRangeOrBuilder

getStockState()

public abstract ProductCatalogItem.StockState getStockState()

Optional. Online stock state of the catalog item. Default is IN_STOCK.

.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProductCatalogItem.StockState

The stockState.

getStockStateValue()

public abstract int getStockStateValue()

Optional. Online stock state of the catalog item. Default is IN_STOCK.

.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for stockState.

hasExactPrice()

public abstract boolean hasExactPrice()

Optional. The exact product price.

.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.ExactPrice exact_price = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the exactPrice field is set.

hasPriceRange()

public abstract boolean hasPriceRange()

Optional. The product price range.

.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.PriceRange price_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the priceRange field is set.