Class Branch.ProductCountStatistic (2.56.0)

public static final class Branch.ProductCountStatistic extends GeneratedMessageV3 implements Branch.ProductCountStatisticOrBuilder

A statistic about the number of products in a branch.

Protobuf type google.cloud.retail.v2alpha.Branch.ProductCountStatistic

Static Fields

COUNTS_FIELD_NUMBER

public static final int COUNTS_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Branch.ProductCountStatistic getDefaultInstance()
Returns
Type Description
Branch.ProductCountStatistic

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Branch.ProductCountStatistic.Builder newBuilder()
Returns
Type Description
Branch.ProductCountStatistic.Builder

newBuilder(Branch.ProductCountStatistic prototype)

public static Branch.ProductCountStatistic.Builder newBuilder(Branch.ProductCountStatistic prototype)
Parameter
Name Description
prototype Branch.ProductCountStatistic
Returns
Type Description
Branch.ProductCountStatistic.Builder

parseDelimitedFrom(InputStream input)

public static Branch.ProductCountStatistic parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Branch.ProductCountStatistic parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Branch.ProductCountStatistic parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Branch.ProductCountStatistic parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Branch.ProductCountStatistic parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Branch.ProductCountStatistic parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Branch.ProductCountStatistic parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Branch.ProductCountStatistic parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Branch.ProductCountStatistic parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Branch.ProductCountStatistic parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Branch.ProductCountStatistic parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Branch.ProductCountStatistic parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Branch.ProductCountStatistic
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Branch.ProductCountStatistic> parser()
Returns
Type Description
Parser<ProductCountStatistic>

Methods

containsCounts(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCounts() (deprecated)

public Map<String,Long> getCounts()

Use #getCountsMap() instead.

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

getCountsCount()

public 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 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 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 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

getDefaultInstanceForType()

public Branch.ProductCountStatistic getDefaultInstanceForType()
Returns
Type Description
Branch.ProductCountStatistic

getParserForType()

public Parser<Branch.ProductCountStatistic> getParserForType()
Returns
Type Description
Parser<ProductCountStatistic>
Overrides

getScope()

public 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 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Branch.ProductCountStatistic.Builder newBuilderForType()
Returns
Type Description
Branch.ProductCountStatistic.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Branch.ProductCountStatistic.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Branch.ProductCountStatistic.Builder toBuilder()
Returns
Type Description
Branch.ProductCountStatistic.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException