Class Branch.ProductCountStatistic.Builder (2.56.0)

public static final class Branch.ProductCountStatistic.Builder extends GeneratedMessageV3.Builder<Branch.ProductCountStatistic.Builder> implements Branch.ProductCountStatisticOrBuilder

A statistic about the number of products in a branch.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Branch.ProductCountStatistic.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

build()

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

buildPartial()

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

clear()

public Branch.ProductCountStatistic.Builder clear()
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

clearCounts()

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

clearField(Descriptors.FieldDescriptor field)

public Branch.ProductCountStatistic.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Branch.ProductCountStatistic.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

clearScope()

public Branch.ProductCountStatistic.Builder clearScope()

[ProductCountScope] of the [counts].

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

Returns
Type Description
Branch.ProductCountStatistic.Builder

This builder for chaining.

clone()

public Branch.ProductCountStatistic.Builder clone()
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableCounts() (deprecated)

public Map<String,Long> getMutableCounts()

Use alternate mutation accessors instead.

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

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Branch.ProductCountStatistic other)

public Branch.ProductCountStatistic.Builder mergeFrom(Branch.ProductCountStatistic other)
Parameter
Name Description
other Branch.ProductCountStatistic
Returns
Type Description
Branch.ProductCountStatistic.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Branch.ProductCountStatistic.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Branch.ProductCountStatistic.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Branch.ProductCountStatistic.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

putAllCounts(Map<String,Long> values)

public Branch.ProductCountStatistic.Builder putAllCounts(Map<String,Long> values)

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
values Map<String,java.lang.Long>
Returns
Type Description
Branch.ProductCountStatistic.Builder

putCounts(String key, long value)

public Branch.ProductCountStatistic.Builder putCounts(String key, long value)

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
value long
Returns
Type Description
Branch.ProductCountStatistic.Builder

removeCounts(String key)

public Branch.ProductCountStatistic.Builder removeCounts(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
Branch.ProductCountStatistic.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Branch.ProductCountStatistic.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Branch.ProductCountStatistic.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides

setScope(Branch.ProductCountStatistic.ProductCountScope value)

public Branch.ProductCountStatistic.Builder setScope(Branch.ProductCountStatistic.ProductCountScope value)

[ProductCountScope] of the [counts].

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

Parameter
Name Description
value Branch.ProductCountStatistic.ProductCountScope

The scope to set.

Returns
Type Description
Branch.ProductCountStatistic.Builder

This builder for chaining.

setScopeValue(int value)

public Branch.ProductCountStatistic.Builder setScopeValue(int value)

[ProductCountScope] of the [counts].

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

Parameter
Name Description
value int

The enum numeric value on the wire for scope to set.

Returns
Type Description
Branch.ProductCountStatistic.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Branch.ProductCountStatistic.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Branch.ProductCountStatistic.Builder
Overrides