Interface Branch.ProductCountStatisticOrBuilder (2.78.0) 

public static interface Branch.ProductCountStatisticOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCounts(String key)

public abstract boolean containsCounts(String key)

The number of products in scope broken down into different groups.

The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time.

Possible keys:

  • "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability.

  • "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability.

  • "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability.

  • "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability.

  • "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability.

  • "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability.

  • "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability.

  • "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability.

  • "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price].

map<string, int64> counts = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCounts() (deprecated)

public abstract Map<String,Long> getCounts()

Use #getCountsMap() instead.

Returns
Type Description
Map<String,java.lang.Long>

getCountsCount()

public abstract int getCountsCount()

The number of products in scope broken down into different groups.

The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time.

Possible keys:

  • "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability.

  • "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability.

  • "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability.

  • "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability.

  • "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability.

  • "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability.

  • "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability.

  • "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability.

  • "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price].

map<string, int64> counts = 2;

Returns
Type Description
int

getCountsMap()

public abstract Map<String,Long> getCountsMap()

The number of products in scope broken down into different groups.

The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time.

Possible keys:

  • "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability.

  • "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability.

  • "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability.

  • "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability.

  • "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability.

  • "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability.

  • "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability.

  • "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability.

  • "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price].

map<string, int64> counts = 2;

Returns
Type Description
Map<String,java.lang.Long>

getCountsOrDefault(String key, long defaultValue)

public abstract long getCountsOrDefault(String key, long defaultValue)

The number of products in scope broken down into different groups.

The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time.

Possible keys:

  • "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability.

  • "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability.

  • "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability.

  • "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability.

  • "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability.

  • "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability.

  • "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability.

  • "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability.

  • "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price].

map<string, int64> counts = 2;

Parameters
Name Description
key String
defaultValue long
Returns
Type Description
long

getCountsOrThrow(String key)

public abstract long getCountsOrThrow(String key)

The number of products in scope broken down into different groups.

The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time.

Possible keys:

  • "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability.

  • "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability.

  • "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability.

  • "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability.

  • "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability.

  • "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability.

  • "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability.

  • "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability.

  • "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price].

map<string, int64> counts = 2;

Parameter
Name Description
key String
Returns
Type Description
long

getScope()

public abstract Branch.ProductCountStatistic.ProductCountScope getScope()

[ProductCountScope] of the [counts].

.google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope scope = 1;

Returns
Type Description
Branch.ProductCountStatistic.ProductCountScope

The scope.

getScopeValue()

public abstract int getScopeValue()

[ProductCountScope] of the [counts].

.google.cloud.retail.v2alpha.Branch.ProductCountStatistic.ProductCountScope scope = 1;

Returns
Type Description
int

The enum numeric value on the wire for scope.